Amazonka.SageMaker.UpdateImageVersion

Updates the properties of a SageMaker image version.

Creating a Request

data UpdateImageVersion

See: newUpdateImageVersion smart constructor.

Constructors

UpdateImageVersion'

Fields

• alias :: Maybe Text

  The alias of the image version.

• aliasesToAdd :: Maybe [Text]

  A list of aliases to add.

• aliasesToDelete :: Maybe [Text]

  A list of aliases to delete.

• 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 availability 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.
• version :: Maybe Natural

  The version of the image.

• imageName :: Text

  The name of the image.

Instances

ToJSON UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

toJSON :: UpdateImageVersion -> Value

toEncoding :: UpdateImageVersion -> Encoding

toJSONList :: [UpdateImageVersion] -> Value

toEncodingList :: [UpdateImageVersion] -> Encoding

ToHeaders UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

toHeaders :: UpdateImageVersion -> [Header]

ToPath UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

toPath :: UpdateImageVersion -> ByteString

ToQuery UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

toQuery :: UpdateImageVersion -> QueryString

AWSRequest UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Associated Types

type AWSResponse UpdateImageVersion

Methods

request :: (Service -> Service) -> UpdateImageVersion -> Request UpdateImageVersion

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

Generic UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Associated Types

type Rep UpdateImageVersion :: Type -> Type

Methods

from :: UpdateImageVersion -> Rep UpdateImageVersion x

to :: Rep UpdateImageVersion x -> UpdateImageVersion

Read UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

readsPrec :: Int -> ReadS UpdateImageVersion

readList :: ReadS [UpdateImageVersion]

readPrec :: ReadPrec UpdateImageVersion

readListPrec :: ReadPrec [UpdateImageVersion]

Show UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

showsPrec :: Int -> UpdateImageVersion -> ShowS

show :: UpdateImageVersion -> String

showList :: [UpdateImageVersion] -> ShowS

NFData UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

rnf :: UpdateImageVersion -> ()

Eq UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

(==) :: UpdateImageVersion -> UpdateImageVersion -> Bool

(/=) :: UpdateImageVersion -> UpdateImageVersion -> Bool

Hashable UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

hashWithSalt :: Int -> UpdateImageVersion -> Int

hash :: UpdateImageVersion -> Int

type AWSResponse UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

type AWSResponse UpdateImageVersion = UpdateImageVersionResponse

type Rep UpdateImageVersion

Defined in Amazonka.SageMaker.UpdateImageVersion

type Rep UpdateImageVersion = D1 ('MetaData "UpdateImageVersion" "Amazonka.SageMaker.UpdateImageVersion" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateImageVersion'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "aliasesToAdd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "aliasesToDelete") '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 "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "imageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateImageVersion

Arguments

:: Text

UpdateImageVersion

-> UpdateImageVersion

Create a value of UpdateImageVersion 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:alias:UpdateImageVersion', updateImageVersion_alias - The alias of the image version.

$sel:aliasesToAdd:UpdateImageVersion', updateImageVersion_aliasesToAdd - A list of aliases to add.

$sel:aliasesToDelete:UpdateImageVersion', updateImageVersion_aliasesToDelete - A list of aliases to delete.

$sel:horovod:UpdateImageVersion', updateImageVersion_horovod - Indicates Horovod compatibility.

UpdateImageVersion, updateImageVersion_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:UpdateImageVersion', updateImageVersion_mLFramework - The machine learning framework vended in the image version.

$sel:processor:UpdateImageVersion', updateImageVersion_processor - Indicates CPU or GPU compatibility.

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

$sel:programmingLang:UpdateImageVersion', updateImageVersion_programmingLang - The supported programming language and its version.

$sel:releaseNotes:UpdateImageVersion', updateImageVersion_releaseNotes - The maintainer description of the image version.

$sel:vendorGuidance:UpdateImageVersion', updateImageVersion_vendorGuidance - The availability 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.

UpdateImageVersion, updateImageVersion_version - The version of the image.

UpdateImageVersion, updateImageVersion_imageName - The name of the image.

Request Lenses

updateImageVersion_alias :: Lens' UpdateImageVersion (Maybe Text)

The alias of the image version.

updateImageVersion_aliasesToAdd :: Lens' UpdateImageVersion (Maybe [Text])

A list of aliases to add.

updateImageVersion_aliasesToDelete :: Lens' UpdateImageVersion (Maybe [Text])

A list of aliases to delete.

updateImageVersion_horovod :: Lens' UpdateImageVersion (Maybe Bool)

Indicates Horovod compatibility.

updateImageVersion_jobType :: Lens' UpdateImageVersion (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.

updateImageVersion_mLFramework :: Lens' UpdateImageVersion (Maybe Text)

The machine learning framework vended in the image version.

updateImageVersion_processor :: Lens' UpdateImageVersion (Maybe Processor)

Indicates CPU or GPU compatibility.

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

updateImageVersion_programmingLang :: Lens' UpdateImageVersion (Maybe Text)

The supported programming language and its version.

updateImageVersion_releaseNotes :: Lens' UpdateImageVersion (Maybe Text)

The maintainer description of the image version.

updateImageVersion_vendorGuidance :: Lens' UpdateImageVersion (Maybe VendorGuidance)

The availability 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.

updateImageVersion_version :: Lens' UpdateImageVersion (Maybe Natural)

The version of the image.

updateImageVersion_imageName :: Lens' UpdateImageVersion Text

The name of the image.

Destructuring the Response

data UpdateImageVersionResponse

See: newUpdateImageVersionResponse smart constructor.

Constructors

UpdateImageVersionResponse'

Fields

• imageVersionArn :: Maybe Text

  The ARN of the image version.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateImageVersionResponse

Defined in Amazonka.SageMaker.UpdateImageVersion

Associated Types

type Rep UpdateImageVersionResponse :: Type -> Type

Methods

from :: UpdateImageVersionResponse -> Rep UpdateImageVersionResponse x

to :: Rep UpdateImageVersionResponse x -> UpdateImageVersionResponse

Read UpdateImageVersionResponse

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

readsPrec :: Int -> ReadS UpdateImageVersionResponse

readList :: ReadS [UpdateImageVersionResponse]

readPrec :: ReadPrec UpdateImageVersionResponse

readListPrec :: ReadPrec [UpdateImageVersionResponse]

Show UpdateImageVersionResponse

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

showsPrec :: Int -> UpdateImageVersionResponse -> ShowS

show :: UpdateImageVersionResponse -> String

showList :: [UpdateImageVersionResponse] -> ShowS

NFData UpdateImageVersionResponse

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

rnf :: UpdateImageVersionResponse -> ()

Eq UpdateImageVersionResponse

Defined in Amazonka.SageMaker.UpdateImageVersion

Methods

(==) :: UpdateImageVersionResponse -> UpdateImageVersionResponse -> Bool

(/=) :: UpdateImageVersionResponse -> UpdateImageVersionResponse -> Bool

type Rep UpdateImageVersionResponse

Defined in Amazonka.SageMaker.UpdateImageVersion

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

newUpdateImageVersionResponse

Arguments

:: Int

$sel:httpStatus:UpdateImageVersionResponse'

-> UpdateImageVersionResponse

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

UpdateImageVersionResponse, updateImageVersionResponse_imageVersionArn - The ARN of the image version.

$sel:httpStatus:UpdateImageVersionResponse', updateImageVersionResponse_httpStatus - The response's http status code.

Response Lenses

updateImageVersionResponse_imageVersionArn :: Lens' UpdateImageVersionResponse (Maybe Text)

The ARN of the image version.

updateImageVersionResponse_httpStatus :: Lens' UpdateImageVersionResponse Int

The response's http status code.