aws_sdk_pcaconnectorscep/client/
list_challenge_metadata.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 [`ListChallengeMetadata`](crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder::set_next_token):<br>required: **false**<br><p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p><br>
9    ///   - [`connector_arn(impl Into<String>)`](crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder::connector_arn) / [`set_connector_arn(Option<String>)`](crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder::set_connector_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the connector.</p><br>
10    /// - On success, responds with [`ListChallengeMetadataOutput`](crate::operation::list_challenge_metadata::ListChallengeMetadataOutput) with field(s):
11    ///   - [`challenges(Option<Vec::<ChallengeMetadataSummary>>)`](crate::operation::list_challenge_metadata::ListChallengeMetadataOutput::challenges): <p>The challenge metadata for the challenges belonging to your Amazon Web Services account.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_challenge_metadata::ListChallengeMetadataOutput::next_token): <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
13    /// - On failure, responds with [`SdkError<ListChallengeMetadataError>`](crate::operation::list_challenge_metadata::ListChallengeMetadataError)
14    pub fn list_challenge_metadata(&self) -> crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder {
15        crate::operation::list_challenge_metadata::builders::ListChallengeMetadataFluentBuilder::new(self.handle.clone())
16    }
17}