libZSservicesZSamazonka-apprunnerZSamazonka-apprunner
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppRunner.DescribeCustomDomains

Description

Return a description of custom domain names that are associated with an App Runner service.

Synopsis

Creating a Request

data DescribeCustomDomains Source #

See: newDescribeCustomDomains smart constructor.

Constructors

DescribeCustomDomains' 

Fields

  • nextToken :: Maybe Text

    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.

    If you don't specify NextToken, the request retrieves the first result page.

  • maxResults :: Maybe Natural

    The maximum number of results that each response (result page) can include. It's used for a paginated request.

    If you don't specify MaxResults, the request retrieves all available results in a single response.

  • serviceArn :: Text

    The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

Instances

Instances details
Eq DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Read DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Show DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Generic DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Associated Types

type Rep DescribeCustomDomains :: Type -> Type #

NFData DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Methods

rnf :: DescribeCustomDomains -> () #

Hashable DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

ToJSON DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

AWSRequest DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Associated Types

type AWSResponse DescribeCustomDomains #

ToHeaders DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

ToPath DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

ToQuery DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

type Rep DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

type Rep DescribeCustomDomains = D1 ('MetaData "DescribeCustomDomains" "Amazonka.AppRunner.DescribeCustomDomains" "libZSservicesZSamazonka-apprunnerZSamazonka-apprunner" 'False) (C1 ('MetaCons "DescribeCustomDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "serviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeCustomDomains Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

newDescribeCustomDomains Source #

Create a value of DescribeCustomDomains with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:DescribeCustomDomains', describeCustomDomains_nextToken - 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.

If you don't specify NextToken, the request retrieves the first result page.

$sel:maxResults:DescribeCustomDomains', describeCustomDomains_maxResults - The maximum number of results that each response (result page) can include. It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

$sel:serviceArn:DescribeCustomDomains', describeCustomDomains_serviceArn - The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

Request Lenses

describeCustomDomains_nextToken :: Lens' DescribeCustomDomains (Maybe Text) Source #

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.

If you don't specify NextToken, the request retrieves the first result page.

describeCustomDomains_maxResults :: Lens' DescribeCustomDomains (Maybe Natural) Source #

The maximum number of results that each response (result page) can include. It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

describeCustomDomains_serviceArn :: Lens' DescribeCustomDomains Text Source #

The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.

Destructuring the Response

data DescribeCustomDomainsResponse Source #

See: newDescribeCustomDomainsResponse smart constructor.

Constructors

DescribeCustomDomainsResponse' 

Fields

  • nextToken :: Maybe Text

    The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

  • httpStatus :: Int

    The response's http status code.

  • dNSTarget :: Text

    The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

  • serviceArn :: Text

    The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

  • customDomains :: [CustomDomain]

    A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to MaxResults records per call.

Instances

Instances details
Eq DescribeCustomDomainsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Read DescribeCustomDomainsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Show DescribeCustomDomainsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Generic DescribeCustomDomainsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

Associated Types

type Rep DescribeCustomDomainsResponse :: Type -> Type #

NFData DescribeCustomDomainsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

type Rep DescribeCustomDomainsResponse Source # 
Instance details

Defined in Amazonka.AppRunner.DescribeCustomDomains

type Rep DescribeCustomDomainsResponse = D1 ('MetaData "DescribeCustomDomainsResponse" "Amazonka.AppRunner.DescribeCustomDomains" "libZSservicesZSamazonka-apprunnerZSamazonka-apprunner" 'False) (C1 ('MetaCons "DescribeCustomDomainsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "dNSTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "serviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "customDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CustomDomain])))))

newDescribeCustomDomainsResponse Source #

Create a value of DescribeCustomDomainsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:DescribeCustomDomains', describeCustomDomainsResponse_nextToken - The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

$sel:httpStatus:DescribeCustomDomainsResponse', describeCustomDomainsResponse_httpStatus - The response's http status code.

$sel:dNSTarget:DescribeCustomDomainsResponse', describeCustomDomainsResponse_dNSTarget - The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

$sel:serviceArn:DescribeCustomDomains', describeCustomDomainsResponse_serviceArn - The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

$sel:customDomains:DescribeCustomDomainsResponse', describeCustomDomainsResponse_customDomains - A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to MaxResults records per call.

Response Lenses

describeCustomDomainsResponse_nextToken :: Lens' DescribeCustomDomainsResponse (Maybe Text) Source #

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

describeCustomDomainsResponse_dNSTarget :: Lens' DescribeCustomDomainsResponse Text Source #

The App Runner subdomain of the App Runner service. The associated custom domain names are mapped to this target name.

describeCustomDomainsResponse_serviceArn :: Lens' DescribeCustomDomainsResponse Text Source #

The Amazon Resource Name (ARN) of the App Runner service whose associated custom domain names you want to describe.

describeCustomDomainsResponse_customDomains :: Lens' DescribeCustomDomainsResponse [CustomDomain] Source #

A list of descriptions of custom domain names that are associated with the service. In a paginated request, the request returns up to MaxResults records per call.