Class: Aws::SageMaker::Types::DescribeInferenceExperimentResponse

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::DescribeInferenceExperimentResponse

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the inference experiment being described.

• #completion_time ⇒ Time

  The timestamp at which the inference experiment was completed.

• #creation_time ⇒ Time

  The timestamp at which you created the inference experiment.

• #data_storage_config ⇒ Types::InferenceExperimentDataStorageConfig

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

• #description ⇒ String

  The description of the inference experiment.

• #endpoint_metadata ⇒ Types::EndpointMetadata

  The metadata of the endpoint on which the inference experiment ran.

• #kms_key ⇒ String

  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.

• #last_modified_time ⇒ Time

  The timestamp at which you last modified the inference experiment.

• #model_variants ⇒ Array<Types::ModelVariantConfigSummary>

  An array of ‘ModelVariantConfigSummary` objects.

• #name ⇒ String

  The name of the inference experiment.

• #role_arn ⇒ String

  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.

• #schedule ⇒ Types::InferenceExperimentSchedule

  The duration for which the inference experiment ran or will run.

• #shadow_mode_config ⇒ Types::ShadowModeConfig

  The configuration of ‘ShadowMode` inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests.

• #status ⇒ String

  The status of the inference experiment.

• #status_reason ⇒ String

  The error message or client-specified ‘Reason` from the [StopInferenceExperiment] API, that explains the status of the inference experiment.

• #type ⇒ String

  The type of the inference experiment.

Instance Attribute Details

#arn ⇒ String

The ARN of the inference experiment being described.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#completion_time ⇒ Time

The timestamp at which the inference experiment was completed.

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The timestamp at which you created the inference experiment.

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#data_storage_config ⇒ Types::InferenceExperimentDataStorageConfig

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

Returns:

• (Types::InferenceExperimentDataStorageConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the inference experiment.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_metadata ⇒ Types::EndpointMetadata

The metadata of the endpoint on which the inference experiment ran.

Returns:

• (Types::EndpointMetadata)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key ⇒ String

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. For more information, see [CreateInferenceExperiment].

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

The timestamp at which you last modified the inference experiment.

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#model_variants ⇒ Array<Types::ModelVariantConfigSummary>

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

Returns:

• (Array<Types::ModelVariantConfigSummary>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the inference experiment.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::InferenceExperimentSchedule

The duration for which the inference experiment ran or will run.

Returns:

• (Types::InferenceExperimentSchedule)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#shadow_mode_config ⇒ Types::ShadowModeConfig

The configuration of ‘ShadowMode` inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

Returns:

• (Types::ShadowModeConfig)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the inference experiment. The following are the possible statuses for an inference experiment:

• ‘Creating` - Amazon SageMaker is creating your experiment.

• ‘Created` - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

• ‘Updating` - When you make changes to your experiment, your experiment shows as updating.

• ‘Starting` - Amazon SageMaker is beginning your experiment.

• ‘Running` - Your experiment is in progress.

• ‘Stopping` - Amazon SageMaker is stopping your experiment.

• ‘Completed` - Your experiment has completed.

• ‘Cancelled` - When you conclude your experiment early using the

  StopInferenceExperiment][1

  API, or if any operation fails with

  an unexpected error, it shows as cancelled.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The error message or client-specified ‘Reason` from the

StopInferenceExperiment][1

API, that explains the status of the

inference experiment.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the inference experiment.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 15300

class DescribeInferenceExperimentResponse < Struct.new(
  :arn,
  :name,
  :type,
  :schedule,
  :status,
  :status_reason,
  :description,
  :creation_time,
  :completion_time,
  :last_modified_time,
  :role_arn,
  :endpoint_metadata,
  :model_variants,
  :data_storage_config,
  :shadow_mode_config,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end