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

Interface CreateInferenceExperimentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateInferenceExperimentRequest.Builder,CreateInferenceExperimentRequest>, SageMakerRequest.Builder, SdkBuilder<CreateInferenceExperimentRequest.Builder,CreateInferenceExperimentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateInferenceExperimentRequest
public static interface CreateInferenceExperimentRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateInferenceExperimentRequest.Builder,CreateInferenceExperimentRequest>

  • Method Details

    • name

      CreateInferenceExperimentRequest.Builder name(String name)

      The name for the inference experiment.

      Parameters:
      name - The name for the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      CreateInferenceExperimentRequest.Builder type(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateInferenceExperimentRequest.Builder type(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schedule

      CreateInferenceExperimentRequest.Builder schedule(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      default CreateInferenceExperimentRequest.Builder schedule(Consumer<InferenceExperimentSchedule.Builder> 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.

      This is a convenience method that creates an instance of the InferenceExperimentSchedule.Builder avoiding the need to create one manually via InferenceExperimentSchedule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(InferenceExperimentSchedule).

      Parameters:
      schedule - a consumer that will call methods on InferenceExperimentSchedule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateInferenceExperimentRequest.Builder description(String description)

      A description for the inference experiment.

      Parameters:
      description - A description for the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateInferenceExperimentRequest.Builder roleArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • endpointName

      CreateInferenceExperimentRequest.Builder endpointName(String endpointName)

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

      Parameters:
      endpointName - The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelVariants

      CreateInferenceExperimentRequest.Builder modelVariants(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelVariants

      CreateInferenceExperimentRequest.Builder modelVariants(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelVariants

      CreateInferenceExperimentRequest.Builder modelVariants(Consumer<ModelVariantConfig.Builder>... 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.

      This is a convenience method that creates an instance of the ModelVariantConfig.Builder avoiding the need to create one manually via ModelVariantConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelVariants(List<ModelVariantConfig>).

      Parameters:
      modelVariants - a consumer that will call methods on ModelVariantConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataStorageConfig

      CreateInferenceExperimentRequest.Builder dataStorageConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dataStorageConfig

      default CreateInferenceExperimentRequest.Builder dataStorageConfig(Consumer<InferenceExperimentDataStorageConfig.Builder> 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.

      This is a convenience method that creates an instance of the InferenceExperimentDataStorageConfig.Builder avoiding the need to create one manually via InferenceExperimentDataStorageConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataStorageConfig(InferenceExperimentDataStorageConfig).

      Parameters:
      dataStorageConfig - a consumer that will call methods on InferenceExperimentDataStorageConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • shadowModeConfig

      CreateInferenceExperimentRequest.Builder shadowModeConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • shadowModeConfig

      default CreateInferenceExperimentRequest.Builder shadowModeConfig(Consumer<ShadowModeConfig.Builder> 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.

      This is a convenience method that creates an instance of the ShadowModeConfig.Builder avoiding the need to create one manually via ShadowModeConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to shadowModeConfig(ShadowModeConfig).

      Parameters:
      shadowModeConfig - a consumer that will call methods on ShadowModeConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKey

      CreateInferenceExperimentRequest.Builder kmsKey(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateInferenceExperimentRequest.Builder tags(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateInferenceExperimentRequest.Builder tags(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateInferenceExperimentRequest.Builder tags(Consumer<Tag.Builder>... 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateInferenceExperimentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateInferenceExperimentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.