Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.DescribeModelPackage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

Synopsis

Creating a Request

data DescribeModelPackage Source #

See: newDescribeModelPackage smart constructor.

Constructors

DescribeModelPackage'
Fields modelPackageName :: Text The name or Amazon Resource Name (ARN) of the model package to describe. When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

Instances

Instances details

ToJSON DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods toJSON :: DescribeModelPackage -> Value # toEncoding :: DescribeModelPackage -> Encoding # toJSONList :: [DescribeModelPackage] -> Value # toEncodingList :: [DescribeModelPackage] -> Encoding #
ToHeaders DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods toHeaders :: DescribeModelPackage -> [Header] #
ToPath DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods toPath :: DescribeModelPackage -> ByteString #
ToQuery DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods toQuery :: DescribeModelPackage -> QueryString #
AWSRequest DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Associated Types type AWSResponse DescribeModelPackage # Methods request :: (Service -> Service) -> DescribeModelPackage -> Request DescribeModelPackage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeModelPackage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeModelPackage))) #
Generic DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Associated Types type Rep DescribeModelPackage :: Type -> Type # Methods from :: DescribeModelPackage -> Rep DescribeModelPackage x # to :: Rep DescribeModelPackage x -> DescribeModelPackage #
Read DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods readsPrec :: Int -> ReadS DescribeModelPackage # readList :: ReadS [DescribeModelPackage] # readPrec :: ReadPrec DescribeModelPackage # readListPrec :: ReadPrec [DescribeModelPackage] #
Show DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods showsPrec :: Int -> DescribeModelPackage -> ShowS # show :: DescribeModelPackage -> String # showList :: [DescribeModelPackage] -> ShowS #
NFData DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods rnf :: DescribeModelPackage -> () #
Eq DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods (==) :: DescribeModelPackage -> DescribeModelPackage -> Bool # (/=) :: DescribeModelPackage -> DescribeModelPackage -> Bool #
Hashable DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods hashWithSalt :: Int -> DescribeModelPackage -> Int # hash :: DescribeModelPackage -> Int #
type AWSResponse DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage type AWSResponse DescribeModelPackage = DescribeModelPackageResponse
type Rep DescribeModelPackage Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage type Rep DescribeModelPackage = D1 ('MetaData "DescribeModelPackage" "Amazonka.SageMaker.DescribeModelPackage" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeModelPackage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "modelPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeModelPackage Source #

Arguments

:: Text	`DescribeModelPackage`
-> DescribeModelPackage

Create a value of DescribeModelPackage 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:

DescribeModelPackage, describeModelPackage_modelPackageName - The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

Request Lenses

describeModelPackage_modelPackageName :: Lens' DescribeModelPackage Text Source #

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

Destructuring the Response

data DescribeModelPackageResponse Source #

See: newDescribeModelPackageResponse smart constructor.

Constructors

DescribeModelPackageResponse'

Fields

additionalInferenceSpecifications :: Maybe (NonEmpty AdditionalInferenceSpecificationDefinition)
An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
approvalDescription :: Maybe Text
A description provided for the model approval.
certifyForMarketplace :: Maybe Bool
Whether the model package is certified for listing on Amazon Web Services Marketplace.
createdBy :: Maybe UserContext
customerMetadataProperties :: Maybe (HashMap Text Text)
The metadata properties associated with the model package versions.
domain :: Maybe Text
The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
driftCheckBaselines :: Maybe DriftCheckBaselines
Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
inferenceSpecification :: Maybe InferenceSpecification
Details about inference jobs that can be run with models based on this model package.
lastModifiedBy :: Maybe UserContext
lastModifiedTime :: Maybe POSIX
The last time that the model package was modified.
metadataProperties :: Maybe MetadataProperties
modelApprovalStatus :: Maybe ModelApprovalStatus
The approval status of the model package.
modelMetrics :: Maybe ModelMetrics
Metrics for the model.
modelPackageDescription :: Maybe Text
A brief summary of the model package.
modelPackageGroupName :: Maybe Text
If the model is a versioned model, the name of the model group that the versioned model belongs to.
modelPackageVersion :: Maybe Natural
The version of the model package.
samplePayloadUrl :: Maybe Text
The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).
sourceAlgorithmSpecification :: Maybe SourceAlgorithmSpecification
Details about the algorithm that was used to create the model package.
task :: Maybe Text
The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
validationSpecification :: Maybe ModelPackageValidationSpecification
Configurations for one or more transform jobs that SageMaker runs to test the model package.
httpStatus :: Int
The response's http status code.
modelPackageName :: Text
The name of the model package being described.
modelPackageArn :: Text
The Amazon Resource Name (ARN) of the model package.
creationTime :: POSIX
A timestamp specifying when the model package was created.
modelPackageStatus :: ModelPackageStatus
The current status of the model package.
modelPackageStatusDetails :: ModelPackageStatusDetails
Details about the current status of the model package.

Instances

Instances details

Generic DescribeModelPackageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Associated Types type Rep DescribeModelPackageResponse :: Type -> Type # Methods from :: DescribeModelPackageResponse -> Rep DescribeModelPackageResponse x # to :: Rep DescribeModelPackageResponse x -> DescribeModelPackageResponse #
Read DescribeModelPackageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods readsPrec :: Int -> ReadS DescribeModelPackageResponse # readList :: ReadS [DescribeModelPackageResponse] # readPrec :: ReadPrec DescribeModelPackageResponse # readListPrec :: ReadPrec [DescribeModelPackageResponse] #
Show DescribeModelPackageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods showsPrec :: Int -> DescribeModelPackageResponse -> ShowS # show :: DescribeModelPackageResponse -> String # showList :: [DescribeModelPackageResponse] -> ShowS #
NFData DescribeModelPackageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods rnf :: DescribeModelPackageResponse -> () #
Eq DescribeModelPackageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage Methods (==) :: DescribeModelPackageResponse -> DescribeModelPackageResponse -> Bool # (/=) :: DescribeModelPackageResponse -> DescribeModelPackageResponse -> Bool #
type Rep DescribeModelPackageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeModelPackage type Rep DescribeModelPackageResponse = D1 ('MetaData "DescribeModelPackageResponse" "Amazonka.SageMaker.DescribeModelPackage" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeModelPackageResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "additionalInferenceSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AdditionalInferenceSpecificationDefinition))) :: (S1 ('MetaSel ('Just "approvalDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certifyForMarketplace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)) :: (S1 ('MetaSel ('Just "customerMetadataProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "driftCheckBaselines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DriftCheckBaselines)) :: (S1 ('MetaSel ('Just "inferenceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceSpecification)) :: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)))) :: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "metadataProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetadataProperties))) :: (S1 ('MetaSel ('Just "modelApprovalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelApprovalStatus)) :: S1 ('MetaSel ('Just "modelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelMetrics)))))) :: (((S1 ('MetaSel ('Just "modelPackageDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "modelPackageGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "modelPackageVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "samplePayloadUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sourceAlgorithmSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceAlgorithmSpecification)) :: S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "validationSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelPackageValidationSpecification)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "modelPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "modelPackageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "modelPackageStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModelPackageStatus) :*: S1 ('MetaSel ('Just "modelPackageStatusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModelPackageStatusDetails)))))))

newDescribeModelPackageResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeModelPackageResponse'`
-> Text	`DescribeModelPackage`
-> Text	`DescribeModelPackageResponse`
-> UTCTime	`DescribeModelPackageResponse`
-> ModelPackageStatus	`DescribeModelPackageResponse`
-> ModelPackageStatusDetails	`DescribeModelPackageResponse`
-> DescribeModelPackageResponse

Create a value of DescribeModelPackageResponse 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:

DescribeModelPackageResponse, describeModelPackageResponse_additionalInferenceSpecifications - An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

DescribeModelPackageResponse, describeModelPackageResponse_approvalDescription - A description provided for the model approval.

DescribeModelPackageResponse, describeModelPackageResponse_certifyForMarketplace - Whether the model package is certified for listing on Amazon Web Services Marketplace.

DescribeModelPackageResponse, describeModelPackageResponse_createdBy - Undocumented member.

DescribeModelPackageResponse, describeModelPackageResponse_customerMetadataProperties - The metadata properties associated with the model package versions.

DescribeModelPackageResponse, describeModelPackageResponse_domain - The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

DescribeModelPackageResponse, describeModelPackageResponse_driftCheckBaselines - Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

DescribeModelPackageResponse, describeModelPackageResponse_inferenceSpecification - Details about inference jobs that can be run with models based on this model package.

DescribeModelPackageResponse, describeModelPackageResponse_lastModifiedBy - Undocumented member.

DescribeModelPackageResponse, describeModelPackageResponse_lastModifiedTime - The last time that the model package was modified.

DescribeModelPackageResponse, describeModelPackageResponse_metadataProperties - Undocumented member.

DescribeModelPackageResponse, describeModelPackageResponse_modelApprovalStatus - The approval status of the model package.

DescribeModelPackageResponse, describeModelPackageResponse_modelMetrics - Metrics for the model.

DescribeModelPackageResponse, describeModelPackageResponse_modelPackageDescription - A brief summary of the model package.

DescribeModelPackageResponse, describeModelPackageResponse_modelPackageGroupName - If the model is a versioned model, the name of the model group that the versioned model belongs to.

DescribeModelPackageResponse, describeModelPackageResponse_modelPackageVersion - The version of the model package.

DescribeModelPackageResponse, describeModelPackageResponse_samplePayloadUrl - The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

DescribeModelPackageResponse, describeModelPackageResponse_sourceAlgorithmSpecification - Details about the algorithm that was used to create the model package.

DescribeModelPackageResponse, describeModelPackageResponse_task - The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

DescribeModelPackageResponse, describeModelPackageResponse_validationSpecification - Configurations for one or more transform jobs that SageMaker runs to test the model package.

$sel:httpStatus:DescribeModelPackageResponse', describeModelPackageResponse_httpStatus - The response's http status code.

DescribeModelPackage, describeModelPackageResponse_modelPackageName - The name of the model package being described.

DescribeModelPackageResponse, describeModelPackageResponse_modelPackageArn - The Amazon Resource Name (ARN) of the model package.

DescribeModelPackageResponse, describeModelPackageResponse_creationTime - A timestamp specifying when the model package was created.

DescribeModelPackageResponse, describeModelPackageResponse_modelPackageStatus - The current status of the model package.

DescribeModelPackageResponse, describeModelPackageResponse_modelPackageStatusDetails - Details about the current status of the model package.

Response Lenses

describeModelPackageResponse_additionalInferenceSpecifications :: Lens' DescribeModelPackageResponse (Maybe (NonEmpty AdditionalInferenceSpecificationDefinition)) Source #

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

describeModelPackageResponse_approvalDescription :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

A description provided for the model approval.

describeModelPackageResponse_certifyForMarketplace :: Lens' DescribeModelPackageResponse (Maybe Bool) Source #

Whether the model package is certified for listing on Amazon Web Services Marketplace.

describeModelPackageResponse_createdBy :: Lens' DescribeModelPackageResponse (Maybe UserContext) Source #

Undocumented member.

describeModelPackageResponse_customerMetadataProperties :: Lens' DescribeModelPackageResponse (Maybe (HashMap Text Text)) Source #

The metadata properties associated with the model package versions.

describeModelPackageResponse_domain :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

describeModelPackageResponse_driftCheckBaselines :: Lens' DescribeModelPackageResponse (Maybe DriftCheckBaselines) Source #

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

describeModelPackageResponse_inferenceSpecification :: Lens' DescribeModelPackageResponse (Maybe InferenceSpecification) Source #

Details about inference jobs that can be run with models based on this model package.

describeModelPackageResponse_lastModifiedBy :: Lens' DescribeModelPackageResponse (Maybe UserContext) Source #

Undocumented member.

describeModelPackageResponse_lastModifiedTime :: Lens' DescribeModelPackageResponse (Maybe UTCTime) Source #

The last time that the model package was modified.

describeModelPackageResponse_metadataProperties :: Lens' DescribeModelPackageResponse (Maybe MetadataProperties) Source #

Undocumented member.

describeModelPackageResponse_modelApprovalStatus :: Lens' DescribeModelPackageResponse (Maybe ModelApprovalStatus) Source #

The approval status of the model package.

describeModelPackageResponse_modelMetrics :: Lens' DescribeModelPackageResponse (Maybe ModelMetrics) Source #

Metrics for the model.

describeModelPackageResponse_modelPackageDescription :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

A brief summary of the model package.

describeModelPackageResponse_modelPackageGroupName :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

If the model is a versioned model, the name of the model group that the versioned model belongs to.

describeModelPackageResponse_modelPackageVersion :: Lens' DescribeModelPackageResponse (Maybe Natural) Source #

The version of the model package.

describeModelPackageResponse_samplePayloadUrl :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

describeModelPackageResponse_sourceAlgorithmSpecification :: Lens' DescribeModelPackageResponse (Maybe SourceAlgorithmSpecification) Source #

Details about the algorithm that was used to create the model package.

describeModelPackageResponse_task :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

describeModelPackageResponse_validationSpecification :: Lens' DescribeModelPackageResponse (Maybe ModelPackageValidationSpecification) Source #

Configurations for one or more transform jobs that SageMaker runs to test the model package.

describeModelPackageResponse_httpStatus :: Lens' DescribeModelPackageResponse Int Source #

The response's http status code.

describeModelPackageResponse_modelPackageName :: Lens' DescribeModelPackageResponse Text Source #

The name of the model package being described.

describeModelPackageResponse_modelPackageArn :: Lens' DescribeModelPackageResponse Text Source #

The Amazon Resource Name (ARN) of the model package.

describeModelPackageResponse_creationTime :: Lens' DescribeModelPackageResponse UTCTime Source #

A timestamp specifying when the model package was created.

describeModelPackageResponse_modelPackageStatus :: Lens' DescribeModelPackageResponse ModelPackageStatus Source #

The current status of the model package.

describeModelPackageResponse_modelPackageStatusDetails :: Lens' DescribeModelPackageResponse ModelPackageStatusDetails Source #

Details about the current status of the model package.