Class ListModelInvocationJobsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrock.model.BedrockRequest
software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListModelInvocationJobsRequest extends BedrockRequest implements ToCopyableBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>

  • Method Details

    • submitTimeAfter

      public final Instant submitTimeAfter()

      Specify a time to filter for batch inference jobs that were submitted after the time you specify.

      Returns:
      Specify a time to filter for batch inference jobs that were submitted after the time you specify.

    • submitTimeBefore

      public final Instant submitTimeBefore()

      Specify a time to filter for batch inference jobs that were submitted before the time you specify.

      Returns:
      Specify a time to filter for batch inference jobs that were submitted before the time you specify.

    • statusEquals

      public final 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 modelInput value 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.

      If the service returns an enum value that is not available in the current SDK version, statusEquals will return ModelInvocationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusEqualsAsString().

      Returns:
      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 modelInput value 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.

      See Also:

    • statusEqualsAsString

      public final String statusEqualsAsString()

      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 modelInput value 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.

      If the service returns an enum value that is not available in the current SDK version, statusEquals will return ModelInvocationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusEqualsAsString().

      Returns:
      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 modelInput value 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.

      See Also:

    • nameContains

      public final String nameContains()

      Specify a string to filter for batch inference jobs whose names contain the string.

      Returns:
      Specify a string to filter for batch inference jobs whose names contain the string.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

      Returns:
      The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

    • nextToken

      public final String nextToken()

      If there were more results than the value you specified in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken value. To see the next batch of results, send the nextToken value in another request.

      Returns:
      If there were more results than the value you specified in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken value. To see the next batch of results, send the nextToken value in another request.

    • sortBy

      public final SortJobsBy sortBy()

      An attribute by which to sort the results.

      If the service returns an enum value that is not available in the current SDK version, sortBy will return SortJobsBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

      Returns:
      An attribute by which to sort the results.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      An attribute by which to sort the results.

      If the service returns an enum value that is not available in the current SDK version, sortBy will return SortJobsBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

      Returns:
      An attribute by which to sort the results.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      Specifies whether to sort the results by ascending or descending order.

      If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

      Returns:
      Specifies whether to sort the results by ascending or descending order.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      Specifies whether to sort the results by ascending or descending order.

      If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

      Returns:
      Specifies whether to sort the results by ascending or descending order.
      See Also:

    • toBuilder

      public ListModelInvocationJobsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListModelInvocationJobsRequest.Builder,ListModelInvocationJobsRequest>
      Specified by:
      toBuilder in class BedrockRequest
      Returns:
      a builder for type T

    • builder

      public static ListModelInvocationJobsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListModelInvocationJobsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.