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.ServiceCatalog.TerminateProvisionedProduct

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

You can check the status of this request using DescribeRecord.

Synopsis

Creating a Request

data TerminateProvisionedProduct Source #

See: newTerminateProvisionedProduct smart constructor.

Constructors

TerminateProvisionedProduct'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
ignoreErrors :: Maybe Bool
If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.
provisionedProductId :: Maybe Text
The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.
provisionedProductName :: Maybe Text
The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.
retainPhysicalResources :: Maybe Bool
When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.
terminateToken :: Text
An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

Instances

Instances details

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

newTerminateProvisionedProduct Source #

Arguments

:: Text	`$sel:terminateToken:TerminateProvisionedProduct'`
-> TerminateProvisionedProduct

Create a value of TerminateProvisionedProduct 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:acceptLanguage:TerminateProvisionedProduct', terminateProvisionedProduct_acceptLanguage - The language code.

en - English (default)
jp - Japanese
zh - Chinese

$sel:ignoreErrors:TerminateProvisionedProduct', terminateProvisionedProduct_ignoreErrors - If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

TerminateProvisionedProduct, terminateProvisionedProduct_provisionedProductId - The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

TerminateProvisionedProduct, terminateProvisionedProduct_provisionedProductName - The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

$sel:retainPhysicalResources:TerminateProvisionedProduct', terminateProvisionedProduct_retainPhysicalResources - When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

$sel:terminateToken:TerminateProvisionedProduct', terminateProvisionedProduct_terminateToken - An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

Request Lenses

terminateProvisionedProduct_acceptLanguage :: Lens' TerminateProvisionedProduct (Maybe Text) Source #

The language code.

en - English (default)
jp - Japanese
zh - Chinese

terminateProvisionedProduct_ignoreErrors :: Lens' TerminateProvisionedProduct (Maybe Bool) Source #

If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

terminateProvisionedProduct_provisionedProductId :: Lens' TerminateProvisionedProduct (Maybe Text) Source #

The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

terminateProvisionedProduct_provisionedProductName :: Lens' TerminateProvisionedProduct (Maybe Text) Source #

The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

terminateProvisionedProduct_retainPhysicalResources :: Lens' TerminateProvisionedProduct (Maybe Bool) Source #

When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

terminateProvisionedProduct_terminateToken :: Lens' TerminateProvisionedProduct Text Source #

An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

Destructuring the Response

data TerminateProvisionedProductResponse Source #

See: newTerminateProvisionedProductResponse smart constructor.

Constructors

TerminateProvisionedProductResponse'
Fields recordDetail :: Maybe RecordDetail Information about the result of this request. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newTerminateProvisionedProductResponse Source #

Arguments

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

Create a value of TerminateProvisionedProductResponse 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:recordDetail:TerminateProvisionedProductResponse', terminateProvisionedProductResponse_recordDetail - Information about the result of this request.

$sel:httpStatus:TerminateProvisionedProductResponse', terminateProvisionedProductResponse_httpStatus - The response's http status code.

Response Lenses

terminateProvisionedProductResponse_recordDetail :: Lens' TerminateProvisionedProductResponse (Maybe RecordDetail) Source #

Information about the result of this request.

terminateProvisionedProductResponse_httpStatus :: Lens' TerminateProvisionedProductResponse Int Source #

The response's http status code.