aws_sdk_route53/client/

list_traffic_policy_instances.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListTrafficPolicyInstances`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`hosted_zone_id_marker(impl Into<String>)`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::hosted_zone_id_marker) / [`set_hosted_zone_id_marker(Option<String>)`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::set_hosted_zone_id_marker):<br>required: **false**<br><p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>HostedZoneId</code>, specify the value of <code>HostedZoneIdMarker</code> from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get.</p><br>
    ///   - [`traffic_policy_instance_name_marker(impl Into<String>)`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::traffic_policy_instance_name_marker) / [`set_traffic_policy_instance_name_marker(Option<String>)`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::set_traffic_policy_instance_name_marker):<br>required: **false**<br><p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancename</code>, specify the value of <code>TrafficPolicyInstanceNameMarker</code> from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get.</p><br>
    ///   - [`traffic_policy_instance_type_marker(RrType)`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::traffic_policy_instance_type_marker) / [`set_traffic_policy_instance_type_marker(Option<RrType>)`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::set_traffic_policy_instance_type_marker):<br>required: **false**<br><p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more traffic policy instances. To get more traffic policy instances, submit another <code>ListTrafficPolicyInstances</code> request. For the value of <code>trafficpolicyinstancetype</code>, specify the value of <code>TrafficPolicyInstanceTypeMarker</code> from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more traffic policy instances to get.</p><br>
    ///   - [`max_items(i32)`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::max_items) / [`set_max_items(Option<i32>)`](crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::set_max_items):<br>required: **false**<br><p>The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a <code>ListTrafficPolicyInstances</code> request. If you have more than <code>MaxItems</code> traffic policy instances, the value of the <code>IsTruncated</code> element in the response is <code>true</code>, and the values of <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> represent the first traffic policy instance in the next group of <code>MaxItems</code> traffic policy instances.</p><br>
    /// - On success, responds with [`ListTrafficPolicyInstancesOutput`](crate::operation::list_traffic_policy_instances::ListTrafficPolicyInstancesOutput) with field(s):
    ///   - [`traffic_policy_instances(Vec::<TrafficPolicyInstance>)`](crate::operation::list_traffic_policy_instances::ListTrafficPolicyInstancesOutput::traffic_policy_instances): <p>A list that contains one <code>TrafficPolicyInstance</code> element for each traffic policy instance that matches the elements in the request.</p>
    ///   - [`hosted_zone_id_marker(Option<String>)`](crate::operation::list_traffic_policy_instances::ListTrafficPolicyInstancesOutput::hosted_zone_id_marker): <p>If <code>IsTruncated</code> is <code>true</code>, <code>HostedZoneIdMarker</code> is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another <code>ListTrafficPolicyInstances</code> request.</p>
    ///   - [`traffic_policy_instance_name_marker(Option<String>)`](crate::operation::list_traffic_policy_instances::ListTrafficPolicyInstancesOutput::traffic_policy_instance_name_marker): <p>If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyInstanceNameMarker</code> is the name of the first traffic policy instance that Route 53 will return if you submit another <code>ListTrafficPolicyInstances</code> request.</p>
    ///   - [`traffic_policy_instance_type_marker(Option<RrType>)`](crate::operation::list_traffic_policy_instances::ListTrafficPolicyInstancesOutput::traffic_policy_instance_type_marker): <p>If <code>IsTruncated</code> is <code>true</code>, <code>TrafficPolicyInstanceTypeMarker</code> is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another <code>ListTrafficPolicyInstances</code> request.</p>
    ///   - [`is_truncated(bool)`](crate::operation::list_traffic_policy_instances::ListTrafficPolicyInstancesOutput::is_truncated): <p>A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling <code>ListTrafficPolicyInstances</code> again and specifying the values of the <code>HostedZoneIdMarker</code>, <code>TrafficPolicyInstanceNameMarker</code>, and <code>TrafficPolicyInstanceTypeMarker</code> in the corresponding request parameters.</p>
    ///   - [`max_items(i32)`](crate::operation::list_traffic_policy_instances::ListTrafficPolicyInstancesOutput::max_items): <p>The value that you specified for the <code>MaxItems</code> parameter in the call to <code>ListTrafficPolicyInstances</code> that produced the current response.</p>
    /// - On failure, responds with [`SdkError<ListTrafficPolicyInstancesError>`](crate::operation::list_traffic_policy_instances::ListTrafficPolicyInstancesError)
    pub fn list_traffic_policy_instances(
        &self,
    ) -> crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder {
        crate::operation::list_traffic_policy_instances::builders::ListTrafficPolicyInstancesFluentBuilder::new(self.handle.clone())
    }
}