Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppRunner.DescribeCustomDomains

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

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.
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.
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

ToJSON DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods toJSON :: DescribeCustomDomains -> Value # toEncoding :: DescribeCustomDomains -> Encoding # toJSONList :: [DescribeCustomDomains] -> Value # toEncodingList :: [DescribeCustomDomains] -> Encoding #
ToHeaders DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods toHeaders :: DescribeCustomDomains -> [Header] #
ToPath DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods toPath :: DescribeCustomDomains -> ByteString #
ToQuery DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods toQuery :: DescribeCustomDomains -> QueryString #
AWSRequest DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Associated Types type AWSResponse DescribeCustomDomains # Methods request :: (Service -> Service) -> DescribeCustomDomains -> Request DescribeCustomDomains # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCustomDomains -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCustomDomains))) #
Generic DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Associated Types type Rep DescribeCustomDomains :: Type -> Type # Methods from :: DescribeCustomDomains -> Rep DescribeCustomDomains x # to :: Rep DescribeCustomDomains x -> DescribeCustomDomains #
Read DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods readsPrec :: Int -> ReadS DescribeCustomDomains # readList :: ReadS [DescribeCustomDomains] # readPrec :: ReadPrec DescribeCustomDomains # readListPrec :: ReadPrec [DescribeCustomDomains] #
Show DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods showsPrec :: Int -> DescribeCustomDomains -> ShowS # show :: DescribeCustomDomains -> String # showList :: [DescribeCustomDomains] -> ShowS #
NFData DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods rnf :: DescribeCustomDomains -> () #
Eq DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods (==) :: DescribeCustomDomains -> DescribeCustomDomains -> Bool # (/=) :: DescribeCustomDomains -> DescribeCustomDomains -> Bool #
Hashable DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods hashWithSalt :: Int -> DescribeCustomDomains -> Int # hash :: DescribeCustomDomains -> Int #
type AWSResponse DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains type AWSResponse DescribeCustomDomains = DescribeCustomDomainsResponse
type Rep DescribeCustomDomains Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains type Rep DescribeCustomDomains = D1 ('MetaData "DescribeCustomDomains" "Amazonka.AppRunner.DescribeCustomDomains" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" 'False) (C1 ('MetaCons "DescribeCustomDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeCustomDomains Source #

Arguments

:: Text	`DescribeCustomDomains`
-> DescribeCustomDomains

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: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.

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.

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_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_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_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.
vpcDNSTargets :: [VpcDNSTarget]
DNS Target records for the custom domains of this Amazon VPC.

Instances

Instances details

Generic DescribeCustomDomainsResponse Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Associated Types type Rep DescribeCustomDomainsResponse :: Type -> Type # Methods from :: DescribeCustomDomainsResponse -> Rep DescribeCustomDomainsResponse x # to :: Rep DescribeCustomDomainsResponse x -> DescribeCustomDomainsResponse #
Read DescribeCustomDomainsResponse Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods readsPrec :: Int -> ReadS DescribeCustomDomainsResponse # readList :: ReadS [DescribeCustomDomainsResponse] # readPrec :: ReadPrec DescribeCustomDomainsResponse # readListPrec :: ReadPrec [DescribeCustomDomainsResponse] #
Show DescribeCustomDomainsResponse Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods showsPrec :: Int -> DescribeCustomDomainsResponse -> ShowS # show :: DescribeCustomDomainsResponse -> String # showList :: [DescribeCustomDomainsResponse] -> ShowS #
NFData DescribeCustomDomainsResponse Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods rnf :: DescribeCustomDomainsResponse -> () #
Eq DescribeCustomDomainsResponse Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains Methods (==) :: DescribeCustomDomainsResponse -> DescribeCustomDomainsResponse -> Bool # (/=) :: DescribeCustomDomainsResponse -> DescribeCustomDomainsResponse -> Bool #
type Rep DescribeCustomDomainsResponse Source #
Instance details Defined in Amazonka.AppRunner.DescribeCustomDomains type Rep DescribeCustomDomainsResponse = D1 ('MetaData "DescribeCustomDomainsResponse" "Amazonka.AppRunner.DescribeCustomDomains" "amazonka-apprunner-2.0-EwwUWnxXZrM2Mgbv25gcO5" '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]) :*: S1 ('MetaSel ('Just "vpcDNSTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [VpcDNSTarget])))))

newDescribeCustomDomainsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeCustomDomainsResponse'`
-> Text	`$sel:dNSTarget:DescribeCustomDomainsResponse'`
-> Text	`DescribeCustomDomains`
-> DescribeCustomDomainsResponse

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:

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.

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.

$sel:vpcDNSTargets:DescribeCustomDomainsResponse', describeCustomDomainsResponse_vpcDNSTargets - DNS Target records for the custom domains of this Amazon VPC.

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_httpStatus :: Lens' DescribeCustomDomainsResponse Int Source #

The response's http status code.

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.

describeCustomDomainsResponse_vpcDNSTargets :: Lens' DescribeCustomDomainsResponse [VpcDNSTarget] Source #

DNS Target records for the custom domains of this Amazon VPC.