Network.AWS.KMS.RetireGrant

Retires a grant. You can retire a grant when you're done using it to clean up. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

• The account that created the grant
• The RetiringPrincipal, if present
• The GranteePrincipal, if RetireGrant is a grantee operation

The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant function.

See: AWS API Reference for RetireGrant.

Creating a Request

retireGrant :: RetireGrant

Creates a value of RetireGrant with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rgKeyId
• rgGrantId
• rgGrantToken

data RetireGrant

See: retireGrant smart constructor.

Instances

Eq RetireGrant

Data RetireGrant

Read RetireGrant

Show RetireGrant

Generic RetireGrant

ToJSON RetireGrant

AWSRequest RetireGrant

ToPath RetireGrant

ToHeaders RetireGrant

ToQuery RetireGrant

Typeable * RetireGrant

type Rep RetireGrant

type Sv RetireGrant = KMS

type Rs RetireGrant = RetireGrantResponse

Request Lenses

rgKeyId :: Lens' RetireGrant (Maybe Text)

A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

rgGrantId :: Lens' RetireGrant (Maybe Text)

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

rgGrantToken :: Lens' RetireGrant (Maybe Text)

Token that identifies the grant to be retired.

Destructuring the Response

retireGrantResponse :: RetireGrantResponse

Creates a value of RetireGrantResponse with the minimum fields required to make a request.

data RetireGrantResponse

See: retireGrantResponse smart constructor.

Instances

Eq RetireGrantResponse

Data RetireGrantResponse

Read RetireGrantResponse

Show RetireGrantResponse

Generic RetireGrantResponse

Typeable * RetireGrantResponse

type Rep RetireGrantResponse