aws_sdk_paymentcryptography/client/list_keys.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListKeys`](crate::operation::list_keys::builders::ListKeysFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_keys::builders::ListKeysFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`key_state(KeyState)`](crate::operation::list_keys::builders::ListKeysFluentBuilder::key_state) / [`set_key_state(Option<KeyState>)`](crate::operation::list_keys::builders::ListKeysFluentBuilder::set_key_state):<br>required: **false**<br><p>The key state of the keys you want to list.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_keys::builders::ListKeysFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_keys::builders::ListKeysFluentBuilder::set_next_token):<br>required: **false**<br><p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_keys::builders::ListKeysFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_keys::builders::ListKeysFluentBuilder::set_max_results):<br>required: **false**<br><p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p> <p>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.</p><br>
10 /// - On success, responds with [`ListKeysOutput`](crate::operation::list_keys::ListKeysOutput) with field(s):
11 /// - [`keys(Vec::<KeySummary>)`](crate::operation::list_keys::ListKeysOutput::keys): <p>The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_keys::ListKeysOutput::next_token): <p>The token for the next set of results, or an empty or null value if there are no more results.</p>
13 /// - On failure, responds with [`SdkError<ListKeysError>`](crate::operation::list_keys::ListKeysError)
14 pub fn list_keys(&self) -> crate::operation::list_keys::builders::ListKeysFluentBuilder {
15 crate::operation::list_keys::builders::ListKeysFluentBuilder::new(self.handle.clone())
16 }
17}