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 |
Creates a version of the SageMaker image specified by ImageName
. The
version represents the Amazon Elastic Container Registry (ECR) container
image specified by BaseImage
.
Synopsis
- data CreateImageVersion = CreateImageVersion' {
- aliases :: Maybe [Text]
- horovod :: Maybe Bool
- jobType :: Maybe JobType
- mLFramework :: Maybe Text
- processor :: Maybe Processor
- programmingLang :: Maybe Text
- releaseNotes :: Maybe Text
- vendorGuidance :: Maybe VendorGuidance
- baseImage :: Text
- clientToken :: Text
- imageName :: Text
- newCreateImageVersion :: Text -> Text -> Text -> CreateImageVersion
- createImageVersion_aliases :: Lens' CreateImageVersion (Maybe [Text])
- createImageVersion_horovod :: Lens' CreateImageVersion (Maybe Bool)
- createImageVersion_jobType :: Lens' CreateImageVersion (Maybe JobType)
- createImageVersion_mLFramework :: Lens' CreateImageVersion (Maybe Text)
- createImageVersion_processor :: Lens' CreateImageVersion (Maybe Processor)
- createImageVersion_programmingLang :: Lens' CreateImageVersion (Maybe Text)
- createImageVersion_releaseNotes :: Lens' CreateImageVersion (Maybe Text)
- createImageVersion_vendorGuidance :: Lens' CreateImageVersion (Maybe VendorGuidance)
- createImageVersion_baseImage :: Lens' CreateImageVersion Text
- createImageVersion_clientToken :: Lens' CreateImageVersion Text
- createImageVersion_imageName :: Lens' CreateImageVersion Text
- data CreateImageVersionResponse = CreateImageVersionResponse' {}
- newCreateImageVersionResponse :: Int -> CreateImageVersionResponse
- createImageVersionResponse_imageVersionArn :: Lens' CreateImageVersionResponse (Maybe Text)
- createImageVersionResponse_httpStatus :: Lens' CreateImageVersionResponse Int
Creating a Request
data CreateImageVersion Source #
See: newCreateImageVersion
smart constructor.
CreateImageVersion' | |
|
Instances
newCreateImageVersion Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateImageVersion |
Create a value of CreateImageVersion
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:aliases:CreateImageVersion'
, createImageVersion_aliases
- A list of aliases created with the image version.
$sel:horovod:CreateImageVersion'
, createImageVersion_horovod
- Indicates Horovod compatibility.
CreateImageVersion
, createImageVersion_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.
$sel:mLFramework:CreateImageVersion'
, createImageVersion_mLFramework
- The machine learning framework vended in the image version.
$sel:processor:CreateImageVersion'
, createImageVersion_processor
- Indicates CPU or GPU compatibility.
CPU
: The image version is compatible with CPU.GPU
: The image version is compatible with GPU.
$sel:programmingLang:CreateImageVersion'
, createImageVersion_programmingLang
- The supported programming language and its version.
$sel:releaseNotes:CreateImageVersion'
, createImageVersion_releaseNotes
- The maintainer description of the image version.
$sel:vendorGuidance:CreateImageVersion'
, createImageVersion_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.
$sel:baseImage:CreateImageVersion'
, createImageVersion_baseImage
- The registry path of the container image to use as the starting point
for this version. The path is an Amazon Elastic Container Registry (ECR)
URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
$sel:clientToken:CreateImageVersion'
, createImageVersion_clientToken
- A unique ID. If not specified, the Amazon Web Services CLI and Amazon
Web Services SDKs, such as the SDK for Python (Boto3), add a unique
value to the call.
CreateImageVersion
, createImageVersion_imageName
- The ImageName
of the Image
to create a version of.
Request Lenses
createImageVersion_aliases :: Lens' CreateImageVersion (Maybe [Text]) Source #
A list of aliases created with the image version.
createImageVersion_horovod :: Lens' CreateImageVersion (Maybe Bool) Source #
Indicates Horovod compatibility.
createImageVersion_jobType :: Lens' CreateImageVersion (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.
createImageVersion_mLFramework :: Lens' CreateImageVersion (Maybe Text) Source #
The machine learning framework vended in the image version.
createImageVersion_processor :: Lens' CreateImageVersion (Maybe Processor) Source #
Indicates CPU or GPU compatibility.
CPU
: The image version is compatible with CPU.GPU
: The image version is compatible with GPU.
createImageVersion_programmingLang :: Lens' CreateImageVersion (Maybe Text) Source #
The supported programming language and its version.
createImageVersion_releaseNotes :: Lens' CreateImageVersion (Maybe Text) Source #
The maintainer description of the image version.
createImageVersion_vendorGuidance :: Lens' CreateImageVersion (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.
createImageVersion_baseImage :: Lens' CreateImageVersion Text Source #
The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:
<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
createImageVersion_clientToken :: Lens' CreateImageVersion Text Source #
A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
createImageVersion_imageName :: Lens' CreateImageVersion Text Source #
The ImageName
of the Image
to create a version of.
Destructuring the Response
data CreateImageVersionResponse Source #
See: newCreateImageVersionResponse
smart constructor.
CreateImageVersionResponse' | |
|
Instances
newCreateImageVersionResponse Source #
Create a value of CreateImageVersionResponse
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:
CreateImageVersionResponse
, createImageVersionResponse_imageVersionArn
- The ARN of the image version.
$sel:httpStatus:CreateImageVersionResponse'
, createImageVersionResponse_httpStatus
- The response's http status code.
Response Lenses
createImageVersionResponse_imageVersionArn :: Lens' CreateImageVersionResponse (Maybe Text) Source #
The ARN of the image version.
createImageVersionResponse_httpStatus :: Lens' CreateImageVersionResponse Int Source #
The response's http status code.