aws_sdk_kms/operation/list_grants/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_grants::_list_grants_output::ListGrantsOutputBuilder;
3
4pub use crate::operation::list_grants::_list_grants_input::ListGrantsInputBuilder;
5
6impl crate::operation::list_grants::builders::ListGrantsInputBuilder {
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_grants::ListGrantsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_grants::ListGrantsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_grants();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListGrants`.
24///
25/// <p>Gets a list of all grants for the specified KMS key.</p>
26/// <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID or grantee principal.</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 working with grants in several programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>.</p><note>
28/// <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might represent several different grantee principals.</p>
29/// </note>
30/// <p><b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p>
31/// <p><b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListGrants</a> (key policy)</p>
32/// <p><b>Related operations:</b></p>
33/// <ul>
34/// <li>
35/// <p><code>CreateGrant</code></p></li>
36/// <li>
37/// <p><code>ListRetirableGrants</code></p></li>
38/// <li>
39/// <p><code>RetireGrant</code></p></li>
40/// <li>
41/// <p><code>RevokeGrant</code></p></li>
42/// </ul>
43/// <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/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
44#[derive(::std::clone::Clone, ::std::fmt::Debug)]
45pub struct ListGrantsFluentBuilder {
46 handle: ::std::sync::Arc<crate::client::Handle>,
47 inner: crate::operation::list_grants::builders::ListGrantsInputBuilder,
48 config_override: ::std::option::Option<crate::config::Builder>,
49}
50impl
51 crate::client::customize::internal::CustomizableSend<
52 crate::operation::list_grants::ListGrantsOutput,
53 crate::operation::list_grants::ListGrantsError,
54 > for ListGrantsFluentBuilder
55{
56 fn send(
57 self,
58 config_override: crate::config::Builder,
59 ) -> crate::client::customize::internal::BoxFuture<
60 crate::client::customize::internal::SendResult<
61 crate::operation::list_grants::ListGrantsOutput,
62 crate::operation::list_grants::ListGrantsError,
63 >,
64 > {
65 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
66 }
67}
68impl ListGrantsFluentBuilder {
69 /// Creates a new `ListGrantsFluentBuilder`.
70 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
71 Self {
72 handle,
73 inner: ::std::default::Default::default(),
74 config_override: ::std::option::Option::None,
75 }
76 }
77 /// Access the ListGrants as a reference.
78 pub fn as_input(&self) -> &crate::operation::list_grants::builders::ListGrantsInputBuilder {
79 &self.inner
80 }
81 /// Sends the request and returns the response.
82 ///
83 /// If an error occurs, an `SdkError` will be returned with additional details that
84 /// can be matched against.
85 ///
86 /// By default, any retryable failures will be retried twice. Retry behavior
87 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
88 /// set when configuring the client.
89 pub async fn send(
90 self,
91 ) -> ::std::result::Result<
92 crate::operation::list_grants::ListGrantsOutput,
93 ::aws_smithy_runtime_api::client::result::SdkError<
94 crate::operation::list_grants::ListGrantsError,
95 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
96 >,
97 > {
98 let input = self
99 .inner
100 .build()
101 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
102 let runtime_plugins = crate::operation::list_grants::ListGrants::operation_runtime_plugins(
103 self.handle.runtime_plugins.clone(),
104 &self.handle.conf,
105 self.config_override,
106 );
107 crate::operation::list_grants::ListGrants::orchestrate(&runtime_plugins, input).await
108 }
109
110 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
111 pub fn customize(
112 self,
113 ) -> crate::client::customize::CustomizableOperation<
114 crate::operation::list_grants::ListGrantsOutput,
115 crate::operation::list_grants::ListGrantsError,
116 Self,
117 > {
118 crate::client::customize::CustomizableOperation::new(self)
119 }
120 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
121 self.set_config_override(::std::option::Option::Some(config_override.into()));
122 self
123 }
124
125 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
126 self.config_override = config_override;
127 self
128 }
129 /// Create a paginator for this request
130 ///
131 /// Paginators are used by calling [`send().await`](crate::operation::list_grants::paginator::ListGrantsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
132 pub fn into_paginator(self) -> crate::operation::list_grants::paginator::ListGrantsPaginator {
133 crate::operation::list_grants::paginator::ListGrantsPaginator::new(self.handle, self.inner)
134 }
135 /// <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>
136 /// <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>
137 pub fn limit(mut self, input: i32) -> Self {
138 self.inner = self.inner.limit(input);
139 self
140 }
141 /// <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>
142 /// <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>
143 pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
144 self.inner = self.inner.set_limit(input);
145 self
146 }
147 /// <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>
148 /// <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>
149 pub fn get_limit(&self) -> &::std::option::Option<i32> {
150 self.inner.get_limit()
151 }
152 /// <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>
153 pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
154 self.inner = self.inner.marker(input.into());
155 self
156 }
157 /// <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>
158 pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
159 self.inner = self.inner.set_marker(input);
160 self
161 }
162 /// <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>
163 pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
164 self.inner.get_marker()
165 }
166 /// <p>Returns only grants for the specified KMS key. This parameter is required.</p>
167 /// <p>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.</p>
168 /// <p>For example:</p>
169 /// <ul>
170 /// <li>
171 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
172 /// <li>
173 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
174 /// </ul>
175 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
176 pub fn key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
177 self.inner = self.inner.key_id(input.into());
178 self
179 }
180 /// <p>Returns only grants for the specified KMS key. This parameter is required.</p>
181 /// <p>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.</p>
182 /// <p>For example:</p>
183 /// <ul>
184 /// <li>
185 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
186 /// <li>
187 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
188 /// </ul>
189 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
190 pub fn set_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
191 self.inner = self.inner.set_key_id(input);
192 self
193 }
194 /// <p>Returns only grants for the specified KMS key. This parameter is required.</p>
195 /// <p>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.</p>
196 /// <p>For example:</p>
197 /// <ul>
198 /// <li>
199 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
200 /// <li>
201 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
202 /// </ul>
203 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
204 pub fn get_key_id(&self) -> &::std::option::Option<::std::string::String> {
205 self.inner.get_key_id()
206 }
207 /// <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.</p>
208 pub fn grant_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
209 self.inner = self.inner.grant_id(input.into());
210 self
211 }
212 /// <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.</p>
213 pub fn set_grant_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
214 self.inner = self.inner.set_grant_id(input);
215 self
216 }
217 /// <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.</p>
218 pub fn get_grant_id(&self) -> &::std::option::Option<::std::string::String> {
219 self.inner.get_grant_id()
220 }
221 /// <p>Returns only grants where the specified principal is the grantee principal for the grant.</p>
222 pub fn grantee_principal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
223 self.inner = self.inner.grantee_principal(input.into());
224 self
225 }
226 /// <p>Returns only grants where the specified principal is the grantee principal for the grant.</p>
227 pub fn set_grantee_principal(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
228 self.inner = self.inner.set_grantee_principal(input);
229 self
230 }
231 /// <p>Returns only grants where the specified principal is the grantee principal for the grant.</p>
232 pub fn get_grantee_principal(&self) -> &::std::option::Option<::std::string::String> {
233 self.inner.get_grantee_principal()
234 }
235}