Class ModelInvocationJobSummary
- java.lang.Object
-
- software.amazon.awssdk.services.bedrock.model.ModelInvocationJobSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ModelInvocationJobSummary.Builder,ModelInvocationJobSummary>
@Generated("software.amazon.awssdk:codegen") public final class ModelInvocationJobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ModelInvocationJobSummary.Builder,ModelInvocationJobSummary>
A summary of a batch inference job.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceModelInvocationJobSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModelInvocationJobSummary.Builderbuilder()StringclientRequestToken()A unique, case-sensitive identifier to ensure that the API request completes no more than one time.InstantendTime()The time at which the batch inference job ended.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()ModelInvocationJobInputDataConfiginputDataConfig()Details about the location of the input to the batch inference job.StringjobArn()The Amazon Resource Name (ARN) of the batch inference job.InstantjobExpirationTime()The time at which the batch inference job times or timed out.StringjobName()The name of the batch inference job.InstantlastModifiedTime()The time at which the batch inference job was last modified.Stringmessage()If the batch inference job failed, this field contains a message describing why the job failed.StringmodelId()The unique identifier of the foundation model used for model inference.ModelInvocationJobOutputDataConfigoutputDataConfig()Details about the location of the output of the batch inference job.StringroleArn()The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ModelInvocationJobSummary.Builder>serializableBuilderClass()ModelInvocationJobStatusstatus()The status of the batch inference job.StringstatusAsString()The status of the batch inference job.InstantsubmitTime()The time at which the batch inference job was submitted.IntegertimeoutDurationInHours()The number of hours after which the batch inference job was set to time out.ModelInvocationJobSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.VpcConfigvpcConfig()The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
jobArn
public final String jobArn()
The Amazon Resource Name (ARN) of the batch inference job.
- Returns:
- The Amazon Resource Name (ARN) of the batch inference job.
-
jobName
public final String jobName()
The name of the batch inference job.
- Returns:
- The name of the batch inference job.
-
modelId
public final String modelId()
The unique identifier of the foundation model used for model inference.
- Returns:
- The unique identifier of the foundation model used for model inference.
-
clientRequestToken
public final String clientRequestToken()
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
- Returns:
- A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.
- Returns:
- The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.
-
status
public final ModelInvocationJobStatus status()
The status of the batch inference job.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnModelInvocationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the batch inference job.
- See Also:
ModelInvocationJobStatus
-
statusAsString
public final String statusAsString()
The status of the batch inference job.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnModelInvocationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the batch inference job.
- See Also:
ModelInvocationJobStatus
-
message
public final String message()
If the batch inference job failed, this field contains a message describing why the job failed.
- Returns:
- If the batch inference job failed, this field contains a message describing why the job failed.
-
submitTime
public final Instant submitTime()
The time at which the batch inference job was submitted.
- Returns:
- The time at which the batch inference job was submitted.
-
lastModifiedTime
public final Instant lastModifiedTime()
The time at which the batch inference job was last modified.
- Returns:
- The time at which the batch inference job was last modified.
-
endTime
public final Instant endTime()
The time at which the batch inference job ended.
- Returns:
- The time at which the batch inference job ended.
-
inputDataConfig
public final ModelInvocationJobInputDataConfig inputDataConfig()
Details about the location of the input to the batch inference job.
- Returns:
- Details about the location of the input to the batch inference job.
-
outputDataConfig
public final ModelInvocationJobOutputDataConfig outputDataConfig()
Details about the location of the output of the batch inference job.
- Returns:
- Details about the location of the output of the batch inference job.
-
vpcConfig
public final VpcConfig vpcConfig()
The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.
- Returns:
- The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.
-
timeoutDurationInHours
public final Integer timeoutDurationInHours()
The number of hours after which the batch inference job was set to time out.
- Returns:
- The number of hours after which the batch inference job was set to time out.
-
jobExpirationTime
public final Instant jobExpirationTime()
The time at which the batch inference job times or timed out.
- Returns:
- The time at which the batch inference job times or timed out.
-
toBuilder
public ModelInvocationJobSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ModelInvocationJobSummary.Builder,ModelInvocationJobSummary>
-
builder
public static ModelInvocationJobSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModelInvocationJobSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-