Struct aws_sdk_kms::client::fluent_builders::ListKeyPolicies

pub struct ListKeyPolicies { /* private fields */ }

Fluent builder constructing a request to ListKeyPolicies.

Gets the names of the key policies that are attached to a KMS key. This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ListKeyPolicies (key policy)

Related operations:

• GetKeyPolicy

• PutKeyPolicy

Implementations

impl ListKeyPolicies

pub async fn send(
    self
) -> Result<ListKeyPoliciesOutput, SdkError<ListKeyPoliciesError>>

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 into_paginator(self) -> ListKeyPoliciesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

Gets the names of key policies for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

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 set_key_id(self, input: Option<String>) -> Self

Gets the names of key policies for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

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 limit(self, input: i32) -> Self

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 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

pub fn set_limit(self, input: Option<i32>) -> Self

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 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

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

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 set_marker(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for ListKeyPolicies

fn clone(&self) -> ListKeyPolicies

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListKeyPolicies

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

Formats the value using the given formatter.