Amazonka.SageMaker.DescribeInferenceExperiment

Returns details about an inference experiment.

Creating a Request

data DescribeInferenceExperiment

See: newDescribeInferenceExperiment smart constructor.

Constructors

DescribeInferenceExperiment'

Fields

• name :: Text

  The name of the inference experiment to describe.

Instances

ToJSON DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

toJSON :: DescribeInferenceExperiment -> Value

toEncoding :: DescribeInferenceExperiment -> Encoding

toJSONList :: [DescribeInferenceExperiment] -> Value

toEncodingList :: [DescribeInferenceExperiment] -> Encoding

ToHeaders DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

toHeaders :: DescribeInferenceExperiment -> [Header]

ToPath DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

toPath :: DescribeInferenceExperiment -> ByteString

ToQuery DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

toQuery :: DescribeInferenceExperiment -> QueryString

AWSRequest DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Associated Types

type AWSResponse DescribeInferenceExperiment

Methods

request :: (Service -> Service) -> DescribeInferenceExperiment -> Request DescribeInferenceExperiment

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeInferenceExperiment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeInferenceExperiment)))

Generic DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Associated Types

type Rep DescribeInferenceExperiment :: Type -> Type

Methods

from :: DescribeInferenceExperiment -> Rep DescribeInferenceExperiment x

to :: Rep DescribeInferenceExperiment x -> DescribeInferenceExperiment

Read DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

readsPrec :: Int -> ReadS DescribeInferenceExperiment

readList :: ReadS [DescribeInferenceExperiment]

readPrec :: ReadPrec DescribeInferenceExperiment

readListPrec :: ReadPrec [DescribeInferenceExperiment]

Show DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

showsPrec :: Int -> DescribeInferenceExperiment -> ShowS

show :: DescribeInferenceExperiment -> String

showList :: [DescribeInferenceExperiment] -> ShowS

NFData DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

rnf :: DescribeInferenceExperiment -> ()

Eq DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

(==) :: DescribeInferenceExperiment -> DescribeInferenceExperiment -> Bool

(/=) :: DescribeInferenceExperiment -> DescribeInferenceExperiment -> Bool

Hashable DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

hashWithSalt :: Int -> DescribeInferenceExperiment -> Int

hash :: DescribeInferenceExperiment -> Int

type AWSResponse DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

type AWSResponse DescribeInferenceExperiment = DescribeInferenceExperimentResponse

type Rep DescribeInferenceExperiment

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

type Rep DescribeInferenceExperiment = D1 ('MetaData "DescribeInferenceExperiment" "Amazonka.SageMaker.DescribeInferenceExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeInferenceExperiment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeInferenceExperiment

Arguments

:: Text

DescribeInferenceExperiment

-> DescribeInferenceExperiment

Create a value of DescribeInferenceExperiment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeInferenceExperiment, describeInferenceExperiment_name - The name of the inference experiment to describe.

Request Lenses

describeInferenceExperiment_name :: Lens' DescribeInferenceExperiment Text

The name of the inference experiment to describe.

Destructuring the Response

data DescribeInferenceExperimentResponse

See: newDescribeInferenceExperimentResponse smart constructor.

Constructors

DescribeInferenceExperimentResponse'

Fields

• completionTime :: Maybe POSIX

  The timestamp at which the inference experiment was completed.

• creationTime :: Maybe POSIX

  The timestamp at which you created the inference experiment.

• dataStorageConfig :: Maybe InferenceExperimentDataStorageConfig

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

• description :: Maybe Text

  The description of the inference experiment.

• kmsKey :: Maybe Text

  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 CreateInferenceExperimentRequest$KmsKey.

• lastModifiedTime :: Maybe POSIX

  The timestamp at which you last modified the inference experiment.

• roleArn :: Maybe Text

  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 :: Maybe InferenceExperimentSchedule

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

• shadowModeConfig :: Maybe 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.

• statusReason :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

• arn :: Text

  The ARN of the inference experiment being described.

• name :: Text

  The name of the inference experiment.

• type' :: InferenceExperimentType

  The type of the inference experiment.

• status :: InferenceExperimentStatus

  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 API, or if any operation fails with an unexpected error, it shows as cancelled.
• endpointMetadata :: EndpointMetadata

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

• modelVariants :: [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.

Instances

Generic DescribeInferenceExperimentResponse

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Associated Types

type Rep DescribeInferenceExperimentResponse :: Type -> Type

Methods

from :: DescribeInferenceExperimentResponse -> Rep DescribeInferenceExperimentResponse x

to :: Rep DescribeInferenceExperimentResponse x -> DescribeInferenceExperimentResponse

Read DescribeInferenceExperimentResponse

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

readsPrec :: Int -> ReadS DescribeInferenceExperimentResponse

readList :: ReadS [DescribeInferenceExperimentResponse]

readPrec :: ReadPrec DescribeInferenceExperimentResponse

readListPrec :: ReadPrec [DescribeInferenceExperimentResponse]

Show DescribeInferenceExperimentResponse

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

showsPrec :: Int -> DescribeInferenceExperimentResponse -> ShowS

show :: DescribeInferenceExperimentResponse -> String

showList :: [DescribeInferenceExperimentResponse] -> ShowS

NFData DescribeInferenceExperimentResponse

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

rnf :: DescribeInferenceExperimentResponse -> ()

Eq DescribeInferenceExperimentResponse

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Methods

(==) :: DescribeInferenceExperimentResponse -> DescribeInferenceExperimentResponse -> Bool

(/=) :: DescribeInferenceExperimentResponse -> DescribeInferenceExperimentResponse -> Bool

type Rep DescribeInferenceExperimentResponse

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

type Rep DescribeInferenceExperimentResponse = D1 ('MetaData "DescribeInferenceExperimentResponse" "Amazonka.SageMaker.DescribeInferenceExperiment" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeInferenceExperimentResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "completionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "dataStorageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceExperimentDataStorageConfig)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceExperimentSchedule))))) :*: (((S1 ('MetaSel ('Just "shadowModeConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShadowModeConfig)) :*: S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InferenceExperimentType)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InferenceExperimentStatus) :*: (S1 ('MetaSel ('Just "endpointMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EndpointMetadata) :*: S1 ('MetaSel ('Just "modelVariants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ModelVariantConfigSummary])))))))

newDescribeInferenceExperimentResponse

Arguments

:: Int

$sel:httpStatus:DescribeInferenceExperimentResponse'

-> Text

DescribeInferenceExperimentResponse

-> Text

DescribeInferenceExperiment

-> InferenceExperimentType

DescribeInferenceExperimentResponse

-> InferenceExperimentStatus

DescribeInferenceExperimentResponse

-> EndpointMetadata

$sel:endpointMetadata:DescribeInferenceExperimentResponse'

-> DescribeInferenceExperimentResponse

Create a value of DescribeInferenceExperimentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_completionTime - The timestamp at which the inference experiment was completed.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_creationTime - The timestamp at which you created the inference experiment.

$sel:dataStorageConfig:DescribeInferenceExperimentResponse', describeInferenceExperimentResponse_dataStorageConfig - The Amazon S3 location and configuration for storing inference request and response data.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_description - The description of the inference experiment.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_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. For more information, see CreateInferenceExperimentRequest$KmsKey.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_lastModifiedTime - The timestamp at which you last modified the inference experiment.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_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.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_schedule - The duration for which the inference experiment ran or will run.

$sel:shadowModeConfig:DescribeInferenceExperimentResponse', describeInferenceExperimentResponse_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.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_statusReason - The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

$sel:httpStatus:DescribeInferenceExperimentResponse', describeInferenceExperimentResponse_httpStatus - The response's http status code.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_arn - The ARN of the inference experiment being described.

DescribeInferenceExperiment, describeInferenceExperimentResponse_name - The name of the inference experiment.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_type - The type of the inference experiment.

DescribeInferenceExperimentResponse, describeInferenceExperimentResponse_status - 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 API, or if any operation fails with an unexpected error, it shows as cancelled.

$sel:endpointMetadata:DescribeInferenceExperimentResponse', describeInferenceExperimentResponse_endpointMetadata - The metadata of the endpoint on which the inference experiment ran.

$sel:modelVariants:DescribeInferenceExperimentResponse', describeInferenceExperimentResponse_modelVariants - 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.

Response Lenses

describeInferenceExperimentResponse_completionTime :: Lens' DescribeInferenceExperimentResponse (Maybe UTCTime)

The timestamp at which the inference experiment was completed.

describeInferenceExperimentResponse_creationTime :: Lens' DescribeInferenceExperimentResponse (Maybe UTCTime)

The timestamp at which you created the inference experiment.

describeInferenceExperimentResponse_dataStorageConfig :: Lens' DescribeInferenceExperimentResponse (Maybe InferenceExperimentDataStorageConfig)

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

describeInferenceExperimentResponse_description :: Lens' DescribeInferenceExperimentResponse (Maybe Text)

The description of the inference experiment.

describeInferenceExperimentResponse_kmsKey :: Lens' DescribeInferenceExperimentResponse (Maybe Text)

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 CreateInferenceExperimentRequest$KmsKey.

describeInferenceExperimentResponse_lastModifiedTime :: Lens' DescribeInferenceExperimentResponse (Maybe UTCTime)

The timestamp at which you last modified the inference experiment.

describeInferenceExperimentResponse_roleArn :: Lens' DescribeInferenceExperimentResponse (Maybe Text)

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.

describeInferenceExperimentResponse_schedule :: Lens' DescribeInferenceExperimentResponse (Maybe InferenceExperimentSchedule)

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

describeInferenceExperimentResponse_shadowModeConfig :: Lens' DescribeInferenceExperimentResponse (Maybe 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.

describeInferenceExperimentResponse_statusReason :: Lens' DescribeInferenceExperimentResponse (Maybe Text)

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

describeInferenceExperimentResponse_httpStatus :: Lens' DescribeInferenceExperimentResponse Int

The response's http status code.

describeInferenceExperimentResponse_arn :: Lens' DescribeInferenceExperimentResponse Text

The ARN of the inference experiment being described.

describeInferenceExperimentResponse_name :: Lens' DescribeInferenceExperimentResponse Text

The name of the inference experiment.

describeInferenceExperimentResponse_type :: Lens' DescribeInferenceExperimentResponse InferenceExperimentType

The type of the inference experiment.

describeInferenceExperimentResponse_status :: Lens' DescribeInferenceExperimentResponse InferenceExperimentStatus

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 API, or if any operation fails with an unexpected error, it shows as cancelled.

describeInferenceExperimentResponse_endpointMetadata :: Lens' DescribeInferenceExperimentResponse EndpointMetadata

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

describeInferenceExperimentResponse_modelVariants :: Lens' DescribeInferenceExperimentResponse [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.