libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront
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.CloudFront.ListConflictingAliases

Description

Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.

Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.

To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Synopsis

Creating a Request

data ListConflictingAliases Source #

See: newListConflictingAliases smart constructor.

Constructors

ListConflictingAliases' 

Fields

  • marker :: Maybe Text

    Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

  • maxItems :: Maybe Int

    The maximum number of conflicting aliases that you want in the response.

  • distributionId :: Text

    The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.

  • alias :: Text

    The alias (also called a CNAME) to search for conflicting aliases.

Instances

Instances details
Eq ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Read ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Show ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Generic ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Associated Types

type Rep ListConflictingAliases :: Type -> Type #

NFData ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Methods

rnf :: ListConflictingAliases -> () #

Hashable ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

AWSRequest ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Associated Types

type AWSResponse ListConflictingAliases #

ToHeaders ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

ToPath ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

ToQuery ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

type Rep ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

type Rep ListConflictingAliases = D1 ('MetaData "ListConflictingAliases" "Amazonka.CloudFront.ListConflictingAliases" "libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront" 'False) (C1 ('MetaCons "ListConflictingAliases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "distributionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListConflictingAliases Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

newListConflictingAliases Source #

Create a value of ListConflictingAliases 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:marker:ListConflictingAliases', listConflictingAliases_marker - Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

$sel:maxItems:ListConflictingAliases', listConflictingAliases_maxItems - The maximum number of conflicting aliases that you want in the response.

$sel:distributionId:ListConflictingAliases', listConflictingAliases_distributionId - The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.

$sel:alias:ListConflictingAliases', listConflictingAliases_alias - The alias (also called a CNAME) to search for conflicting aliases.

Request Lenses

listConflictingAliases_marker :: Lens' ListConflictingAliases (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

listConflictingAliases_maxItems :: Lens' ListConflictingAliases (Maybe Int) Source #

The maximum number of conflicting aliases that you want in the response.

listConflictingAliases_distributionId :: Lens' ListConflictingAliases Text Source #

The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.

listConflictingAliases_alias :: Lens' ListConflictingAliases Text Source #

The alias (also called a CNAME) to search for conflicting aliases.

Destructuring the Response

data ListConflictingAliasesResponse Source #

See: newListConflictingAliasesResponse smart constructor.

Constructors

ListConflictingAliasesResponse' 

Fields

Instances

Instances details
Eq ListConflictingAliasesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Read ListConflictingAliasesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Show ListConflictingAliasesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Generic ListConflictingAliasesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

Associated Types

type Rep ListConflictingAliasesResponse :: Type -> Type #

NFData ListConflictingAliasesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

type Rep ListConflictingAliasesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListConflictingAliases

type Rep ListConflictingAliasesResponse = D1 ('MetaData "ListConflictingAliasesResponse" "Amazonka.CloudFront.ListConflictingAliases" "libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront" 'False) (C1 ('MetaCons "ListConflictingAliasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "conflictingAliasesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConflictingAliasesList)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newListConflictingAliasesResponse Source #

Create a value of ListConflictingAliasesResponse 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:conflictingAliasesList:ListConflictingAliasesResponse', listConflictingAliasesResponse_conflictingAliasesList - A list of conflicting aliases.

$sel:httpStatus:ListConflictingAliasesResponse', listConflictingAliasesResponse_httpStatus - The response's http status code.

Response Lenses