libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.DescribeModelPackage

Description

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

To create models in Amazon 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
Eq DescribeModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

Methods

(==) :: DescribeModelPackage -> DescribeModelPackage -> Bool #

(/=) :: DescribeModelPackage -> DescribeModelPackage -> Bool #

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 #

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 #

NFData DescribeModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

Methods

rnf :: DescribeModelPackage -> () #

Hashable DescribeModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

Methods

hashWithSalt :: Int -> DescribeModelPackage -> Int #

hash :: DescribeModelPackage -> Int #

ToJSON DescribeModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

Methods

toJSON :: DescribeModelPackage -> Value #

toEncoding :: DescribeModelPackage -> Encoding #

toJSONList :: [DescribeModelPackage] -> Value #

toEncodingList :: [DescribeModelPackage] -> Encoding #

AWSRequest DescribeModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

Associated Types

type AWSResponse DescribeModelPackage #

Methods

request :: DescribeModelPackage -> Request DescribeModelPackage #

response :: MonadResource m => Logger -> Service -> Proxy DescribeModelPackage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeModelPackage))) #

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 #

type Rep DescribeModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

type Rep DescribeModelPackage = D1 ('MetaData "DescribeModelPackage" "Amazonka.SageMaker.DescribeModelPackage" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeModelPackage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "modelPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

type AWSResponse DescribeModelPackage = DescribeModelPackageResponse

newDescribeModelPackage Source #

Arguments

:: Text

$sel:modelPackageName: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:

$sel:modelPackageName: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

Instances

Instances details
Eq DescribeModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

Methods

(==) :: DescribeModelPackageResponse -> DescribeModelPackageResponse -> Bool #

(/=) :: DescribeModelPackageResponse -> DescribeModelPackageResponse -> Bool #

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 #

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 #

NFData DescribeModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

Methods

rnf :: DescribeModelPackageResponse -> () #

type Rep DescribeModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeModelPackage

type Rep DescribeModelPackageResponse = D1 ('MetaData "DescribeModelPackageResponse" "Amazonka.SageMaker.DescribeModelPackage" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeModelPackageResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "metadataProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetadataProperties)) :*: S1 ('MetaSel ('Just "modelApprovalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelApprovalStatus))) :*: (S1 ('MetaSel ('Just "sourceAlgorithmSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceAlgorithmSpecification)) :*: (S1 ('MetaSel ('Just "modelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelMetrics)) :*: S1 ('MetaSel ('Just "modelPackageDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)) :*: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "validationSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelPackageValidationSpecification)) :*: (S1 ('MetaSel ('Just "inferenceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceSpecification)) :*: S1 ('MetaSel ('Just "approvalDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "modelPackageVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "certifyForMarketplace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "modelPackageGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)) :*: 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

$sel:modelPackageName:DescribeModelPackage'

-> Text

$sel:modelPackageArn:DescribeModelPackageResponse'

-> UTCTime

$sel:creationTime:DescribeModelPackageResponse'

-> ModelPackageStatus

$sel:modelPackageStatus:DescribeModelPackageResponse'

-> ModelPackageStatusDetails

$sel: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:

$sel:metadataProperties:DescribeModelPackageResponse', describeModelPackageResponse_metadataProperties - Undocumented member.

$sel:modelApprovalStatus:DescribeModelPackageResponse', describeModelPackageResponse_modelApprovalStatus - The approval status of the model package.

$sel:sourceAlgorithmSpecification:DescribeModelPackageResponse', describeModelPackageResponse_sourceAlgorithmSpecification - Details about the algorithm that was used to create the model package.

$sel:modelMetrics:DescribeModelPackageResponse', describeModelPackageResponse_modelMetrics - Metrics for the model.

$sel:modelPackageDescription:DescribeModelPackageResponse', describeModelPackageResponse_modelPackageDescription - A brief summary of the model package.

$sel:createdBy:DescribeModelPackageResponse', describeModelPackageResponse_createdBy - Undocumented member.

$sel:lastModifiedTime:DescribeModelPackageResponse', describeModelPackageResponse_lastModifiedTime - The last time the model package was modified.

$sel:validationSpecification:DescribeModelPackageResponse', describeModelPackageResponse_validationSpecification - Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

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

$sel:approvalDescription:DescribeModelPackageResponse', describeModelPackageResponse_approvalDescription - A description provided for the model approval.

$sel:modelPackageVersion:DescribeModelPackageResponse', describeModelPackageResponse_modelPackageVersion - The version of the model package.

$sel:certifyForMarketplace:DescribeModelPackageResponse', describeModelPackageResponse_certifyForMarketplace - Whether the model package is certified for listing on Amazon Web Services Marketplace.

$sel:modelPackageGroupName:DescribeModelPackageResponse', describeModelPackageResponse_modelPackageGroupName - If the model is a versioned model, the name of the model group that the versioned model belongs to.

$sel:lastModifiedBy:DescribeModelPackageResponse', describeModelPackageResponse_lastModifiedBy - Undocumented member.

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

$sel:modelPackageName:DescribeModelPackage', describeModelPackageResponse_modelPackageName - The name of the model package being described.

$sel:modelPackageArn:DescribeModelPackageResponse', describeModelPackageResponse_modelPackageArn - The Amazon Resource Name (ARN) of the model package.

$sel:creationTime:DescribeModelPackageResponse', describeModelPackageResponse_creationTime - A timestamp specifying when the model package was created.

$sel:modelPackageStatus:DescribeModelPackageResponse', describeModelPackageResponse_modelPackageStatus - The current status of the model package.

$sel:modelPackageStatusDetails:DescribeModelPackageResponse', describeModelPackageResponse_modelPackageStatusDetails - Details about the current status of the model package.

Response Lenses

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

Undocumented member.

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

The approval status of the model package.

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

Details about the algorithm that was used to create 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_createdBy :: Lens' DescribeModelPackageResponse (Maybe UserContext) Source #

Undocumented member.

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

The last time the model package was modified.

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

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

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

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

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

A description provided for the model approval.

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

The version of the model package.

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

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

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_lastModifiedBy :: Lens' DescribeModelPackageResponse (Maybe UserContext) Source #

Undocumented member.

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.