Package software.amazon.awssdk.services.sagemaker.model

Class CreateInferenceExperimentRequest

    • Method Detail

      • name

        public final String name()

        The name for the inference experiment.

        Returns:
        The name for the inference experiment.

      • type

        public final InferenceExperimentType type()

        The type of the inference experiment that you want to run. The following types of experiments are possible:

        • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

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

        Returns:
        The type of the inference experiment that you want to run. The following types of experiments are possible:

        • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

        See Also:
        InferenceExperimentType

      • typeAsString

        public final String typeAsString()

        The type of the inference experiment that you want to run. The following types of experiments are possible:

        • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

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

        Returns:
        The type of the inference experiment that you want to run. The following types of experiments are possible:

        • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

        See Also:
        InferenceExperimentType

      • schedule

        public final InferenceExperimentSchedule schedule()

        The duration for which you want the inference experiment to run. If you don't specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.

        Returns:
        The duration for which you want the inference experiment to run. If you don't specify this field, the experiment automatically starts immediately upon creation and concludes after 7 days.

      • description

        public final String description()

        A description for the inference experiment.

        Returns:
        A description for the inference experiment.

      • roleArn

        public final String roleArn()

        The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

        Returns:
        The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

      • endpointName

        public final String endpointName()

        The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

        Returns:
        The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

      • hasModelVariants

        public final boolean hasModelVariants()
        For responses, this returns true if the service returned a value for the ModelVariants 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.

      • modelVariants

        public final List<ModelVariantConfig> modelVariants()

        An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

        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 hasModelVariants() method.

        Returns:
        An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

      • dataStorageConfig

        public final InferenceExperimentDataStorageConfig dataStorageConfig()

        The Amazon S3 location and configuration for storing inference request and response data.

        This is an optional parameter that you can use for data capture. For more information, see Capture data.

        Returns:
        The Amazon S3 location and configuration for storing inference request and response data.

        This is an optional parameter that you can use for data capture. For more information, see Capture data.

      • shadowModeConfig

        public final ShadowModeConfig shadowModeConfig()

        The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

        Returns:
        The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

      • kmsKey

        public final String kmsKey()

        The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

        • KMS key ID

          "1234abcd-12ab-34cd-56ef-1234567890ab"

        • Amazon Resource Name (ARN) of a KMS key

          "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

        • KMS key Alias

          "alias/ExampleAlias"

        • Amazon Resource Name (ARN) of a KMS key Alias

          "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

        The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

        Returns:
        The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

        • KMS key ID

          "1234abcd-12ab-34cd-56ef-1234567890ab"

        • Amazon Resource Name (ARN) of a KMS key

          "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

        • KMS key Alias

          "alias/ExampleAlias"

        • Amazon Resource Name (ARN) of a KMS key Alias

          "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

        If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

        The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

      • 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()

        Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services 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:
        Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services 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