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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.

Synopsis

data CreateImage = CreateImage' {
- description :: Maybe Text
- displayName :: Maybe Text
- tags :: Maybe [Tag]
- imageName :: Text
- roleArn :: Text
}
newCreateImage :: Text -> Text -> CreateImage
createImage_description :: Lens' CreateImage (Maybe Text)
createImage_displayName :: Lens' CreateImage (Maybe Text)
createImage_tags :: Lens' CreateImage (Maybe [Tag])
createImage_imageName :: Lens' CreateImage Text
createImage_roleArn :: Lens' CreateImage Text
data CreateImageResponse = CreateImageResponse' {
- imageArn :: Maybe Text
- httpStatus :: Int
}
newCreateImageResponse :: Int -> CreateImageResponse
createImageResponse_imageArn :: Lens' CreateImageResponse (Maybe Text)
createImageResponse_httpStatus :: Lens' CreateImageResponse Int

Creating a Request

data CreateImage Source #

See: newCreateImage smart constructor.

Constructors

CreateImage'
Fields description :: Maybe Text The description of the image. displayName :: Maybe Text The display name of the image. If not provided, `ImageName` is displayed. tags :: Maybe [Tag] A list of tags to apply to the image. imageName :: Text The name of the image. Must be unique to your account. roleArn :: Text The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Instances

Instances details

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

newCreateImage Source #

Arguments

:: Text	`CreateImage`
-> Text	`CreateImage`
-> CreateImage

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

CreateImage, createImage_description - The description of the image.

CreateImage, createImage_displayName - The display name of the image. If not provided, ImageName is displayed.

CreateImage, createImage_tags - A list of tags to apply to the image.

CreateImage, createImage_imageName - The name of the image. Must be unique to your account.

CreateImage, createImage_roleArn - The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Request Lenses

createImage_description :: Lens' CreateImage (Maybe Text) Source #

The description of the image.

createImage_displayName :: Lens' CreateImage (Maybe Text) Source #

The display name of the image. If not provided, ImageName is displayed.

createImage_tags :: Lens' CreateImage (Maybe [Tag]) Source #

A list of tags to apply to the image.

createImage_imageName :: Lens' CreateImage Text Source #

The name of the image. Must be unique to your account.

createImage_roleArn :: Lens' CreateImage Text Source #

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Destructuring the Response

data CreateImageResponse Source #

See: newCreateImageResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateImageResponse Source #

Arguments

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

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

CreateImageResponse, createImageResponse_imageArn - The ARN of the image.

$sel:httpStatus:CreateImageResponse', createImageResponse_httpStatus - The response's http status code.

Response Lenses

createImageResponse_imageArn :: Lens' CreateImageResponse (Maybe Text) Source #

The ARN of the image.

createImageResponse_httpStatus :: Lens' CreateImageResponse Int Source #

The response's http status code.