Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.DescribeImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a SageMaker image.

Synopsis

data DescribeImage = DescribeImage' {
- imageName :: Text
}
newDescribeImage :: Text -> DescribeImage
describeImage_imageName :: Lens' DescribeImage Text
data DescribeImageResponse = DescribeImageResponse' {
- creationTime :: Maybe POSIX
- failureReason :: Maybe Text
- imageStatus :: Maybe ImageStatus
- lastModifiedTime :: Maybe POSIX
- imageArn :: Maybe Text
- displayName :: Maybe Text
- imageName :: Maybe Text
- description :: Maybe Text
- roleArn :: Maybe Text
- httpStatus :: Int
}
newDescribeImageResponse :: Int -> DescribeImageResponse
describeImageResponse_creationTime :: Lens' DescribeImageResponse (Maybe UTCTime)
describeImageResponse_failureReason :: Lens' DescribeImageResponse (Maybe Text)
describeImageResponse_imageStatus :: Lens' DescribeImageResponse (Maybe ImageStatus)
describeImageResponse_lastModifiedTime :: Lens' DescribeImageResponse (Maybe UTCTime)
describeImageResponse_imageArn :: Lens' DescribeImageResponse (Maybe Text)
describeImageResponse_displayName :: Lens' DescribeImageResponse (Maybe Text)
describeImageResponse_imageName :: Lens' DescribeImageResponse (Maybe Text)
describeImageResponse_description :: Lens' DescribeImageResponse (Maybe Text)
describeImageResponse_roleArn :: Lens' DescribeImageResponse (Maybe Text)
describeImageResponse_httpStatus :: Lens' DescribeImageResponse Int

Creating a Request

data DescribeImage Source #

See: newDescribeImage smart constructor.

Constructors

DescribeImage'
Fields imageName :: Text The name of the image to describe.

Instances

Instances details

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

newDescribeImage Source #

Arguments

:: Text	`$sel:imageName:DescribeImage'`
-> DescribeImage

Create a value of DescribeImage 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:imageName:DescribeImage', describeImage_imageName - The name of the image to describe.

Request Lenses

describeImage_imageName :: Lens' DescribeImage Text Source #

The name of the image to describe.

Destructuring the Response

data DescribeImageResponse Source #

See: newDescribeImageResponse smart constructor.

Constructors

DescribeImageResponse'

Fields

creationTime :: Maybe POSIX
When the image was created.
failureReason :: Maybe Text
When a create, update, or delete operation fails, the reason for the failure.
imageStatus :: Maybe ImageStatus
The status of the image.
lastModifiedTime :: Maybe POSIX
When the image was last modified.
imageArn :: Maybe Text
The Amazon Resource Name (ARN) of the image.
displayName :: Maybe Text
The name of the image as displayed.
imageName :: Maybe Text
The name of the image.
description :: Maybe Text
The description of the image.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeImageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImage Methods (==) :: DescribeImageResponse -> DescribeImageResponse -> Bool # (/=) :: DescribeImageResponse -> DescribeImageResponse -> Bool #
Read DescribeImageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImage Methods readsPrec :: Int -> ReadS DescribeImageResponse # readList :: ReadS [DescribeImageResponse] # readPrec :: ReadPrec DescribeImageResponse # readListPrec :: ReadPrec [DescribeImageResponse] #
Show DescribeImageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImage Methods showsPrec :: Int -> DescribeImageResponse -> ShowS # show :: DescribeImageResponse -> String # showList :: [DescribeImageResponse] -> ShowS #
Generic DescribeImageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImage Associated Types type Rep DescribeImageResponse :: Type -> Type # Methods from :: DescribeImageResponse -> Rep DescribeImageResponse x # to :: Rep DescribeImageResponse x -> DescribeImageResponse #
NFData DescribeImageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImage Methods rnf :: DescribeImageResponse -> () #
type Rep DescribeImageResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImage type Rep DescribeImageResponse = D1 ('MetaData "DescribeImageResponse" "Amazonka.SageMaker.DescribeImage" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeImageResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "imageStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageStatus)) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "imageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "imageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeImageResponse Source #

Arguments

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

Create a value of DescribeImageResponse 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:creationTime:DescribeImageResponse', describeImageResponse_creationTime - When the image was created.

$sel:failureReason:DescribeImageResponse', describeImageResponse_failureReason - When a create, update, or delete operation fails, the reason for the failure.

$sel:imageStatus:DescribeImageResponse', describeImageResponse_imageStatus - The status of the image.

$sel:lastModifiedTime:DescribeImageResponse', describeImageResponse_lastModifiedTime - When the image was last modified.

$sel:imageArn:DescribeImageResponse', describeImageResponse_imageArn - The Amazon Resource Name (ARN) of the image.

$sel:displayName:DescribeImageResponse', describeImageResponse_displayName - The name of the image as displayed.

$sel:imageName:DescribeImage', describeImageResponse_imageName - The name of the image.

$sel:description:DescribeImageResponse', describeImageResponse_description - The description of the image.

$sel:roleArn:DescribeImageResponse', describeImageResponse_roleArn - The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

$sel:httpStatus:DescribeImageResponse', describeImageResponse_httpStatus - The response's http status code.