amazonka-sagemaker-2.0: Amazon SageMaker Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMaker.DescribeInferenceExperiment

Description

Returns details about an inference experiment.

Synopsis

Creating a Request

data DescribeInferenceExperiment Source #

See: newDescribeInferenceExperiment smart constructor.

Constructors

DescribeInferenceExperiment' 

Fields

  • name :: Text

    The name of the inference experiment to describe.

Instances

Instances details
ToJSON DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

ToHeaders DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

ToPath DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

ToQuery DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

AWSRequest DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Generic DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Associated Types

type Rep DescribeInferenceExperiment :: Type -> Type #

Read DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Show DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

NFData DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Eq DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Hashable DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

type AWSResponse DescribeInferenceExperiment Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

type Rep DescribeInferenceExperiment Source # 
Instance details

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 Source #

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 Source #

The name of the inference experiment to describe.

Destructuring the Response

data DescribeInferenceExperimentResponse Source #

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

Instances details
Generic DescribeInferenceExperimentResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Read DescribeInferenceExperimentResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Show DescribeInferenceExperimentResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

NFData DescribeInferenceExperimentResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

Eq DescribeInferenceExperimentResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeInferenceExperiment

type Rep DescribeInferenceExperimentResponse Source # 
Instance details

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 Source #

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) Source #

The timestamp at which the inference experiment was completed.

describeInferenceExperimentResponse_dataStorageConfig :: Lens' DescribeInferenceExperimentResponse (Maybe InferenceExperimentDataStorageConfig) Source #

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

describeInferenceExperimentResponse_kmsKey :: Lens' DescribeInferenceExperimentResponse (Maybe Text) Source #

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) Source #

The timestamp at which you last modified the inference experiment.

describeInferenceExperimentResponse_roleArn :: Lens' DescribeInferenceExperimentResponse (Maybe Text) Source #

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_shadowModeConfig :: Lens' DescribeInferenceExperimentResponse (Maybe ShadowModeConfig) Source #

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) Source #

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

describeInferenceExperimentResponse_arn :: Lens' DescribeInferenceExperimentResponse Text Source #

The ARN of the inference experiment being described.

describeInferenceExperimentResponse_status :: Lens' DescribeInferenceExperimentResponse InferenceExperimentStatus Source #

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_modelVariants :: Lens' DescribeInferenceExperimentResponse [ModelVariantConfigSummary] Source #

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.