aws_sdk_apprunner/client/
describe_custom_domains.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 [`DescribeCustomDomains`](crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`service_arn(impl Into<String>)`](crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder::service_arn) / [`set_service_arn(Option<String>)`](crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder::set_service_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.</p> <p>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results that each response (result page) can include. It's used for a paginated request.</p> <p>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</p><br>
10    /// - On success, responds with [`DescribeCustomDomainsOutput`](crate::operation::describe_custom_domains::DescribeCustomDomainsOutput) with field(s):
11    ///   - [`dns_target(String)`](crate::operation::describe_custom_domains::DescribeCustomDomainsOutput::dns_target): <p>The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.</p>
12    ///   - [`service_arn(String)`](crate::operation::describe_custom_domains::DescribeCustomDomainsOutput::service_arn): <p>The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.</p>
13    ///   - [`custom_domains(Vec::<CustomDomain>)`](crate::operation::describe_custom_domains::DescribeCustomDomainsOutput::custom_domains): <p>A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to <code>MaxResults</code> records per call.</p>
14    ///   - [`vpc_dns_targets(Vec::<VpcDnsTarget>)`](crate::operation::describe_custom_domains::DescribeCustomDomainsOutput::vpc_dns_targets): <p>DNS Target records for the custom domains of this Amazon VPC.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::describe_custom_domains::DescribeCustomDomainsOutput::next_token): <p>The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.</p>
16    /// - On failure, responds with [`SdkError<DescribeCustomDomainsError>`](crate::operation::describe_custom_domains::DescribeCustomDomainsError)
17    pub fn describe_custom_domains(&self) -> crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder {
18        crate::operation::describe_custom_domains::builders::DescribeCustomDomainsFluentBuilder::new(self.handle.clone())
19    }
20}