aws_sdk_acmpca/client/
list_permissions.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 [`ListPermissions`](crate::operation::list_permissions::builders::ListPermissionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_permissions::builders::ListPermissionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_permissions::builders::ListPermissionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_permissions::builders::ListPermissionsFluentBuilder::set_max_results):<br>required: **false**<br><p>When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <b>NextToken</b> element is sent in the response. Use this <b>NextToken</b> value in a subsequent request to retrieve additional items.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_permissions::builders::ListPermissionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_permissions::builders::ListPermissionsFluentBuilder::set_next_token):<br>required: **false**<br><p>When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p><br>
9    ///   - [`certificate_authority_arn(impl Into<String>)`](crate::operation::list_permissions::builders::ListPermissionsFluentBuilder::certificate_authority_arn) / [`set_certificate_authority_arn(Option<String>)`](crate::operation::list_permissions::builders::ListPermissionsFluentBuilder::set_certificate_authority_arn):<br>required: **true**<br><p>The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action. This must be of the form: <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> You can get a private CA's ARN by running the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html">ListCertificateAuthorities</a> action.</p><br>
10    /// - On success, responds with [`ListPermissionsOutput`](crate::operation::list_permissions::ListPermissionsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_permissions::ListPermissionsOutput::next_token): <p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request.</p>
12    ///   - [`permissions(Option<Vec::<Permission>>)`](crate::operation::list_permissions::ListPermissionsOutput::permissions): <p>Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.</p>
13    /// - On failure, responds with [`SdkError<ListPermissionsError>`](crate::operation::list_permissions::ListPermissionsError)
14    pub fn list_permissions(&self) -> crate::operation::list_permissions::builders::ListPermissionsFluentBuilder {
15        crate::operation::list_permissions::builders::ListPermissionsFluentBuilder::new(self.handle.clone())
16    }
17}