Struct aws_sdk_kms::input::ListGrantsInput

#[non_exhaustive]
pub struct ListGrantsInput {
    pub limit: Option<i32>,
    pub marker: Option<String>,
    pub key_id: Option<String>,
    pub grant_id: Option<String>,
    pub grantee_principal: 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.

limit: Option<i32>

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

marker: Option<String>

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

key_id: Option<String>

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

grant_id: Option<String>

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

grantee_principal: Option<String>

Returns only grants where the specified principal is the grantee principal for the grant.

Implementations

impl ListGrantsInput

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

Consumes the builder and constructs an Operation<ListGrants>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListGrantsInput

impl ListGrantsInput

pub fn limit(&self) -> Option<i32>

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

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

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

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

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

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

Returns only grants where the specified principal is the grantee principal for the grant.

Trait Implementations

impl Clone for ListGrantsInput

fn clone(&self) -> ListGrantsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListGrantsInput

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

Formats the value using the given formatter.

impl PartialEq<ListGrantsInput> for ListGrantsInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for ListGrantsInput