1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ListGrantsInput {
/// <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>
/// <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>
pub limit: ::std::option::Option<i32>,
/// <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>
pub marker: ::std::option::Option<::std::string::String>,
/// <p>Returns only grants for the specified KMS key. This parameter is required.</p>
/// <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>
/// <p>For example:</p>
/// <ul>
/// <li>
/// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// <li>
/// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// </ul>
/// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
pub key_id: ::std::option::Option<::std::string::String>,
/// <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.</p>
pub grant_id: ::std::option::Option<::std::string::String>,
/// <p>Returns only grants where the specified principal is the grantee principal for the grant.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub grantee_principal: ::std::option::Option<::std::string::String>,
/// <p>Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub grantee_service_principal: ::std::option::Option<::std::string::String>,
}
impl ListGrantsInput {
/// <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>
/// <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>
pub fn limit(&self) -> ::std::option::Option<i32> {
self.limit
}
/// <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>
pub fn marker(&self) -> ::std::option::Option<&str> {
self.marker.as_deref()
}
/// <p>Returns only grants for the specified KMS key. This parameter is required.</p>
/// <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>
/// <p>For example:</p>
/// <ul>
/// <li>
/// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// <li>
/// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// </ul>
/// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
pub fn key_id(&self) -> ::std::option::Option<&str> {
self.key_id.as_deref()
}
/// <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.</p>
pub fn grant_id(&self) -> ::std::option::Option<&str> {
self.grant_id.as_deref()
}
/// <p>Returns only grants where the specified principal is the grantee principal for the grant.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub fn grantee_principal(&self) -> ::std::option::Option<&str> {
self.grantee_principal.as_deref()
}
/// <p>Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub fn grantee_service_principal(&self) -> ::std::option::Option<&str> {
self.grantee_service_principal.as_deref()
}
}
impl ListGrantsInput {
/// Creates a new builder-style object to manufacture [`ListGrantsInput`](crate::operation::list_grants::ListGrantsInput).
pub fn builder() -> crate::operation::list_grants::builders::ListGrantsInputBuilder {
crate::operation::list_grants::builders::ListGrantsInputBuilder::default()
}
}
/// A builder for [`ListGrantsInput`](crate::operation::list_grants::ListGrantsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListGrantsInputBuilder {
pub(crate) limit: ::std::option::Option<i32>,
pub(crate) marker: ::std::option::Option<::std::string::String>,
pub(crate) key_id: ::std::option::Option<::std::string::String>,
pub(crate) grant_id: ::std::option::Option<::std::string::String>,
pub(crate) grantee_principal: ::std::option::Option<::std::string::String>,
pub(crate) grantee_service_principal: ::std::option::Option<::std::string::String>,
}
impl ListGrantsInputBuilder {
/// <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>
/// <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>
pub fn limit(mut self, input: i32) -> Self {
self.limit = ::std::option::Option::Some(input);
self
}
/// <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>
/// <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>
pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
self.limit = input;
self
}
/// <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>
/// <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>
pub fn get_limit(&self) -> &::std::option::Option<i32> {
&self.limit
}
/// <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>
pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.marker = ::std::option::Option::Some(input.into());
self
}
/// <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>
pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.marker = input;
self
}
/// <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>
pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
&self.marker
}
/// <p>Returns only grants for the specified KMS key. This parameter is required.</p>
/// <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>
/// <p>For example:</p>
/// <ul>
/// <li>
/// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// <li>
/// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// </ul>
/// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
/// This field is required.
pub fn key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.key_id = ::std::option::Option::Some(input.into());
self
}
/// <p>Returns only grants for the specified KMS key. This parameter is required.</p>
/// <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>
/// <p>For example:</p>
/// <ul>
/// <li>
/// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// <li>
/// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// </ul>
/// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
pub fn set_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.key_id = input;
self
}
/// <p>Returns only grants for the specified KMS key. This parameter is required.</p>
/// <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>
/// <p>For example:</p>
/// <ul>
/// <li>
/// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// <li>
/// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
/// </ul>
/// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
pub fn get_key_id(&self) -> &::std::option::Option<::std::string::String> {
&self.key_id
}
/// <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.</p>
pub fn grant_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.grant_id = ::std::option::Option::Some(input.into());
self
}
/// <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.</p>
pub fn set_grant_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.grant_id = input;
self
}
/// <p>Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.</p>
pub fn get_grant_id(&self) -> &::std::option::Option<::std::string::String> {
&self.grant_id
}
/// <p>Returns only grants where the specified principal is the grantee principal for the grant.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub fn grantee_principal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.grantee_principal = ::std::option::Option::Some(input.into());
self
}
/// <p>Returns only grants where the specified principal is the grantee principal for the grant.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub fn set_grantee_principal(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.grantee_principal = input;
self
}
/// <p>Returns only grants where the specified principal is the grantee principal for the grant.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub fn get_grantee_principal(&self) -> &::std::option::Option<::std::string::String> {
&self.grantee_principal
}
/// <p>Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub fn grantee_service_principal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.grantee_service_principal = ::std::option::Option::Some(input.into());
self
}
/// <p>Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub fn set_grantee_service_principal(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.grantee_service_principal = input;
self
}
/// <p>Returns only grants where the specified Amazon Web Services service principal is the grantee service principal for the grant. This filter is only usable by callers in a service principal.</p>
/// <p>You can specify either <code>GranteePrincipal</code> or <code>GranteeServicePrincipal</code>, but not both.</p>
pub fn get_grantee_service_principal(&self) -> &::std::option::Option<::std::string::String> {
&self.grantee_service_principal
}
/// Consumes the builder and constructs a [`ListGrantsInput`](crate::operation::list_grants::ListGrantsInput).
pub fn build(self) -> ::std::result::Result<crate::operation::list_grants::ListGrantsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::list_grants::ListGrantsInput {
limit: self.limit,
marker: self.marker,
key_id: self.key_id,
grant_id: self.grant_id,
grantee_principal: self.grantee_principal,
grantee_service_principal: self.grantee_service_principal,
})
}
}