Interface ListModelInvocationJobsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,BedrockRequest.Builder,Buildable,CopyableBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>,SdkBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListModelInvocationJobsRequest
@Mutable @NotThreadSafe public static interface ListModelInvocationJobsRequest.Builder extends BedrockRequest.Builder, SdkPojo, CopyableBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListModelInvocationJobsRequest.BuildermaxResults(Integer maxResults)The maximum number of results to return.ListModelInvocationJobsRequest.BuildernameContains(String nameContains)Specify a string to filter for batch inference jobs whose names contain the string.ListModelInvocationJobsRequest.BuildernextToken(String nextToken)If there were more results than the value you specified in themaxResultsfield in a previousListModelInvocationJobsrequest, the response would have returned anextTokenvalue.ListModelInvocationJobsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListModelInvocationJobsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)ListModelInvocationJobsRequest.BuildersortBy(String sortBy)An attribute by which to sort the results.ListModelInvocationJobsRequest.BuildersortBy(SortJobsBy sortBy)An attribute by which to sort the results.ListModelInvocationJobsRequest.BuildersortOrder(String sortOrder)Specifies whether to sort the results by ascending or descending order.ListModelInvocationJobsRequest.BuildersortOrder(SortOrder sortOrder)Specifies whether to sort the results by ascending or descending order.ListModelInvocationJobsRequest.BuilderstatusEquals(String statusEquals)Specify a status to filter for batch inference jobs whose statuses match the string you specify.ListModelInvocationJobsRequest.BuilderstatusEquals(ModelInvocationJobStatus statusEquals)Specify a status to filter for batch inference jobs whose statuses match the string you specify.ListModelInvocationJobsRequest.BuildersubmitTimeAfter(Instant submitTimeAfter)Specify a time to filter for batch inference jobs that were submitted after the time you specify.ListModelInvocationJobsRequest.BuildersubmitTimeBefore(Instant submitTimeBefore)Specify a time to filter for batch inference jobs that were submitted before the time you specify.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
submitTimeAfter
ListModelInvocationJobsRequest.Builder submitTimeAfter(Instant submitTimeAfter)
Specify a time to filter for batch inference jobs that were submitted after the time you specify.
- Parameters:
submitTimeAfter- Specify a time to filter for batch inference jobs that were submitted after the time you specify.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
submitTimeBefore
ListModelInvocationJobsRequest.Builder submitTimeBefore(Instant submitTimeBefore)
Specify a time to filter for batch inference jobs that were submitted before the time you specify.
- Parameters:
submitTimeBefore- Specify a time to filter for batch inference jobs that were submitted before the time you specify.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusEquals
ListModelInvocationJobsRequest.Builder statusEquals(String statusEquals)
Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.
-
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
- Parameters:
statusEquals- Specify a status to filter for batch inference jobs whose statuses match the string you specify.The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.
-
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ModelInvocationJobStatus,ModelInvocationJobStatus
-
-
statusEquals
ListModelInvocationJobsRequest.Builder statusEquals(ModelInvocationJobStatus statusEquals)
Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.
-
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
- Parameters:
statusEquals- Specify a status to filter for batch inference jobs whose statuses match the string you specify.The following statuses are possible:
-
Submitted – This job has been submitted to a queue for validation.
-
Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:
-
Your IAM service role has access to the Amazon S3 buckets containing your files.
-
Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the
modelInputvalue matches the request body for the model. -
Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.
-
-
Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
-
Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
-
InProgress – This job has begun. You can start viewing the results in the output S3 location.
-
Completed – This job has successfully completed. View the output files in the output S3 location.
-
PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
-
Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web ServicesSupport Center.
-
Stopped – This job was stopped by a user.
-
Stopping – This job is being stopped by a user.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ModelInvocationJobStatus,ModelInvocationJobStatus
-
-
nameContains
ListModelInvocationJobsRequest.Builder nameContains(String nameContains)
Specify a string to filter for batch inference jobs whose names contain the string.
- Parameters:
nameContains- Specify a string to filter for batch inference jobs whose names contain the string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListModelInvocationJobsRequest.Builder maxResults(Integer maxResults)
The maximum number of results to return. If there are more results than the number that you specify, a
nextTokenvalue is returned. Use thenextTokenin a request to return the next batch of results.- Parameters:
maxResults- The maximum number of results to return. If there are more results than the number that you specify, anextTokenvalue is returned. Use thenextTokenin a request to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
ListModelInvocationJobsRequest.Builder nextToken(String nextToken)
If there were more results than the value you specified in the
maxResultsfield in a previousListModelInvocationJobsrequest, the response would have returned anextTokenvalue. To see the next batch of results, send thenextTokenvalue in another request.- Parameters:
nextToken- If there were more results than the value you specified in themaxResultsfield in a previousListModelInvocationJobsrequest, the response would have returned anextTokenvalue. To see the next batch of results, send thenextTokenvalue in another request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
ListModelInvocationJobsRequest.Builder sortBy(String sortBy)
An attribute by which to sort the results.
- Parameters:
sortBy- An attribute by which to sort the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SortJobsBy,SortJobsBy
-
sortBy
ListModelInvocationJobsRequest.Builder sortBy(SortJobsBy sortBy)
An attribute by which to sort the results.
- Parameters:
sortBy- An attribute by which to sort the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SortJobsBy,SortJobsBy
-
sortOrder
ListModelInvocationJobsRequest.Builder sortOrder(String sortOrder)
Specifies whether to sort the results by ascending or descending order.
-
sortOrder
ListModelInvocationJobsRequest.Builder sortOrder(SortOrder sortOrder)
Specifies whether to sort the results by ascending or descending order.
-
overrideConfiguration
ListModelInvocationJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListModelInvocationJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-