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.ImageBuilder.UpdateImagePipeline

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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' {
- containerRecipeArn :: Maybe Text
- description :: Maybe Text
- distributionConfigurationArn :: Maybe Text
- enhancedImageMetadataEnabled :: Maybe Bool
- imageRecipeArn :: Maybe Text
- imageTestsConfiguration :: Maybe ImageTestsConfiguration
- schedule :: Maybe Schedule
- status :: Maybe PipelineStatus
- imagePipelineArn :: Text
- infrastructureConfigurationArn :: Text
- clientToken :: Text
}
newUpdateImagePipeline :: Text -> Text -> Text -> UpdateImagePipeline
updateImagePipeline_containerRecipeArn :: Lens' UpdateImagePipeline (Maybe Text)
updateImagePipeline_description :: Lens' UpdateImagePipeline (Maybe Text)
updateImagePipeline_distributionConfigurationArn :: Lens' UpdateImagePipeline (Maybe Text)
updateImagePipeline_enhancedImageMetadataEnabled :: Lens' UpdateImagePipeline (Maybe Bool)
updateImagePipeline_imageRecipeArn :: Lens' UpdateImagePipeline (Maybe Text)
updateImagePipeline_imageTestsConfiguration :: Lens' UpdateImagePipeline (Maybe ImageTestsConfiguration)
updateImagePipeline_schedule :: Lens' UpdateImagePipeline (Maybe Schedule)
updateImagePipeline_status :: Lens' UpdateImagePipeline (Maybe PipelineStatus)
updateImagePipeline_imagePipelineArn :: Lens' UpdateImagePipeline Text
updateImagePipeline_infrastructureConfigurationArn :: Lens' UpdateImagePipeline Text
updateImagePipeline_clientToken :: Lens' UpdateImagePipeline Text
data UpdateImagePipelineResponse = UpdateImagePipelineResponse' {
- clientToken :: Maybe Text
- imagePipelineArn :: Maybe Text
- requestId :: Maybe Text
- httpStatus :: Int
}
newUpdateImagePipelineResponse :: Int -> UpdateImagePipelineResponse
updateImagePipelineResponse_clientToken :: Lens' UpdateImagePipelineResponse (Maybe Text)
updateImagePipelineResponse_imagePipelineArn :: Lens' UpdateImagePipelineResponse (Maybe Text)
updateImagePipelineResponse_requestId :: Lens' UpdateImagePipelineResponse (Maybe Text)
updateImagePipelineResponse_httpStatus :: Lens' UpdateImagePipelineResponse Int

Creating a Request

data UpdateImagePipeline Source #

See: newUpdateImagePipeline smart constructor.

Constructors

UpdateImagePipeline'

Fields

containerRecipeArn :: Maybe Text
The Amazon Resource Name (ARN) of the container pipeline to update.
description :: Maybe Text
The description of the image pipeline.
distributionConfigurationArn :: Maybe Text
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.
enhancedImageMetadataEnabled :: Maybe Bool
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.
imageRecipeArn :: Maybe Text
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
imageTestsConfiguration :: Maybe ImageTestsConfiguration
The image test configuration of the image pipeline.
schedule :: Maybe Schedule
The schedule of the image pipeline.
status :: Maybe PipelineStatus
The status of the image pipeline.
imagePipelineArn :: Text
The Amazon Resource Name (ARN) of the image pipeline that you want to update.
infrastructureConfigurationArn :: Text
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
clientToken :: Text
The idempotency token used to make this request idempotent.

Instances

Instances details

ToJSON UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods toJSON :: UpdateImagePipeline -> Value # toEncoding :: UpdateImagePipeline -> Encoding # toJSONList :: [UpdateImagePipeline] -> Value # toEncodingList :: [UpdateImagePipeline] -> Encoding #
ToHeaders UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods toHeaders :: UpdateImagePipeline -> [Header] #
ToPath UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods toPath :: UpdateImagePipeline -> ByteString #
ToQuery UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods toQuery :: UpdateImagePipeline -> QueryString #
AWSRequest UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Associated Types type AWSResponse UpdateImagePipeline # Methods request :: (Service -> Service) -> UpdateImagePipeline -> Request UpdateImagePipeline # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateImagePipeline -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateImagePipeline))) #
Generic UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Associated Types type Rep UpdateImagePipeline :: Type -> Type # Methods from :: UpdateImagePipeline -> Rep UpdateImagePipeline x # to :: Rep UpdateImagePipeline x -> UpdateImagePipeline #
Read UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods readsPrec :: Int -> ReadS UpdateImagePipeline # readList :: ReadS [UpdateImagePipeline] # readPrec :: ReadPrec UpdateImagePipeline # readListPrec :: ReadPrec [UpdateImagePipeline] #
Show UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods showsPrec :: Int -> UpdateImagePipeline -> ShowS # show :: UpdateImagePipeline -> String # showList :: [UpdateImagePipeline] -> ShowS #
NFData UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods rnf :: UpdateImagePipeline -> () #
Eq UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods (==) :: UpdateImagePipeline -> UpdateImagePipeline -> Bool # (/=) :: UpdateImagePipeline -> UpdateImagePipeline -> Bool #
Hashable UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods hashWithSalt :: Int -> UpdateImagePipeline -> Int # hash :: UpdateImagePipeline -> Int #
type AWSResponse UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline type AWSResponse UpdateImagePipeline = UpdateImagePipelineResponse
type Rep UpdateImagePipeline Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline type Rep UpdateImagePipeline = D1 ('MetaData "UpdateImagePipeline" "Amazonka.ImageBuilder.UpdateImagePipeline" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "UpdateImagePipeline'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "containerRecipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "distributionConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "enhancedImageMetadataEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "imageRecipeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "imageTestsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageTestsConfiguration)) :: (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Schedule)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineStatus)))) :: (S1 ('MetaSel ('Just "imagePipelineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "infrastructureConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateImagePipeline Source #

Arguments

:: Text	`UpdateImagePipeline`
-> Text	`UpdateImagePipeline`
-> Text	`UpdateImagePipeline`
-> 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:

UpdateImagePipeline, updateImagePipeline_containerRecipeArn - The Amazon Resource Name (ARN) of the container pipeline to update.

UpdateImagePipeline, updateImagePipeline_description - The description of the image pipeline.

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.

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.

UpdateImagePipeline, updateImagePipeline_imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

UpdateImagePipeline, updateImagePipeline_imageTestsConfiguration - The image test configuration of the image pipeline.

UpdateImagePipeline, updateImagePipeline_schedule - The schedule of the image pipeline.

UpdateImagePipeline, updateImagePipeline_status - The status of the image pipeline.

UpdateImagePipeline, updateImagePipeline_imagePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that you want to update.

UpdateImagePipeline, updateImagePipeline_infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

UpdateImagePipeline, updateImagePipeline_clientToken - The idempotency token used to make this request idempotent.

Request Lenses

updateImagePipeline_containerRecipeArn :: Lens' UpdateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container pipeline to update.

updateImagePipeline_description :: Lens' UpdateImagePipeline (Maybe Text) Source #

The description of the image pipeline.

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_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_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_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_status :: Lens' UpdateImagePipeline (Maybe PipelineStatus) Source #

The status 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 clientToken :: Maybe Text The idempotency token used to make this request idempotent. imagePipelineArn :: Maybe Text The Amazon Resource Name (ARN) of the image pipeline that was updated by this request. requestId :: Maybe Text The request ID that uniquely identifies this request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Associated Types type Rep UpdateImagePipelineResponse :: Type -> Type # Methods from :: UpdateImagePipelineResponse -> Rep UpdateImagePipelineResponse x # to :: Rep UpdateImagePipelineResponse x -> UpdateImagePipelineResponse #
Read UpdateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods readsPrec :: Int -> ReadS UpdateImagePipelineResponse # readList :: ReadS [UpdateImagePipelineResponse] # readPrec :: ReadPrec UpdateImagePipelineResponse # readListPrec :: ReadPrec [UpdateImagePipelineResponse] #
Show UpdateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods showsPrec :: Int -> UpdateImagePipelineResponse -> ShowS # show :: UpdateImagePipelineResponse -> String # showList :: [UpdateImagePipelineResponse] -> ShowS #
NFData UpdateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods rnf :: UpdateImagePipelineResponse -> () #
Eq UpdateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline Methods (==) :: UpdateImagePipelineResponse -> UpdateImagePipelineResponse -> Bool # (/=) :: UpdateImagePipelineResponse -> UpdateImagePipelineResponse -> Bool #
type Rep UpdateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.UpdateImagePipeline type Rep UpdateImagePipelineResponse = D1 ('MetaData "UpdateImagePipelineResponse" "Amazonka.ImageBuilder.UpdateImagePipeline" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "UpdateImagePipelineResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "imagePipelineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateImagePipelineResponse Source #

Arguments

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

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:

UpdateImagePipeline, updateImagePipelineResponse_clientToken - The idempotency token used to make this request idempotent.

UpdateImagePipeline, updateImagePipelineResponse_imagePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.

$sel:requestId:UpdateImagePipelineResponse', updateImagePipelineResponse_requestId - The request ID that uniquely identifies this request.

$sel:httpStatus:UpdateImagePipelineResponse', updateImagePipelineResponse_httpStatus - The response's http status code.

Response Lenses

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_requestId :: Lens' UpdateImagePipelineResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

updateImagePipelineResponse_httpStatus :: Lens' UpdateImagePipelineResponse Int Source #

The response's http status code.