aws_sdk_kms/operation/list_retirable_grants/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_retirable_grants::_list_retirable_grants_input::ListRetirableGrantsInputBuilder;
3
4pub use crate::operation::list_retirable_grants::_list_retirable_grants_output::ListRetirableGrantsOutputBuilder;
5
6impl crate::operation::list_retirable_grants::builders::ListRetirableGrantsInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::list_retirable_grants::ListRetirableGrantsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_retirable_grants::ListRetirableGrantsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_retirable_grants();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListRetirableGrants`.
24///
25/// <p>Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal or retiring service principal.</p>
26/// <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to determine which grants you may retire. To retire a grant, use the <code>RetireGrant</code> operation.</p>
27/// <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Grants in KMS</a> in the <i> <i>Key Management Service Developer Guide</i> </i>. For examples of creating grants in several programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/example_kms_CreateGrant_section.html">Use CreateGrant with an Amazon Web Services SDK or CLI</a>.</p>
28/// <p><b>Cross-account use</b>: You must specify a principal in your Amazon Web Services account. This operation returns a list of grants where the retiring principal specified in the <code>ListRetirableGrants</code> request is the same retiring principal on the grant. This can include grants on KMS keys owned by other Amazon Web Services accounts, but you do not need <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any Amazon Web Services account other than your own.</p>
29/// <p><b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your Amazon Web Services account.</p><note>
30/// <p>When listing retirable grants by <code>RetiringPrincipal</code>, KMS authorizes <code>ListRetirableGrants</code> requests by evaluating the caller account's kms:ListRetirableGrants permissions. The authorized resource in <code>ListRetirableGrants</code> calls is the retiring principal specified in the request. KMS does not evaluate the caller's permissions to verify their access to any KMS keys or grants that might be returned by the <code>ListRetirableGrants</code> call.</p>
31/// <p>The <code>RetiringServicePrincipal</code> filter is only usable by callers in a service principal.</p>
32/// </note>
33/// <p><b>Related operations:</b></p>
34/// <ul>
35/// <li>
36/// <p><code>CreateGrant</code></p></li>
37/// <li>
38/// <p><code>ListGrants</code></p></li>
39/// <li>
40/// <p><code>RetireGrant</code></p></li>
41/// <li>
42/// <p><code>RevokeGrant</code></p></li>
43/// </ul>
44/// <p><b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
45#[derive(::std::clone::Clone, ::std::fmt::Debug)]
46pub struct ListRetirableGrantsFluentBuilder {
47 handle: ::std::sync::Arc<crate::client::Handle>,
48 inner: crate::operation::list_retirable_grants::builders::ListRetirableGrantsInputBuilder,
49 config_override: ::std::option::Option<crate::config::Builder>,
50}
51impl
52 crate::client::customize::internal::CustomizableSend<
53 crate::operation::list_retirable_grants::ListRetirableGrantsOutput,
54 crate::operation::list_retirable_grants::ListRetirableGrantsError,
55 > for ListRetirableGrantsFluentBuilder
56{
57 fn send(
58 self,
59 config_override: crate::config::Builder,
60 ) -> crate::client::customize::internal::BoxFuture<
61 crate::client::customize::internal::SendResult<
62 crate::operation::list_retirable_grants::ListRetirableGrantsOutput,
63 crate::operation::list_retirable_grants::ListRetirableGrantsError,
64 >,
65 > {
66 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
67 }
68}
69impl ListRetirableGrantsFluentBuilder {
70 /// Creates a new `ListRetirableGrantsFluentBuilder`.
71 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
72 Self {
73 handle,
74 inner: ::std::default::Default::default(),
75 config_override: ::std::option::Option::None,
76 }
77 }
78 /// Access the ListRetirableGrants as a reference.
79 pub fn as_input(&self) -> &crate::operation::list_retirable_grants::builders::ListRetirableGrantsInputBuilder {
80 &self.inner
81 }
82 /// Sends the request and returns the response.
83 ///
84 /// If an error occurs, an `SdkError` will be returned with additional details that
85 /// can be matched against.
86 ///
87 /// By default, any retryable failures will be retried twice. Retry behavior
88 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
89 /// set when configuring the client.
90 pub async fn send(
91 self,
92 ) -> ::std::result::Result<
93 crate::operation::list_retirable_grants::ListRetirableGrantsOutput,
94 ::aws_smithy_runtime_api::client::result::SdkError<
95 crate::operation::list_retirable_grants::ListRetirableGrantsError,
96 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
97 >,
98 > {
99 let input = self
100 .inner
101 .build()
102 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
103 let runtime_plugins = crate::operation::list_retirable_grants::ListRetirableGrants::operation_runtime_plugins(
104 self.handle.runtime_plugins.clone(),
105 &self.handle.conf,
106 self.config_override,
107 );
108 crate::operation::list_retirable_grants::ListRetirableGrants::orchestrate(&runtime_plugins, input).await
109 }
110
111 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
112 pub fn customize(
113 self,
114 ) -> crate::client::customize::CustomizableOperation<
115 crate::operation::list_retirable_grants::ListRetirableGrantsOutput,
116 crate::operation::list_retirable_grants::ListRetirableGrantsError,
117 Self,
118 > {
119 crate::client::customize::CustomizableOperation::new(self)
120 }
121 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
122 self.set_config_override(::std::option::Option::Some(config_override.into()));
123 self
124 }
125
126 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
127 self.config_override = config_override;
128 self
129 }
130 /// Create a paginator for this request
131 ///
132 /// Paginators are used by calling [`send().await`](crate::operation::list_retirable_grants::paginator::ListRetirableGrantsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
133 pub fn into_paginator(self) -> crate::operation::list_retirable_grants::paginator::ListRetirableGrantsPaginator {
134 crate::operation::list_retirable_grants::paginator::ListRetirableGrantsPaginator::new(self.handle, self.inner)
135 }
136 /// <p>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.</p>
137 /// <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>
138 pub fn limit(mut self, input: i32) -> Self {
139 self.inner = self.inner.limit(input);
140 self
141 }
142 /// <p>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.</p>
143 /// <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>
144 pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
145 self.inner = self.inner.set_limit(input);
146 self
147 }
148 /// <p>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.</p>
149 /// <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>
150 pub fn get_limit(&self) -> &::std::option::Option<i32> {
151 self.inner.get_limit()
152 }
153 /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p>
154 pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155 self.inner = self.inner.marker(input.into());
156 self
157 }
158 /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p>
159 pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160 self.inner = self.inner.set_marker(input);
161 self
162 }
163 /// <p>Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextMarker</code> from the truncated response you just received.</p>
164 pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
165 self.inner.get_marker()
166 }
167 /// <p>The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.</p>
168 /// <p>To specify the retiring principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a> in the <i> <i>Identity and Access Management User Guide</i> </i>.</p>
169 /// <p>You must specify either <code>RetiringPrincipal</code> or <code>RetiringServicePrincipal</code>, but not both.</p>
170 pub fn retiring_principal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171 self.inner = self.inner.retiring_principal(input.into());
172 self
173 }
174 /// <p>The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.</p>
175 /// <p>To specify the retiring principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a> in the <i> <i>Identity and Access Management User Guide</i> </i>.</p>
176 /// <p>You must specify either <code>RetiringPrincipal</code> or <code>RetiringServicePrincipal</code>, but not both.</p>
177 pub fn set_retiring_principal(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
178 self.inner = self.inner.set_retiring_principal(input);
179 self
180 }
181 /// <p>The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.</p>
182 /// <p>To specify the retiring principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM ARNs</a> in the <i> <i>Identity and Access Management User Guide</i> </i>.</p>
183 /// <p>You must specify either <code>RetiringPrincipal</code> or <code>RetiringServicePrincipal</code>, but not both.</p>
184 pub fn get_retiring_principal(&self) -> &::std::option::Option<::std::string::String> {
185 self.inner.get_retiring_principal()
186 }
187 /// <p>The retiring service principal for which to list grants. This filter is only usable by callers in a service principal.</p>
188 /// <p>You must specify either <code>RetiringPrincipal</code> or <code>RetiringServicePrincipal</code>, but not both.</p>
189 pub fn retiring_service_principal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
190 self.inner = self.inner.retiring_service_principal(input.into());
191 self
192 }
193 /// <p>The retiring service principal for which to list grants. This filter is only usable by callers in a service principal.</p>
194 /// <p>You must specify either <code>RetiringPrincipal</code> or <code>RetiringServicePrincipal</code>, but not both.</p>
195 pub fn set_retiring_service_principal(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
196 self.inner = self.inner.set_retiring_service_principal(input);
197 self
198 }
199 /// <p>The retiring service principal for which to list grants. This filter is only usable by callers in a service principal.</p>
200 /// <p>You must specify either <code>RetiringPrincipal</code> or <code>RetiringServicePrincipal</code>, but not both.</p>
201 pub fn get_retiring_service_principal(&self) -> &::std::option::Option<::std::string::String> {
202 self.inner.get_retiring_service_principal()
203 }
204}