aws_sdk_acmpca/client/
list_certificate_authorities.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 [`ListCertificateAuthorities`](crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder::set_max_results):<br>required: **false**<br><p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p> <p>Although the maximum value is 1000, the action only returns a maximum of 100 items.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder::set_next_token):<br>required: **false**<br><p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p><br>
9    ///   - [`resource_owner(ResourceOwner)`](crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder::resource_owner) / [`set_resource_owner(Option<ResourceOwner>)`](crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder::set_resource_owner):<br>required: **false**<br><p>Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.</p><br>
10    /// - On success, responds with [`ListCertificateAuthoritiesOutput`](crate::operation::list_certificate_authorities::ListCertificateAuthoritiesOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_certificate_authorities::ListCertificateAuthoritiesOutput::next_token): <p>When the list is truncated, this value is present and should be used for the <code>NextToken</code> parameter in a subsequent pagination request.</p>
12    ///   - [`certificate_authorities(Option<Vec::<CertificateAuthority>>)`](crate::operation::list_certificate_authorities::ListCertificateAuthoritiesOutput::certificate_authorities): <p>Summary information about each certificate authority you have created.</p>
13    /// - On failure, responds with [`SdkError<ListCertificateAuthoritiesError>`](crate::operation::list_certificate_authorities::ListCertificateAuthoritiesError)
14    pub fn list_certificate_authorities(&self) -> crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder {
15        crate::operation::list_certificate_authorities::builders::ListCertificateAuthoritiesFluentBuilder::new(self.handle.clone())
16    }
17}