Class CreateModelInvocationJobRequest

    • Method Detail

      • jobName

        public final String jobName()

        A name to give the batch inference job.

        Returns:
        A name to give the batch inference job.
      • 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.
      • 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.
      • modelId

        public final String modelId()

        The unique identifier of the foundation model to use for the batch inference job.

        Returns:
        The unique identifier of the foundation model to use for the batch inference job.
      • 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.
      • timeoutDurationInHours

        public final Integer timeoutDurationInHours()

        The number of hours after which to force the batch inference job to time out.

        Returns:
        The number of hours after which to force the batch inference job to time out.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final List<Tag> tags()

        Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.
      • 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