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.IoT.DeletePolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.

Requires permission to access the DeletePolicy action.

Synopsis

data DeletePolicy = DeletePolicy' {
- policyName :: Text
}
newDeletePolicy :: Text -> DeletePolicy
deletePolicy_policyName :: Lens' DeletePolicy Text
data DeletePolicyResponse = DeletePolicyResponse' {
}
newDeletePolicyResponse :: DeletePolicyResponse

Creating a Request

data DeletePolicy Source #

The input for the DeletePolicy operation.

See: newDeletePolicy smart constructor.

Constructors

DeletePolicy'
Fields policyName :: Text The name of the policy to delete.

Instances

Instances details

Eq DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods (==) :: DeletePolicy -> DeletePolicy -> Bool # (/=) :: DeletePolicy -> DeletePolicy -> Bool #
Read DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods readsPrec :: Int -> ReadS DeletePolicy # readList :: ReadS [DeletePolicy] # readPrec :: ReadPrec DeletePolicy # readListPrec :: ReadPrec [DeletePolicy] #
Show DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods showsPrec :: Int -> DeletePolicy -> ShowS # show :: DeletePolicy -> String # showList :: [DeletePolicy] -> ShowS #
Generic DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Associated Types type Rep DeletePolicy :: Type -> Type # Methods from :: DeletePolicy -> Rep DeletePolicy x # to :: Rep DeletePolicy x -> DeletePolicy #
NFData DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods rnf :: DeletePolicy -> () #
Hashable DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods hashWithSalt :: Int -> DeletePolicy -> Int # hash :: DeletePolicy -> Int #
AWSRequest DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Associated Types type AWSResponse DeletePolicy # Methods request :: DeletePolicy -> Request DeletePolicy # response :: MonadResource m => Logger -> Service -> Proxy DeletePolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeletePolicy))) #
ToHeaders DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods toHeaders :: DeletePolicy -> [Header] #
ToPath DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods toPath :: DeletePolicy -> ByteString #
ToQuery DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods toQuery :: DeletePolicy -> QueryString #
type Rep DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy type Rep DeletePolicy = D1 ('MetaData "DeletePolicy" "Amazonka.IoT.DeletePolicy" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DeletePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeletePolicy Source #
Instance details Defined in Amazonka.IoT.DeletePolicy type AWSResponse DeletePolicy = DeletePolicyResponse

newDeletePolicy Source #

Arguments

:: Text	`$sel:policyName:DeletePolicy'`
-> DeletePolicy

Create a value of DeletePolicy 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:policyName:DeletePolicy', deletePolicy_policyName - The name of the policy to delete.

Request Lenses

deletePolicy_policyName :: Lens' DeletePolicy Text Source #

The name of the policy to delete.

Destructuring the Response

data DeletePolicyResponse Source #

See: newDeletePolicyResponse smart constructor.

Constructors

DeletePolicyResponse'

Instances

Instances details

Eq DeletePolicyResponse Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods (==) :: DeletePolicyResponse -> DeletePolicyResponse -> Bool # (/=) :: DeletePolicyResponse -> DeletePolicyResponse -> Bool #
Read DeletePolicyResponse Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods readsPrec :: Int -> ReadS DeletePolicyResponse # readList :: ReadS [DeletePolicyResponse] # readPrec :: ReadPrec DeletePolicyResponse # readListPrec :: ReadPrec [DeletePolicyResponse] #
Show DeletePolicyResponse Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods showsPrec :: Int -> DeletePolicyResponse -> ShowS # show :: DeletePolicyResponse -> String # showList :: [DeletePolicyResponse] -> ShowS #
Generic DeletePolicyResponse Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Associated Types type Rep DeletePolicyResponse :: Type -> Type # Methods from :: DeletePolicyResponse -> Rep DeletePolicyResponse x # to :: Rep DeletePolicyResponse x -> DeletePolicyResponse #
NFData DeletePolicyResponse Source #
Instance details Defined in Amazonka.IoT.DeletePolicy Methods rnf :: DeletePolicyResponse -> () #
type Rep DeletePolicyResponse Source #
Instance details Defined in Amazonka.IoT.DeletePolicy type Rep DeletePolicyResponse = D1 ('MetaData "DeletePolicyResponse" "Amazonka.IoT.DeletePolicy" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DeletePolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeletePolicyResponse :: DeletePolicyResponse Source #

Create a value of DeletePolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.