aws_sdk_config/client/describe_retention_configurations.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 [`DescribeRetentionConfigurations`](crate::operation::describe_retention_configurations::builders::DescribeRetentionConfigurationsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_retention_configurations::builders::DescribeRetentionConfigurationsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`retention_configuration_names(impl Into<String>)`](crate::operation::describe_retention_configurations::builders::DescribeRetentionConfigurationsFluentBuilder::retention_configuration_names) / [`set_retention_configuration_names(Option<Vec::<String>>)`](crate::operation::describe_retention_configurations::builders::DescribeRetentionConfigurationsFluentBuilder::set_retention_configuration_names):<br>required: **false**<br><p>A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.</p><note> <p>Currently, Config supports only one retention configuration per region in your account.</p> </note><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::describe_retention_configurations::builders::DescribeRetentionConfigurationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_retention_configurations::builders::DescribeRetentionConfigurationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p><br>
9 /// - On success, responds with [`DescribeRetentionConfigurationsOutput`](crate::operation::describe_retention_configurations::DescribeRetentionConfigurationsOutput) with field(s):
10 /// - [`retention_configurations(Option<Vec::<RetentionConfiguration>>)`](crate::operation::describe_retention_configurations::DescribeRetentionConfigurationsOutput::retention_configurations): <p>Returns a retention configuration object.</p>
11 /// - [`next_token(Option<String>)`](crate::operation::describe_retention_configurations::DescribeRetentionConfigurationsOutput::next_token): <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
12 /// - On failure, responds with [`SdkError<DescribeRetentionConfigurationsError>`](crate::operation::describe_retention_configurations::DescribeRetentionConfigurationsError)
13 pub fn describe_retention_configurations(
14 &self,
15 ) -> crate::operation::describe_retention_configurations::builders::DescribeRetentionConfigurationsFluentBuilder {
16 crate::operation::describe_retention_configurations::builders::DescribeRetentionConfigurationsFluentBuilder::new(self.handle.clone())
17 }
18}