Struct aws_sdk_kms::operation::retire_grant::builders::RetireGrantFluentBuilder

pub struct RetireGrantFluentBuilder { /* private fields */ }

Fluent builder constructing a request to RetireGrant.

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To identify the grant to retire, use a grant token, or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation returns both values.

This operation can be called by the retiring principal for a grant, by the grantee principal if the grant allows the RetireGrant operation, and by the Amazon Web Services account in which the grant is created. It can also be called by principals to whom permission for retiring a grant is delegated. For details, see Retiring and revoking grants in the Key Management Service Developer Guide.

For detailed information about grants, including grant terminology, see Grants in KMS in the Key Management Service Developer Guide . For examples of working with grants in several programming languages, see Programming grants.

Cross-account use: Yes. You can retire a grant on a KMS key in a different Amazon Web Services account.

Required permissions: Permission to retire a grant is determined primarily by the grant. For details, see Retiring and revoking grants in the Key Management Service Developer Guide.

Related operations:

• CreateGrant

• ListGrants

• ListRetirableGrants

• RevokeGrant

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Implementations

impl RetireGrantFluentBuilder

pub fn as_input(&self) -> &RetireGrantInputBuilder

Access the RetireGrant as a reference.

pub async fn send( self ) -> Result<RetireGrantOutput, SdkError<RetireGrantError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<RetireGrantOutput, RetireGrantError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn grant_token(self, input: impl Into<String>) -> Self

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

pub fn set_grant_token(self, input: Option<String>) -> Self

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

pub fn get_grant_token(&self) -> &Option<String>

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

pub fn key_id(self, input: impl Into<String>) -> Self

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

pub fn set_key_id(self, input: Option<String>) -> Self

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

pub fn get_key_id(&self) -> &Option<String>

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

pub fn grant_id(self, input: impl Into<String>) -> Self

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

pub fn set_grant_id(self, input: Option<String>) -> Self

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

pub fn get_grant_id(&self) -> &Option<String>

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

pub fn dry_run(self, input: bool) -> Self

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

pub fn set_dry_run(self, input: Option<bool>) -> Self

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

pub fn get_dry_run(&self) -> &Option<bool>

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

Trait Implementations

impl Clone for RetireGrantFluentBuilder

fn clone(&self) -> RetireGrantFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetireGrantFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.