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

Description

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.

Synopsis

Creating a Request

data CreateImageVersion Source #

See: newCreateImageVersion smart constructor.

Constructors

CreateImageVersion' 

Fields

  • aliases :: Maybe [Text]

    A list of aliases created with the image version.

  • horovod :: Maybe Bool

    Indicates Horovod compatibility.

  • jobType :: Maybe JobType

    Indicates SageMaker job type compatibility.

    • TRAINING: The image version is compatible with SageMaker training jobs.
    • INFERENCE: The image version is compatible with SageMaker inference jobs.
    • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.
  • mLFramework :: Maybe Text

    The machine learning framework vended in the image version.

  • processor :: Maybe Processor

    Indicates CPU or GPU compatibility.

    • CPU: The image version is compatible with CPU.
    • GPU: The image version is compatible with GPU.
  • programmingLang :: Maybe Text

    The supported programming language and its version.

  • releaseNotes :: Maybe Text

    The maintainer description of the image version.

  • vendorGuidance :: Maybe VendorGuidance

    The stability of the image version, specified by the maintainer.

    • NOT_PROVIDED: The maintainers did not provide a status for image version stability.
    • STABLE: The image version is stable.
    • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
    • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.
  • baseImage :: Text

    The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

    <acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
  • clientToken :: Text

    A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

  • imageName :: Text

    The ImageName of the Image to create a version of.

Instances

Instances details
ToJSON CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

toJSON :: CreateImageVersion -> Value #

toEncoding :: CreateImageVersion -> Encoding #

toJSONList :: [CreateImageVersion] -> Value #

toEncodingList :: [CreateImageVersion] -> Encoding #

ToHeaders CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

toHeaders :: CreateImageVersion -> [Header] #

ToPath CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

toPath :: CreateImageVersion -> ByteString #

ToQuery CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

toQuery :: CreateImageVersion -> QueryString #

AWSRequest CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Associated Types

type AWSResponse CreateImageVersion #

Methods

request :: (Service -> Service) -> CreateImageVersion -> Request CreateImageVersion #

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

Generic CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Associated Types

type Rep CreateImageVersion :: Type -> Type #

Methods

from :: CreateImageVersion -> Rep CreateImageVersion x #

to :: Rep CreateImageVersion x -> CreateImageVersion #

Read CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

readsPrec :: Int -> ReadS CreateImageVersion #

readList :: ReadS [CreateImageVersion] #

readPrec :: ReadPrec CreateImageVersion #

readListPrec :: ReadPrec [CreateImageVersion] #

Show CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

showsPrec :: Int -> CreateImageVersion -> ShowS #

show :: CreateImageVersion -> String #

showList :: [CreateImageVersion] -> ShowS #

NFData CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

rnf :: CreateImageVersion -> () #

Eq CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

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

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

Hashable CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

hashWithSalt :: Int -> CreateImageVersion -> Int #

hash :: CreateImageVersion -> Int #

type AWSResponse CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

type AWSResponse CreateImageVersion = CreateImageVersionResponse
type Rep CreateImageVersion Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

type Rep CreateImageVersion = D1 ('MetaData "CreateImageVersion" "Amazonka.SageMaker.CreateImageVersion" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateImageVersion'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "horovod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobType)) :*: (S1 ('MetaSel ('Just "mLFramework") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "processor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Processor))))) :*: ((S1 ('MetaSel ('Just "programmingLang") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "releaseNotes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vendorGuidance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VendorGuidance)))) :*: (S1 ('MetaSel ('Just "baseImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "imageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateImageVersion Source #

Arguments

:: Text

$sel:baseImage:CreateImageVersion'

-> Text

$sel:clientToken:CreateImageVersion'

-> Text

CreateImageVersion

-> CreateImageVersion 

Create a value of CreateImageVersion 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:aliases:CreateImageVersion', createImageVersion_aliases - A list of aliases created with the image version.

$sel:horovod:CreateImageVersion', createImageVersion_horovod - Indicates Horovod compatibility.

CreateImageVersion, createImageVersion_jobType - Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.
  • INFERENCE: The image version is compatible with SageMaker inference jobs.
  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

$sel:mLFramework:CreateImageVersion', createImageVersion_mLFramework - The machine learning framework vended in the image version.

$sel:processor:CreateImageVersion', createImageVersion_processor - Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.
  • GPU: The image version is compatible with GPU.

$sel:programmingLang:CreateImageVersion', createImageVersion_programmingLang - The supported programming language and its version.

$sel:releaseNotes:CreateImageVersion', createImageVersion_releaseNotes - The maintainer description of the image version.

$sel:vendorGuidance:CreateImageVersion', createImageVersion_vendorGuidance - The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.
  • STABLE: The image version is stable.
  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

$sel:baseImage:CreateImageVersion', createImageVersion_baseImage - The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

$sel:clientToken:CreateImageVersion', createImageVersion_clientToken - A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

CreateImageVersion, createImageVersion_imageName - The ImageName of the Image to create a version of.

Request Lenses

createImageVersion_aliases :: Lens' CreateImageVersion (Maybe [Text]) Source #

A list of aliases created with the image version.

createImageVersion_horovod :: Lens' CreateImageVersion (Maybe Bool) Source #

Indicates Horovod compatibility.

createImageVersion_jobType :: Lens' CreateImageVersion (Maybe JobType) Source #

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.
  • INFERENCE: The image version is compatible with SageMaker inference jobs.
  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

createImageVersion_mLFramework :: Lens' CreateImageVersion (Maybe Text) Source #

The machine learning framework vended in the image version.

createImageVersion_processor :: Lens' CreateImageVersion (Maybe Processor) Source #

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.
  • GPU: The image version is compatible with GPU.

createImageVersion_programmingLang :: Lens' CreateImageVersion (Maybe Text) Source #

The supported programming language and its version.

createImageVersion_releaseNotes :: Lens' CreateImageVersion (Maybe Text) Source #

The maintainer description of the image version.

createImageVersion_vendorGuidance :: Lens' CreateImageVersion (Maybe VendorGuidance) Source #

The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.
  • STABLE: The image version is stable.
  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

createImageVersion_baseImage :: Lens' CreateImageVersion Text Source #

The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

createImageVersion_clientToken :: Lens' CreateImageVersion Text Source #

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

createImageVersion_imageName :: Lens' CreateImageVersion Text Source #

The ImageName of the Image to create a version of.

Destructuring the Response

data CreateImageVersionResponse Source #

See: newCreateImageVersionResponse smart constructor.

Constructors

CreateImageVersionResponse' 

Fields

Instances

Instances details
Generic CreateImageVersionResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Associated Types

type Rep CreateImageVersionResponse :: Type -> Type #

Methods

from :: CreateImageVersionResponse -> Rep CreateImageVersionResponse x #

to :: Rep CreateImageVersionResponse x -> CreateImageVersionResponse #

Read CreateImageVersionResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

readsPrec :: Int -> ReadS CreateImageVersionResponse #

readList :: ReadS [CreateImageVersionResponse] #

readPrec :: ReadPrec CreateImageVersionResponse #

readListPrec :: ReadPrec [CreateImageVersionResponse] #

Show CreateImageVersionResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

showsPrec :: Int -> CreateImageVersionResponse -> ShowS #

show :: CreateImageVersionResponse -> String #

showList :: [CreateImageVersionResponse] -> ShowS #

NFData CreateImageVersionResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

rnf :: CreateImageVersionResponse -> () #

Eq CreateImageVersionResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

Methods

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

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

type Rep CreateImageVersionResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateImageVersion

type Rep CreateImageVersionResponse = D1 ('MetaData "CreateImageVersionResponse" "Amazonka.SageMaker.CreateImageVersion" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateImageVersionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateImageVersionResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateImageVersionResponse'

-> CreateImageVersionResponse 

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

CreateImageVersionResponse, createImageVersionResponse_imageVersionArn - The ARN of the image version.

$sel:httpStatus:CreateImageVersionResponse', createImageVersionResponse_httpStatus - The response's http status code.

Response Lenses

createImageVersionResponse_imageVersionArn :: Lens' CreateImageVersionResponse (Maybe Text) Source #

The ARN of the image version.

createImageVersionResponse_httpStatus :: Lens' CreateImageVersionResponse Int Source #

The response's http status code.