aws_sdk_route53/client/

list_hosted_zones_by_name.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListHostedZonesByName`](crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`dns_name(impl Into<String>)`](crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder::dns_name) / [`set_dns_name(Option<String>)`](crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder::set_dns_name):<br>required: **false**<br><p>(Optional) For your first request to <code>ListHostedZonesByName</code>, include the <code>dnsname</code> parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the <code>dnsname</code> parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both <code>dnsname</code> and <code>hostedzoneid</code> parameters. For <code>dnsname</code>, specify the value of <code>NextDNSName</code> from the previous response.</p><br>
    ///   - [`hosted_zone_id(impl Into<String>)`](crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder::hosted_zone_id) / [`set_hosted_zone_id(Option<String>)`](crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder::set_hosted_zone_id):<br>required: **false**<br><p>(Optional) For your first request to <code>ListHostedZonesByName</code>, do not include the <code>hostedzoneid</code> parameter.</p> <p>If you have more hosted zones than the value of <code>maxitems</code>, <code>ListHostedZonesByName</code> returns only the first <code>maxitems</code> hosted zones. To get the next group of <code>maxitems</code> hosted zones, submit another request to <code>ListHostedZonesByName</code> and include both <code>dnsname</code> and <code>hostedzoneid</code> parameters. For the value of <code>hostedzoneid</code>, specify the value of the <code>NextHostedZoneId</code> element from the previous response.</p><br>
    ///   - [`max_items(i32)`](crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder::max_items) / [`set_max_items(Option<i32>)`](crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder::set_max_items):<br>required: **false**<br><p>The maximum number of hosted zones to be included in the response body for this request. If you have more than <code>maxitems</code> hosted zones, then the value of the <code>IsTruncated</code> element in the response is true, and the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> specify the first hosted zone in the next group of <code>maxitems</code> hosted zones.</p><br>
    /// - On success, responds with [`ListHostedZonesByNameOutput`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameOutput) with field(s):
    ///   - [`hosted_zones(Vec::<HostedZone>)`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameOutput::hosted_zones): <p>A complex type that contains general information about the hosted zone.</p>
    ///   - [`dns_name(Option<String>)`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameOutput::dns_name): <p>For the second and subsequent calls to <code>ListHostedZonesByName</code>, <code>DNSName</code> is the value that you specified for the <code>dnsname</code> parameter in the request that produced the current response.</p>
    ///   - [`hosted_zone_id(Option<String>)`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameOutput::hosted_zone_id): <p>The ID that Amazon Route 53 assigned to the hosted zone when you created it.</p>
    ///   - [`is_truncated(bool)`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameOutput::is_truncated): <p>A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of <code>maxitems</code> hosted zones by calling <code>ListHostedZonesByName</code> again and specifying the values of <code>NextDNSName</code> and <code>NextHostedZoneId</code> elements in the <code>dnsname</code> and <code>hostedzoneid</code> parameters.</p>
    ///   - [`next_dns_name(Option<String>)`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameOutput::next_dns_name): <p>If <code>IsTruncated</code> is true, the value of <code>NextDNSName</code> is the name of the first hosted zone in the next group of <code>maxitems</code> hosted zones. Call <code>ListHostedZonesByName</code> again and specify the value of <code>NextDNSName</code> and <code>NextHostedZoneId</code> in the <code>dnsname</code> and <code>hostedzoneid</code> parameters, respectively.</p> <p>This element is present only if <code>IsTruncated</code> is <code>true</code>.</p>
    ///   - [`next_hosted_zone_id(Option<String>)`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameOutput::next_hosted_zone_id): <p>If <code>IsTruncated</code> is <code>true</code>, the value of <code>NextHostedZoneId</code> identifies the first hosted zone in the next group of <code>maxitems</code> hosted zones. Call <code>ListHostedZonesByName</code> again and specify the value of <code>NextDNSName</code> and <code>NextHostedZoneId</code> in the <code>dnsname</code> and <code>hostedzoneid</code> parameters, respectively.</p> <p>This element is present only if <code>IsTruncated</code> is <code>true</code>.</p>
    ///   - [`max_items(i32)`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameOutput::max_items): <p>The value that you specified for the <code>maxitems</code> parameter in the call to <code>ListHostedZonesByName</code> that produced the current response.</p>
    /// - On failure, responds with [`SdkError<ListHostedZonesByNameError>`](crate::operation::list_hosted_zones_by_name::ListHostedZonesByNameError)
    pub fn list_hosted_zones_by_name(&self) -> crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder {
        crate::operation::list_hosted_zones_by_name::builders::ListHostedZonesByNameFluentBuilder::new(self.handle.clone())
    }
}