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.CreateModelPackage

Description

Creates a model package that you can use to create Amazon SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in Amazon SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

  • Versioned - a model that is part of a model group in the model registry.
  • Unversioned - a model package that is not part of a model group.
Synopsis

Creating a Request

data CreateModelPackage Source #

See: newCreateModelPackage smart constructor.

Constructors

CreateModelPackage' 

Fields

Instances

Instances details
Eq CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

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

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

Read CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

readsPrec :: Int -> ReadS CreateModelPackage #

readList :: ReadS [CreateModelPackage] #

readPrec :: ReadPrec CreateModelPackage #

readListPrec :: ReadPrec [CreateModelPackage] #

Show CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

showsPrec :: Int -> CreateModelPackage -> ShowS #

show :: CreateModelPackage -> String #

showList :: [CreateModelPackage] -> ShowS #

Generic CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Associated Types

type Rep CreateModelPackage :: Type -> Type #

Methods

from :: CreateModelPackage -> Rep CreateModelPackage x #

to :: Rep CreateModelPackage x -> CreateModelPackage #

NFData CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

rnf :: CreateModelPackage -> () #

Hashable CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

hashWithSalt :: Int -> CreateModelPackage -> Int #

hash :: CreateModelPackage -> Int #

ToJSON CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

toJSON :: CreateModelPackage -> Value #

toEncoding :: CreateModelPackage -> Encoding #

toJSONList :: [CreateModelPackage] -> Value #

toEncodingList :: [CreateModelPackage] -> Encoding #

AWSRequest CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Associated Types

type AWSResponse CreateModelPackage #

Methods

request :: CreateModelPackage -> Request CreateModelPackage #

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

ToHeaders CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

toHeaders :: CreateModelPackage -> [Header] #

ToPath CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

toPath :: CreateModelPackage -> ByteString #

ToQuery CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

toQuery :: CreateModelPackage -> QueryString #

type Rep CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

type Rep CreateModelPackage = D1 ('MetaData "CreateModelPackage" "Amazonka.SageMaker.CreateModelPackage" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateModelPackage'" '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 "modelPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "modelMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelMetrics))))) :*: ((S1 ('MetaSel ('Just "modelPackageDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "validationSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelPackageValidationSpecification)) :*: S1 ('MetaSel ('Just "inferenceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceSpecification)))) :*: (S1 ('MetaSel ('Just "certifyForMarketplace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "modelPackageGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))
type AWSResponse CreateModelPackage Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

type AWSResponse CreateModelPackage = CreateModelPackageResponse

newCreateModelPackage :: CreateModelPackage Source #

Create a value of CreateModelPackage 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:CreateModelPackage', createModelPackage_metadataProperties - Undocumented member.

$sel:modelApprovalStatus:CreateModelPackage', createModelPackage_modelApprovalStatus - Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

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

$sel:modelPackageName:CreateModelPackage', createModelPackage_modelPackageName - The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

$sel:clientToken:CreateModelPackage', createModelPackage_clientToken - A unique token that guarantees that the call to this API is idempotent.

$sel:modelMetrics:CreateModelPackage', createModelPackage_modelMetrics - A structure that contains model metrics reports.

$sel:modelPackageDescription:CreateModelPackage', createModelPackage_modelPackageDescription - A description of the model package.

$sel:validationSpecification:CreateModelPackage', createModelPackage_validationSpecification - Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

$sel:inferenceSpecification:CreateModelPackage', createModelPackage_inferenceSpecification - Specifies details about inference jobs that can be run with models based on this model package, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.
  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
  • The input and output content formats that the model package supports for inference.

$sel:certifyForMarketplace:CreateModelPackage', createModelPackage_certifyForMarketplace - Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

$sel:modelPackageGroupName:CreateModelPackage', createModelPackage_modelPackageGroupName - The name of the model group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

$sel:tags:CreateModelPackage', createModelPackage_tags - A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Request Lenses

createModelPackage_metadataProperties :: Lens' CreateModelPackage (Maybe MetadataProperties) Source #

Undocumented member.

createModelPackage_modelApprovalStatus :: Lens' CreateModelPackage (Maybe ModelApprovalStatus) Source #

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

createModelPackage_sourceAlgorithmSpecification :: Lens' CreateModelPackage (Maybe SourceAlgorithmSpecification) Source #

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

createModelPackage_modelPackageName :: Lens' CreateModelPackage (Maybe Text) Source #

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

createModelPackage_clientToken :: Lens' CreateModelPackage (Maybe Text) Source #

A unique token that guarantees that the call to this API is idempotent.

createModelPackage_modelMetrics :: Lens' CreateModelPackage (Maybe ModelMetrics) Source #

A structure that contains model metrics reports.

createModelPackage_modelPackageDescription :: Lens' CreateModelPackage (Maybe Text) Source #

A description of the model package.

createModelPackage_validationSpecification :: Lens' CreateModelPackage (Maybe ModelPackageValidationSpecification) Source #

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

createModelPackage_inferenceSpecification :: Lens' CreateModelPackage (Maybe InferenceSpecification) Source #

Specifies details about inference jobs that can be run with models based on this model package, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.
  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
  • The input and output content formats that the model package supports for inference.

createModelPackage_certifyForMarketplace :: Lens' CreateModelPackage (Maybe Bool) Source #

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

createModelPackage_modelPackageGroupName :: Lens' CreateModelPackage (Maybe Text) Source #

The name of the model group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

createModelPackage_tags :: Lens' CreateModelPackage (Maybe [Tag]) Source #

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

Destructuring the Response

data CreateModelPackageResponse Source #

See: newCreateModelPackageResponse smart constructor.

Constructors

CreateModelPackageResponse' 

Fields

Instances

Instances details
Eq CreateModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

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

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

Read CreateModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

readsPrec :: Int -> ReadS CreateModelPackageResponse #

readList :: ReadS [CreateModelPackageResponse] #

readPrec :: ReadPrec CreateModelPackageResponse #

readListPrec :: ReadPrec [CreateModelPackageResponse] #

Show CreateModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

showsPrec :: Int -> CreateModelPackageResponse -> ShowS #

show :: CreateModelPackageResponse -> String #

showList :: [CreateModelPackageResponse] -> ShowS #

Generic CreateModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Associated Types

type Rep CreateModelPackageResponse :: Type -> Type #

Methods

from :: CreateModelPackageResponse -> Rep CreateModelPackageResponse x #

to :: Rep CreateModelPackageResponse x -> CreateModelPackageResponse #

NFData CreateModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

Methods

rnf :: CreateModelPackageResponse -> () #

type Rep CreateModelPackageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateModelPackage

type Rep CreateModelPackageResponse = D1 ('MetaData "CreateModelPackageResponse" "Amazonka.SageMaker.CreateModelPackage" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateModelPackageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "modelPackageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateModelPackageResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateModelPackageResponse'

-> Text

$sel:modelPackageArn:CreateModelPackageResponse'

-> CreateModelPackageResponse 

Create a value of CreateModelPackageResponse 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:httpStatus:CreateModelPackageResponse', createModelPackageResponse_httpStatus - The response's http status code.

$sel:modelPackageArn:CreateModelPackageResponse', createModelPackageResponse_modelPackageArn - The Amazon Resource Name (ARN) of the new model package.

Response Lenses

createModelPackageResponse_httpStatus :: Lens' CreateModelPackageResponse Int Source #

The response's http status code.

createModelPackageResponse_modelPackageArn :: Lens' CreateModelPackageResponse Text Source #

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