Amazonka.SageMaker.DescribeImage

Describes a SageMaker image.

Creating a Request

data DescribeImage

See: newDescribeImage smart constructor.

Constructors

DescribeImage'

Fields

• imageName :: Text

  The name of the image to describe.

Instances

ToJSON DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

toJSON :: DescribeImage -> Value

toEncoding :: DescribeImage -> Encoding

toJSONList :: [DescribeImage] -> Value

toEncodingList :: [DescribeImage] -> Encoding

ToHeaders DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

toHeaders :: DescribeImage -> [Header]

ToPath DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

toPath :: DescribeImage -> ByteString

ToQuery DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

toQuery :: DescribeImage -> QueryString

AWSRequest DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Associated Types

type AWSResponse DescribeImage

Methods

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

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

Generic DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Associated Types

type Rep DescribeImage :: Type -> Type

Methods

from :: DescribeImage -> Rep DescribeImage x

to :: Rep DescribeImage x -> DescribeImage

Read DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

readsPrec :: Int -> ReadS DescribeImage

readList :: ReadS [DescribeImage]

readPrec :: ReadPrec DescribeImage

readListPrec :: ReadPrec [DescribeImage]

Show DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

showsPrec :: Int -> DescribeImage -> ShowS

show :: DescribeImage -> String

showList :: [DescribeImage] -> ShowS

NFData DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

rnf :: DescribeImage -> ()

Eq DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

(==) :: DescribeImage -> DescribeImage -> Bool

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

Hashable DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

Methods

hashWithSalt :: Int -> DescribeImage -> Int

hash :: DescribeImage -> Int

type AWSResponse DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

type AWSResponse DescribeImage = DescribeImageResponse

type Rep DescribeImage

Defined in Amazonka.SageMaker.DescribeImage

type Rep DescribeImage = D1 ('MetaData "DescribeImage" "Amazonka.SageMaker.DescribeImage" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeImage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeImage

Arguments

:: Text

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:

DescribeImage, describeImage_imageName - The name of the image to describe.

Request Lenses

describeImage_imageName :: Lens' DescribeImage Text

The name of the image to describe.

Destructuring the Response

data DescribeImageResponse

See: newDescribeImageResponse smart constructor.

Constructors

DescribeImageResponse'

Fields

• creationTime :: Maybe POSIX

  When the image was created.

• description :: Maybe Text

  The description of the image.

• displayName :: Maybe Text

  The name of the image as displayed.

• failureReason :: Maybe Text

  When a create, update, or delete operation fails, the reason for the failure.

• imageArn :: Maybe Text

  The ARN of the image.

• imageName :: Maybe Text

  The name of the image.

• imageStatus :: Maybe ImageStatus

  The status of the image.

• lastModifiedTime :: Maybe POSIX

  When the image was last modified.

• roleArn :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeImageResponse

Defined in Amazonka.SageMaker.DescribeImage

Associated Types

type Rep DescribeImageResponse :: Type -> Type

Methods

from :: DescribeImageResponse -> Rep DescribeImageResponse x

to :: Rep DescribeImageResponse x -> DescribeImageResponse

Read DescribeImageResponse

Defined in Amazonka.SageMaker.DescribeImage

Methods

readsPrec :: Int -> ReadS DescribeImageResponse

readList :: ReadS [DescribeImageResponse]

readPrec :: ReadPrec DescribeImageResponse

readListPrec :: ReadPrec [DescribeImageResponse]

Show DescribeImageResponse

Defined in Amazonka.SageMaker.DescribeImage

Methods

showsPrec :: Int -> DescribeImageResponse -> ShowS

show :: DescribeImageResponse -> String

showList :: [DescribeImageResponse] -> ShowS

NFData DescribeImageResponse

Defined in Amazonka.SageMaker.DescribeImage

Methods

rnf :: DescribeImageResponse -> ()

Eq DescribeImageResponse

Defined in Amazonka.SageMaker.DescribeImage

Methods

(==) :: DescribeImageResponse -> DescribeImageResponse -> Bool

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

type Rep DescribeImageResponse

Defined in Amazonka.SageMaker.DescribeImage

type Rep DescribeImageResponse = D1 ('MetaData "DescribeImageResponse" "Amazonka.SageMaker.DescribeImage" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeImageResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "imageName") '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 "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeImageResponse

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:

DescribeImageResponse, describeImageResponse_creationTime - When the image was created.

DescribeImageResponse, describeImageResponse_description - The description of the image.

DescribeImageResponse, describeImageResponse_displayName - The name of the image as displayed.

DescribeImageResponse, describeImageResponse_failureReason - When a create, update, or delete operation fails, the reason for the failure.

DescribeImageResponse, describeImageResponse_imageArn - The ARN of the image.

DescribeImage, describeImageResponse_imageName - The name of the image.

DescribeImageResponse, describeImageResponse_imageStatus - The status of the image.

DescribeImageResponse, describeImageResponse_lastModifiedTime - When the image was last modified.

DescribeImageResponse, describeImageResponse_roleArn - The 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.

Response Lenses

describeImageResponse_creationTime :: Lens' DescribeImageResponse (Maybe UTCTime)

When the image was created.

describeImageResponse_description :: Lens' DescribeImageResponse (Maybe Text)

The description of the image.

describeImageResponse_displayName :: Lens' DescribeImageResponse (Maybe Text)

The name of the image as displayed.

describeImageResponse_failureReason :: Lens' DescribeImageResponse (Maybe Text)

When a create, update, or delete operation fails, the reason for the failure.

describeImageResponse_imageArn :: Lens' DescribeImageResponse (Maybe Text)

The ARN of the image.

describeImageResponse_imageName :: Lens' DescribeImageResponse (Maybe Text)

The name of the image.

describeImageResponse_imageStatus :: Lens' DescribeImageResponse (Maybe ImageStatus)

The status of the image.

describeImageResponse_lastModifiedTime :: Lens' DescribeImageResponse (Maybe UTCTime)

When the image was last modified.

describeImageResponse_roleArn :: Lens' DescribeImageResponse (Maybe Text)

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

describeImageResponse_httpStatus :: Lens' DescribeImageResponse Int

The response's http status code.