{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.AppRunner.DescribeCustomDomains -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Return a description of custom domain names that are associated with an -- App Runner service. module Amazonka.AppRunner.DescribeCustomDomains ( -- * Creating a Request DescribeCustomDomains (..), newDescribeCustomDomains, -- * Request Lenses describeCustomDomains_maxResults, describeCustomDomains_nextToken, describeCustomDomains_serviceArn, -- * Destructuring the Response DescribeCustomDomainsResponse (..), newDescribeCustomDomainsResponse, -- * Response Lenses describeCustomDomainsResponse_nextToken, describeCustomDomainsResponse_httpStatus, describeCustomDomainsResponse_dNSTarget, describeCustomDomainsResponse_serviceArn, describeCustomDomainsResponse_customDomains, describeCustomDomainsResponse_vpcDNSTargets, ) where import Amazonka.AppRunner.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDescribeCustomDomains' smart constructor. data DescribeCustomDomains = DescribeCustomDomains' { -- | 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. maxResults :: Prelude.Maybe Prelude.Natural, -- | 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. nextToken :: Prelude.Maybe Prelude.Text, -- | The Amazon Resource Name (ARN) of the App Runner service that you want -- associated custom domain names to be described for. serviceArn :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeCustomDomains' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'maxResults', '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. -- -- 'nextToken', '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. -- -- 'serviceArn', 'describeCustomDomains_serviceArn' - The Amazon Resource Name (ARN) of the App Runner service that you want -- associated custom domain names to be described for. newDescribeCustomDomains :: -- | 'serviceArn' Prelude.Text -> DescribeCustomDomains newDescribeCustomDomains pServiceArn_ = DescribeCustomDomains' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, serviceArn = pServiceArn_ } -- | 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_maxResults :: Lens.Lens' DescribeCustomDomains (Prelude.Maybe Prelude.Natural) describeCustomDomains_maxResults = Lens.lens (\DescribeCustomDomains' {maxResults} -> maxResults) (\s@DescribeCustomDomains' {} a -> s {maxResults = a} :: DescribeCustomDomains) -- | 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_nextToken :: Lens.Lens' DescribeCustomDomains (Prelude.Maybe Prelude.Text) describeCustomDomains_nextToken = Lens.lens (\DescribeCustomDomains' {nextToken} -> nextToken) (\s@DescribeCustomDomains' {} a -> s {nextToken = a} :: DescribeCustomDomains) -- | The Amazon Resource Name (ARN) of the App Runner service that you want -- associated custom domain names to be described for. describeCustomDomains_serviceArn :: Lens.Lens' DescribeCustomDomains Prelude.Text describeCustomDomains_serviceArn = Lens.lens (\DescribeCustomDomains' {serviceArn} -> serviceArn) (\s@DescribeCustomDomains' {} a -> s {serviceArn = a} :: DescribeCustomDomains) instance Core.AWSRequest DescribeCustomDomains where type AWSResponse DescribeCustomDomains = DescribeCustomDomainsResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeCustomDomainsResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> (x Data..:> "DNSTarget") Prelude.<*> (x Data..:> "ServiceArn") Prelude.<*> (x Data..?> "CustomDomains" Core..!@ Prelude.mempty) Prelude.<*> (x Data..?> "VpcDNSTargets" Core..!@ Prelude.mempty) ) instance Prelude.Hashable DescribeCustomDomains where hashWithSalt _salt DescribeCustomDomains' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` serviceArn instance Prelude.NFData DescribeCustomDomains where rnf DescribeCustomDomains' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf serviceArn instance Data.ToHeaders DescribeCustomDomains where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AppRunner.DescribeCustomDomains" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.0" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeCustomDomains where toJSON DescribeCustomDomains' {..} = Data.object ( Prelude.catMaybes [ ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken, Prelude.Just ("ServiceArn" Data..= serviceArn) ] ) instance Data.ToPath DescribeCustomDomains where toPath = Prelude.const "/" instance Data.ToQuery DescribeCustomDomains where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeCustomDomainsResponse' smart constructor. data DescribeCustomDomainsResponse = DescribeCustomDomainsResponse' { -- | The token that you can pass in a subsequent request to get the next -- result page. It\'s returned in a paginated request. nextToken :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int, -- | The App Runner subdomain of the App Runner service. The associated -- custom domain names are mapped to this target name. dNSTarget :: Prelude.Text, -- | The Amazon Resource Name (ARN) of the App Runner service whose -- associated custom domain names you want to describe. serviceArn :: Prelude.Text, -- | 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. customDomains :: [CustomDomain], -- | DNS Target records for the custom domains of this Amazon VPC. vpcDNSTargets :: [VpcDNSTarget] } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeCustomDomainsResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'nextToken', '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. -- -- 'httpStatus', 'describeCustomDomainsResponse_httpStatus' - The response's http status code. -- -- 'dNSTarget', 'describeCustomDomainsResponse_dNSTarget' - The App Runner subdomain of the App Runner service. The associated -- custom domain names are mapped to this target name. -- -- 'serviceArn', 'describeCustomDomainsResponse_serviceArn' - The Amazon Resource Name (ARN) of the App Runner service whose -- associated custom domain names you want to describe. -- -- 'customDomains', '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. -- -- 'vpcDNSTargets', 'describeCustomDomainsResponse_vpcDNSTargets' - DNS Target records for the custom domains of this Amazon VPC. newDescribeCustomDomainsResponse :: -- | 'httpStatus' Prelude.Int -> -- | 'dNSTarget' Prelude.Text -> -- | 'serviceArn' Prelude.Text -> DescribeCustomDomainsResponse newDescribeCustomDomainsResponse pHttpStatus_ pDNSTarget_ pServiceArn_ = DescribeCustomDomainsResponse' { nextToken = Prelude.Nothing, httpStatus = pHttpStatus_, dNSTarget = pDNSTarget_, serviceArn = pServiceArn_, customDomains = Prelude.mempty, vpcDNSTargets = Prelude.mempty } -- | The token that you can pass in a subsequent request to get the next -- result page. It\'s returned in a paginated request. describeCustomDomainsResponse_nextToken :: Lens.Lens' DescribeCustomDomainsResponse (Prelude.Maybe Prelude.Text) describeCustomDomainsResponse_nextToken = Lens.lens (\DescribeCustomDomainsResponse' {nextToken} -> nextToken) (\s@DescribeCustomDomainsResponse' {} a -> s {nextToken = a} :: DescribeCustomDomainsResponse) -- | The response's http status code. describeCustomDomainsResponse_httpStatus :: Lens.Lens' DescribeCustomDomainsResponse Prelude.Int describeCustomDomainsResponse_httpStatus = Lens.lens (\DescribeCustomDomainsResponse' {httpStatus} -> httpStatus) (\s@DescribeCustomDomainsResponse' {} a -> s {httpStatus = a} :: DescribeCustomDomainsResponse) -- | The App Runner subdomain of the App Runner service. The associated -- custom domain names are mapped to this target name. describeCustomDomainsResponse_dNSTarget :: Lens.Lens' DescribeCustomDomainsResponse Prelude.Text describeCustomDomainsResponse_dNSTarget = Lens.lens (\DescribeCustomDomainsResponse' {dNSTarget} -> dNSTarget) (\s@DescribeCustomDomainsResponse' {} a -> s {dNSTarget = a} :: DescribeCustomDomainsResponse) -- | The Amazon Resource Name (ARN) of the App Runner service whose -- associated custom domain names you want to describe. describeCustomDomainsResponse_serviceArn :: Lens.Lens' DescribeCustomDomainsResponse Prelude.Text describeCustomDomainsResponse_serviceArn = Lens.lens (\DescribeCustomDomainsResponse' {serviceArn} -> serviceArn) (\s@DescribeCustomDomainsResponse' {} a -> s {serviceArn = a} :: DescribeCustomDomainsResponse) -- | 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_customDomains :: Lens.Lens' DescribeCustomDomainsResponse [CustomDomain] describeCustomDomainsResponse_customDomains = Lens.lens (\DescribeCustomDomainsResponse' {customDomains} -> customDomains) (\s@DescribeCustomDomainsResponse' {} a -> s {customDomains = a} :: DescribeCustomDomainsResponse) Prelude.. Lens.coerced -- | DNS Target records for the custom domains of this Amazon VPC. describeCustomDomainsResponse_vpcDNSTargets :: Lens.Lens' DescribeCustomDomainsResponse [VpcDNSTarget] describeCustomDomainsResponse_vpcDNSTargets = Lens.lens (\DescribeCustomDomainsResponse' {vpcDNSTargets} -> vpcDNSTargets) (\s@DescribeCustomDomainsResponse' {} a -> s {vpcDNSTargets = a} :: DescribeCustomDomainsResponse) Prelude.. Lens.coerced instance Prelude.NFData DescribeCustomDomainsResponse where rnf DescribeCustomDomainsResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf dNSTarget `Prelude.seq` Prelude.rnf serviceArn `Prelude.seq` Prelude.rnf customDomains `Prelude.seq` Prelude.rnf vpcDNSTargets