Struct aws_sdk_kms::input::RetireGrantInput

#[non_exhaustive]
pub struct RetireGrantInput {
    pub grant_token: Option<String>,
    pub key_id: Option<String>,
    pub grant_id: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

grant_token: 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.

key_id: 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

grant_id: Option<String>

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

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Implementations

impl RetireGrantInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<RetireGrant, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<RetireGrant>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RetireGrantInput

impl RetireGrantInput

pub fn grant_token(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Trait Implementations

impl Clone for RetireGrantInput

fn clone(&self) -> RetireGrantInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetireGrantInput

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

Formats the value using the given formatter.

impl PartialEq<RetireGrantInput> for RetireGrantInput

fn eq(&self, other: &RetireGrantInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RetireGrantInput) -> bool

This method tests for !=.

impl StructuralPartialEq for RetireGrantInput