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.ImageBuilder.UpdateImagePipeline
Description
Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.
UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.
Synopsis
- data UpdateImagePipeline = UpdateImagePipeline' {
- status :: Maybe PipelineStatus
- containerRecipeArn :: Maybe Text
- imageTestsConfiguration :: Maybe ImageTestsConfiguration
- schedule :: Maybe Schedule
- enhancedImageMetadataEnabled :: Maybe Bool
- distributionConfigurationArn :: Maybe Text
- imageRecipeArn :: Maybe Text
- description :: Maybe Text
- imagePipelineArn :: Text
- infrastructureConfigurationArn :: Text
- clientToken :: Text
- newUpdateImagePipeline :: Text -> Text -> Text -> UpdateImagePipeline
- updateImagePipeline_status :: Lens' UpdateImagePipeline (Maybe PipelineStatus)
- updateImagePipeline_containerRecipeArn :: Lens' UpdateImagePipeline (Maybe Text)
- updateImagePipeline_imageTestsConfiguration :: Lens' UpdateImagePipeline (Maybe ImageTestsConfiguration)
- updateImagePipeline_schedule :: Lens' UpdateImagePipeline (Maybe Schedule)
- updateImagePipeline_enhancedImageMetadataEnabled :: Lens' UpdateImagePipeline (Maybe Bool)
- updateImagePipeline_distributionConfigurationArn :: Lens' UpdateImagePipeline (Maybe Text)
- updateImagePipeline_imageRecipeArn :: Lens' UpdateImagePipeline (Maybe Text)
- updateImagePipeline_description :: Lens' UpdateImagePipeline (Maybe Text)
- updateImagePipeline_imagePipelineArn :: Lens' UpdateImagePipeline Text
- updateImagePipeline_infrastructureConfigurationArn :: Lens' UpdateImagePipeline Text
- updateImagePipeline_clientToken :: Lens' UpdateImagePipeline Text
- data UpdateImagePipelineResponse = UpdateImagePipelineResponse' {
- requestId :: Maybe Text
- clientToken :: Maybe Text
- imagePipelineArn :: Maybe Text
- httpStatus :: Int
- newUpdateImagePipelineResponse :: Int -> UpdateImagePipelineResponse
- updateImagePipelineResponse_requestId :: Lens' UpdateImagePipelineResponse (Maybe Text)
- updateImagePipelineResponse_clientToken :: Lens' UpdateImagePipelineResponse (Maybe Text)
- updateImagePipelineResponse_imagePipelineArn :: Lens' UpdateImagePipelineResponse (Maybe Text)
- updateImagePipelineResponse_httpStatus :: Lens' UpdateImagePipelineResponse Int
Creating a Request
data UpdateImagePipeline Source #
See: newUpdateImagePipeline
smart constructor.
Constructors
UpdateImagePipeline' | |
Fields
|
Instances
newUpdateImagePipeline Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> UpdateImagePipeline |
Create a value of UpdateImagePipeline
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:status:UpdateImagePipeline'
, updateImagePipeline_status
- The status of the image pipeline.
$sel:containerRecipeArn:UpdateImagePipeline'
, updateImagePipeline_containerRecipeArn
- The Amazon Resource Name (ARN) of the container pipeline to update.
$sel:imageTestsConfiguration:UpdateImagePipeline'
, updateImagePipeline_imageTestsConfiguration
- The image test configuration of the image pipeline.
$sel:schedule:UpdateImagePipeline'
, updateImagePipeline_schedule
- The schedule of the image pipeline.
$sel:enhancedImageMetadataEnabled:UpdateImagePipeline'
, updateImagePipeline_enhancedImageMetadataEnabled
- Collects additional information about the image being created, including
the operating system (OS) version and package list. This information is
used to enhance the overall experience of using EC2 Image Builder.
Enabled by default.
$sel:distributionConfigurationArn:UpdateImagePipeline'
, updateImagePipeline_distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that
will be used to configure and distribute images updated by this image
pipeline.
$sel:imageRecipeArn:UpdateImagePipeline'
, updateImagePipeline_imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that will be used to
configure images updated by this image pipeline.
$sel:description:UpdateImagePipeline'
, updateImagePipeline_description
- The description of the image pipeline.
$sel:imagePipelineArn:UpdateImagePipeline'
, updateImagePipeline_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that you want to
update.
$sel:infrastructureConfigurationArn:UpdateImagePipeline'
, updateImagePipeline_infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that
will be used to build images updated by this image pipeline.
$sel:clientToken:UpdateImagePipeline'
, updateImagePipeline_clientToken
- The idempotency token used to make this request idempotent.
Request Lenses
updateImagePipeline_status :: Lens' UpdateImagePipeline (Maybe PipelineStatus) Source #
The status of the image pipeline.
updateImagePipeline_containerRecipeArn :: Lens' UpdateImagePipeline (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container pipeline to update.
updateImagePipeline_imageTestsConfiguration :: Lens' UpdateImagePipeline (Maybe ImageTestsConfiguration) Source #
The image test configuration of the image pipeline.
updateImagePipeline_schedule :: Lens' UpdateImagePipeline (Maybe Schedule) Source #
The schedule of the image pipeline.
updateImagePipeline_enhancedImageMetadataEnabled :: Lens' UpdateImagePipeline (Maybe Bool) Source #
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
updateImagePipeline_distributionConfigurationArn :: Lens' UpdateImagePipeline (Maybe Text) Source #
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.
updateImagePipeline_imageRecipeArn :: Lens' UpdateImagePipeline (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
updateImagePipeline_description :: Lens' UpdateImagePipeline (Maybe Text) Source #
The description of the image pipeline.
updateImagePipeline_imagePipelineArn :: Lens' UpdateImagePipeline Text Source #
The Amazon Resource Name (ARN) of the image pipeline that you want to update.
updateImagePipeline_infrastructureConfigurationArn :: Lens' UpdateImagePipeline Text Source #
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
updateImagePipeline_clientToken :: Lens' UpdateImagePipeline Text Source #
The idempotency token used to make this request idempotent.
Destructuring the Response
data UpdateImagePipelineResponse Source #
See: newUpdateImagePipelineResponse
smart constructor.
Constructors
UpdateImagePipelineResponse' | |
Fields
|
Instances
newUpdateImagePipelineResponse Source #
Create a value of UpdateImagePipelineResponse
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:requestId:UpdateImagePipelineResponse'
, updateImagePipelineResponse_requestId
- The request ID that uniquely identifies this request.
$sel:clientToken:UpdateImagePipeline'
, updateImagePipelineResponse_clientToken
- The idempotency token used to make this request idempotent.
$sel:imagePipelineArn:UpdateImagePipeline'
, updateImagePipelineResponse_imagePipelineArn
- The Amazon Resource Name (ARN) of the image pipeline that was updated by
this request.
$sel:httpStatus:UpdateImagePipelineResponse'
, updateImagePipelineResponse_httpStatus
- The response's http status code.
Response Lenses
updateImagePipelineResponse_requestId :: Lens' UpdateImagePipelineResponse (Maybe Text) Source #
The request ID that uniquely identifies this request.
updateImagePipelineResponse_clientToken :: Lens' UpdateImagePipelineResponse (Maybe Text) Source #
The idempotency token used to make this request idempotent.
updateImagePipelineResponse_imagePipelineArn :: Lens' UpdateImagePipelineResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
updateImagePipelineResponse_httpStatus :: Lens' UpdateImagePipelineResponse Int Source #
The response's http status code.