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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a version of a SageMaker image.

Synopsis

data DescribeImageVersion = DescribeImageVersion' {
- alias :: Maybe Text
- version :: Maybe Natural
- imageName :: Text
}
newDescribeImageVersion :: Text -> DescribeImageVersion
describeImageVersion_alias :: Lens' DescribeImageVersion (Maybe Text)
describeImageVersion_version :: Lens' DescribeImageVersion (Maybe Natural)
describeImageVersion_imageName :: Lens' DescribeImageVersion Text
data DescribeImageVersionResponse = DescribeImageVersionResponse' {
- baseImage :: Maybe Text
- containerImage :: Maybe Text
- creationTime :: Maybe POSIX
- failureReason :: Maybe Text
- horovod :: Maybe Bool
- imageArn :: Maybe Text
- imageVersionArn :: Maybe Text
- imageVersionStatus :: Maybe ImageVersionStatus
- jobType :: Maybe JobType
- lastModifiedTime :: Maybe POSIX
- mLFramework :: Maybe Text
- processor :: Maybe Processor
- programmingLang :: Maybe Text
- releaseNotes :: Maybe Text
- vendorGuidance :: Maybe VendorGuidance
- version :: Maybe Natural
- httpStatus :: Int
}
newDescribeImageVersionResponse :: Int -> DescribeImageVersionResponse
describeImageVersionResponse_baseImage :: Lens' DescribeImageVersionResponse (Maybe Text)
describeImageVersionResponse_containerImage :: Lens' DescribeImageVersionResponse (Maybe Text)
describeImageVersionResponse_creationTime :: Lens' DescribeImageVersionResponse (Maybe UTCTime)
describeImageVersionResponse_failureReason :: Lens' DescribeImageVersionResponse (Maybe Text)
describeImageVersionResponse_horovod :: Lens' DescribeImageVersionResponse (Maybe Bool)
describeImageVersionResponse_imageArn :: Lens' DescribeImageVersionResponse (Maybe Text)
describeImageVersionResponse_imageVersionArn :: Lens' DescribeImageVersionResponse (Maybe Text)
describeImageVersionResponse_imageVersionStatus :: Lens' DescribeImageVersionResponse (Maybe ImageVersionStatus)
describeImageVersionResponse_jobType :: Lens' DescribeImageVersionResponse (Maybe JobType)
describeImageVersionResponse_lastModifiedTime :: Lens' DescribeImageVersionResponse (Maybe UTCTime)
describeImageVersionResponse_mLFramework :: Lens' DescribeImageVersionResponse (Maybe Text)
describeImageVersionResponse_processor :: Lens' DescribeImageVersionResponse (Maybe Processor)
describeImageVersionResponse_programmingLang :: Lens' DescribeImageVersionResponse (Maybe Text)
describeImageVersionResponse_releaseNotes :: Lens' DescribeImageVersionResponse (Maybe Text)
describeImageVersionResponse_vendorGuidance :: Lens' DescribeImageVersionResponse (Maybe VendorGuidance)
describeImageVersionResponse_version :: Lens' DescribeImageVersionResponse (Maybe Natural)
describeImageVersionResponse_httpStatus :: Lens' DescribeImageVersionResponse Int

Creating a Request

data DescribeImageVersion Source #

See: newDescribeImageVersion smart constructor.

Constructors

DescribeImageVersion'
Fields alias :: Maybe Text The alias of the image version. version :: Maybe Natural The version of the image. If not specified, the latest version is described. imageName :: Text The name of the image.

Instances

Instances details

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

newDescribeImageVersion Source #

Arguments

:: Text	`DescribeImageVersion`
-> DescribeImageVersion

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

DescribeImageVersion, describeImageVersion_version - The version of the image. If not specified, the latest version is described.

DescribeImageVersion, describeImageVersion_imageName - The name of the image.

Request Lenses

describeImageVersion_alias :: Lens' DescribeImageVersion (Maybe Text) Source #

The alias of the image version.

describeImageVersion_version :: Lens' DescribeImageVersion (Maybe Natural) Source #

The version of the image. If not specified, the latest version is described.

describeImageVersion_imageName :: Lens' DescribeImageVersion Text Source #

The name of the image.

Destructuring the Response

data DescribeImageVersionResponse Source #

See: newDescribeImageVersionResponse smart constructor.

Constructors

DescribeImageVersionResponse'

Fields

baseImage :: Maybe Text
The registry path of the container image on which this image version is based.
containerImage :: Maybe Text
The registry path of the container image that contains this image version.
creationTime :: Maybe POSIX
When the version was created.
failureReason :: Maybe Text
When a create or delete operation fails, the reason for the failure.
horovod :: Maybe Bool
Indicates Horovod compatibility.
imageArn :: Maybe Text
The ARN of the image the version is based on.
imageVersionArn :: Maybe Text
The ARN of the version.
imageVersionStatus :: Maybe ImageVersionStatus
The status of the version.
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.
lastModifiedTime :: Maybe POSIX
When the version was last modified.
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 stability 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 number.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeImageVersionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImageVersion Associated Types type Rep DescribeImageVersionResponse :: Type -> Type # Methods from :: DescribeImageVersionResponse -> Rep DescribeImageVersionResponse x # to :: Rep DescribeImageVersionResponse x -> DescribeImageVersionResponse #
Read DescribeImageVersionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImageVersion Methods readsPrec :: Int -> ReadS DescribeImageVersionResponse # readList :: ReadS [DescribeImageVersionResponse] # readPrec :: ReadPrec DescribeImageVersionResponse # readListPrec :: ReadPrec [DescribeImageVersionResponse] #
Show DescribeImageVersionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImageVersion Methods showsPrec :: Int -> DescribeImageVersionResponse -> ShowS # show :: DescribeImageVersionResponse -> String # showList :: [DescribeImageVersionResponse] -> ShowS #
NFData DescribeImageVersionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImageVersion Methods rnf :: DescribeImageVersionResponse -> () #
Eq DescribeImageVersionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImageVersion Methods (==) :: DescribeImageVersionResponse -> DescribeImageVersionResponse -> Bool # (/=) :: DescribeImageVersionResponse -> DescribeImageVersionResponse -> Bool #
type Rep DescribeImageVersionResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeImageVersion type Rep DescribeImageVersionResponse = D1 ('MetaData "DescribeImageVersionResponse" "Amazonka.SageMaker.DescribeImageVersion" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribeImageVersionResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "baseImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "containerImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "horovod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "imageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "imageVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "imageVersionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageVersionStatus))))) :: (((S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobType)) :: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeImageVersionResponse Source #

Arguments

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

Create a value of DescribeImageVersionResponse 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:baseImage:DescribeImageVersionResponse', describeImageVersionResponse_baseImage - The registry path of the container image on which this image version is based.

$sel:containerImage:DescribeImageVersionResponse', describeImageVersionResponse_containerImage - The registry path of the container image that contains this image version.

DescribeImageVersionResponse, describeImageVersionResponse_creationTime - When the version was created.

DescribeImageVersionResponse, describeImageVersionResponse_failureReason - When a create or delete operation fails, the reason for the failure.

$sel:horovod:DescribeImageVersionResponse', describeImageVersionResponse_horovod - Indicates Horovod compatibility.

DescribeImageVersionResponse, describeImageVersionResponse_imageArn - The ARN of the image the version is based on.

DescribeImageVersionResponse, describeImageVersionResponse_imageVersionArn - The ARN of the version.

DescribeImageVersionResponse, describeImageVersionResponse_imageVersionStatus - The status of the version.

DescribeImageVersionResponse, describeImageVersionResponse_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.

DescribeImageVersionResponse, describeImageVersionResponse_lastModifiedTime - When the version was last modified.

$sel:mLFramework:DescribeImageVersionResponse', describeImageVersionResponse_mLFramework - The machine learning framework vended in the image version.

$sel:processor:DescribeImageVersionResponse', describeImageVersionResponse_processor - Indicates CPU or GPU compatibility.

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

$sel:programmingLang:DescribeImageVersionResponse', describeImageVersionResponse_programmingLang - The supported programming language and its version.

$sel:releaseNotes:DescribeImageVersionResponse', describeImageVersionResponse_releaseNotes - The maintainer description of the image version.

$sel:vendorGuidance:DescribeImageVersionResponse', describeImageVersionResponse_vendorGuidance - The stability 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.

DescribeImageVersion, describeImageVersionResponse_version - The version number.

$sel:httpStatus:DescribeImageVersionResponse', describeImageVersionResponse_httpStatus - The response's http status code.

Response Lenses

describeImageVersionResponse_baseImage :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The registry path of the container image on which this image version is based.

describeImageVersionResponse_containerImage :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The registry path of the container image that contains this image version.

describeImageVersionResponse_creationTime :: Lens' DescribeImageVersionResponse (Maybe UTCTime) Source #

When the version was created.

describeImageVersionResponse_failureReason :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

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

describeImageVersionResponse_horovod :: Lens' DescribeImageVersionResponse (Maybe Bool) Source #

Indicates Horovod compatibility.

describeImageVersionResponse_imageArn :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The ARN of the image the version is based on.

describeImageVersionResponse_imageVersionArn :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The ARN of the version.

describeImageVersionResponse_imageVersionStatus :: Lens' DescribeImageVersionResponse (Maybe ImageVersionStatus) Source #

The status of the version.

describeImageVersionResponse_jobType :: Lens' DescribeImageVersionResponse (Maybe JobType) Source #

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.

describeImageVersionResponse_lastModifiedTime :: Lens' DescribeImageVersionResponse (Maybe UTCTime) Source #

When the version was last modified.

describeImageVersionResponse_mLFramework :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The machine learning framework vended in the image version.

describeImageVersionResponse_processor :: Lens' DescribeImageVersionResponse (Maybe Processor) Source #

Indicates CPU or GPU compatibility.

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

describeImageVersionResponse_programmingLang :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The supported programming language and its version.

describeImageVersionResponse_releaseNotes :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The maintainer description of the image version.

describeImageVersionResponse_vendorGuidance :: Lens' DescribeImageVersionResponse (Maybe VendorGuidance) Source #

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

describeImageVersionResponse_version :: Lens' DescribeImageVersionResponse (Maybe Natural) Source #

The version number.

describeImageVersionResponse_httpStatus :: Lens' DescribeImageVersionResponse Int Source #

The response's http status code.