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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.

Synopsis

Creating a Request

data UpdateImage Source #

See: newUpdateImage smart constructor.

Constructors

UpdateImage'

Fields

deleteProperties :: Maybe [Text]
A list of properties to delete. Only the Description and DisplayName properties can be deleted.
description :: Maybe Text
The new description for the image.
displayName :: Maybe Text
The new display name for the image.
roleArn :: Maybe Text
The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
imageName :: Text
The name of the image to update.

Instances

Instances details

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

newUpdateImage Source #

Arguments

:: Text	`UpdateImage`
-> UpdateImage

Create a value of UpdateImage 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:deleteProperties:UpdateImage', updateImage_deleteProperties - A list of properties to delete. Only the Description and DisplayName properties can be deleted.

UpdateImage, updateImage_description - The new description for the image.

UpdateImage, updateImage_displayName - The new display name for the image.

UpdateImage, updateImage_roleArn - The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

UpdateImage, updateImage_imageName - The name of the image to update.

Request Lenses

updateImage_deleteProperties :: Lens' UpdateImage (Maybe [Text]) Source #

A list of properties to delete. Only the Description and DisplayName properties can be deleted.

updateImage_description :: Lens' UpdateImage (Maybe Text) Source #

The new description for the image.

updateImage_displayName :: Lens' UpdateImage (Maybe Text) Source #

The new display name for the image.

updateImage_roleArn :: Lens' UpdateImage (Maybe Text) Source #

The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

updateImage_imageName :: Lens' UpdateImage Text Source #

The name of the image to update.

Destructuring the Response

data UpdateImageResponse Source #

See: newUpdateImageResponse smart constructor.

Constructors

UpdateImageResponse'
Fields imageArn :: Maybe Text The ARN of the image. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateImageResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateImage Associated Types type Rep UpdateImageResponse :: Type -> Type # Methods from :: UpdateImageResponse -> Rep UpdateImageResponse x # to :: Rep UpdateImageResponse x -> UpdateImageResponse #
Read UpdateImageResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateImage Methods readsPrec :: Int -> ReadS UpdateImageResponse # readList :: ReadS [UpdateImageResponse] # readPrec :: ReadPrec UpdateImageResponse # readListPrec :: ReadPrec [UpdateImageResponse] #
Show UpdateImageResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateImage Methods showsPrec :: Int -> UpdateImageResponse -> ShowS # show :: UpdateImageResponse -> String # showList :: [UpdateImageResponse] -> ShowS #
NFData UpdateImageResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateImage Methods rnf :: UpdateImageResponse -> () #
Eq UpdateImageResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateImage Methods (==) :: UpdateImageResponse -> UpdateImageResponse -> Bool # (/=) :: UpdateImageResponse -> UpdateImageResponse -> Bool #
type Rep UpdateImageResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateImage type Rep UpdateImageResponse = D1 ('MetaData "UpdateImageResponse" "Amazonka.SageMaker.UpdateImage" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateImageResponse'`
-> UpdateImageResponse

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

UpdateImageResponse, updateImageResponse_imageArn - The ARN of the image.

$sel:httpStatus:UpdateImageResponse', updateImageResponse_httpStatus - The response's http status code.

Response Lenses

updateImageResponse_imageArn :: Lens' UpdateImageResponse (Maybe Text) Source #

The ARN of the image.

updateImageResponse_httpStatus :: Lens' UpdateImageResponse Int Source #

The response's http status code.