aws_sdk_route53/client/
list_traffic_policies.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 [`ListTrafficPolicies`](crate::operation::list_traffic_policies::builders::ListTrafficPoliciesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`traffic_policy_id_marker(impl Into<String>)`](crate::operation::list_traffic_policies::builders::ListTrafficPoliciesFluentBuilder::traffic_policy_id_marker) / [`set_traffic_policy_id_marker(Option<String>)`](crate::operation::list_traffic_policies::builders::ListTrafficPoliciesFluentBuilder::set_traffic_policy_id_marker):<br>required: **false**<br><p>(Conditional) For your first request to <code>ListTrafficPolicies</code>, don't include the <code>TrafficPolicyIdMarker</code> parameter.</p> <p>If you have more traffic policies than the value of <code>MaxItems</code>, <code>ListTrafficPolicies</code> returns only the first <code>MaxItems</code> traffic policies. To get the next group of policies, submit another request to <code>ListTrafficPolicies</code>. For the value of <code>TrafficPolicyIdMarker</code>, specify the value of <code>TrafficPolicyIdMarker</code> that was returned in the previous response.</p><br>
7    ///   - [`max_items(i32)`](crate::operation::list_traffic_policies::builders::ListTrafficPoliciesFluentBuilder::max_items) / [`set_max_items(Option<i32>)`](crate::operation::list_traffic_policies::builders::ListTrafficPoliciesFluentBuilder::set_max_items):<br>required: **false**<br><p>(Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than <code>MaxItems</code> traffic policies, the value of <code>IsTruncated</code> in the response is <code>true</code>, and the value of <code>TrafficPolicyIdMarker</code> is the ID of the first traffic policy that Route 53 will return if you submit another request.</p><br>
8    /// - On success, responds with [`ListTrafficPoliciesOutput`](crate::operation::list_traffic_policies::ListTrafficPoliciesOutput) with field(s):
9    ///   - [`traffic_policy_summaries(Vec::<TrafficPolicySummary>)`](crate::operation::list_traffic_policies::ListTrafficPoliciesOutput::traffic_policy_summaries): <p>A list that contains one <code>TrafficPolicySummary</code> element for each traffic policy that was created by the current Amazon Web Services account.</p>
10    ///   - [`is_truncated(bool)`](crate::operation::list_traffic_policies::ListTrafficPoliciesOutput::is_truncated): <p>A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another <code>ListTrafficPolicies</code> request and specifying the value of <code>TrafficPolicyIdMarker</code> in the <code>TrafficPolicyIdMarker</code> request parameter.</p>
11    ///   - [`traffic_policy_id_marker(String)`](crate::operation::list_traffic_policies::ListTrafficPoliciesOutput::traffic_policy_id_marker): <p>If the value of <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyIdMarker</code> is the ID of the first traffic policy in the next group of <code>MaxItems</code> traffic policies.</p>
12    ///   - [`max_items(i32)`](crate::operation::list_traffic_policies::ListTrafficPoliciesOutput::max_items): <p>The value that you specified for the <code>MaxItems</code> parameter in the <code>ListTrafficPolicies</code> request that produced the current response.</p>
13    /// - On failure, responds with [`SdkError<ListTrafficPoliciesError>`](crate::operation::list_traffic_policies::ListTrafficPoliciesError)
14    pub fn list_traffic_policies(&self) -> crate::operation::list_traffic_policies::builders::ListTrafficPoliciesFluentBuilder {
15        crate::operation::list_traffic_policies::builders::ListTrafficPoliciesFluentBuilder::new(self.handle.clone())
16    }
17}