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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

Synopsis

data CancelImageCreation = CancelImageCreation' {
- imageBuildVersionArn :: Text
- clientToken :: Text
}
newCancelImageCreation :: Text -> Text -> CancelImageCreation
cancelImageCreation_imageBuildVersionArn :: Lens' CancelImageCreation Text
cancelImageCreation_clientToken :: Lens' CancelImageCreation Text
data CancelImageCreationResponse = CancelImageCreationResponse' {
- clientToken :: Maybe Text
- imageBuildVersionArn :: Maybe Text
- requestId :: Maybe Text
- httpStatus :: Int
}
newCancelImageCreationResponse :: Int -> CancelImageCreationResponse
cancelImageCreationResponse_clientToken :: Lens' CancelImageCreationResponse (Maybe Text)
cancelImageCreationResponse_imageBuildVersionArn :: Lens' CancelImageCreationResponse (Maybe Text)
cancelImageCreationResponse_requestId :: Lens' CancelImageCreationResponse (Maybe Text)
cancelImageCreationResponse_httpStatus :: Lens' CancelImageCreationResponse Int

Creating a Request

data CancelImageCreation Source #

See: newCancelImageCreation smart constructor.

Constructors

CancelImageCreation'
Fields imageBuildVersionArn :: Text The Amazon Resource Name (ARN) of the image whose creation you want to cancel. clientToken :: Text Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Instances

Instances details

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

newCancelImageCreation Source #

Arguments

:: Text	`CancelImageCreation`
-> Text	`CancelImageCreation`
-> CancelImageCreation

Create a value of CancelImageCreation 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:

CancelImageCreation, cancelImageCreation_imageBuildVersionArn - The Amazon Resource Name (ARN) of the image whose creation you want to cancel.

CancelImageCreation, cancelImageCreation_clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Request Lenses

cancelImageCreation_imageBuildVersionArn :: Lens' CancelImageCreation Text Source #

The Amazon Resource Name (ARN) of the image whose creation you want to cancel.

cancelImageCreation_clientToken :: Lens' CancelImageCreation Text Source #

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Destructuring the Response

data CancelImageCreationResponse Source #

See: newCancelImageCreationResponse smart constructor.

Constructors

CancelImageCreationResponse'
Fields clientToken :: Maybe Text The idempotency token that was used for this request. imageBuildVersionArn :: Maybe Text The Amazon Resource Name (ARN) of the image whose creation has been cancelled. requestId :: Maybe Text The request ID that uniquely identifies this request. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCancelImageCreationResponse Source #

Arguments

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

Create a value of CancelImageCreationResponse 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:

CancelImageCreation, cancelImageCreationResponse_clientToken - The idempotency token that was used for this request.

CancelImageCreation, cancelImageCreationResponse_imageBuildVersionArn - The Amazon Resource Name (ARN) of the image whose creation has been cancelled.

$sel:requestId:CancelImageCreationResponse', cancelImageCreationResponse_requestId - The request ID that uniquely identifies this request.

$sel:httpStatus:CancelImageCreationResponse', cancelImageCreationResponse_httpStatus - The response's http status code.

Response Lenses

cancelImageCreationResponse_clientToken :: Lens' CancelImageCreationResponse (Maybe Text) Source #

The idempotency token that was used for this request.

cancelImageCreationResponse_imageBuildVersionArn :: Lens' CancelImageCreationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image whose creation has been cancelled.

cancelImageCreationResponse_requestId :: Lens' CancelImageCreationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

cancelImageCreationResponse_httpStatus :: Lens' CancelImageCreationResponse Int Source #

The response's http status code.