/AWS1/IF_FNT=>LISTCONFLICTINGALIASES()¶
About ListConflictingAliases¶
The ListConflictingAliases API operation only supports standard distributions. To list domain conflicts for both standard distributions and distribution tenants, we recommend that you use the ListDomainConflicts API operation instead.
Gets a list of aliases that conflict or overlap with the provided alias, and the associated CloudFront standard distribution and Amazon Web Services accounts for each conflicting alias. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name.
In the returned list, the standard distribution and account IDs are partially hidden, which allows you to identify the standard distribution and accounts that you own, and 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, specify the alias to search and the ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias. For more information, including how to set up the standard distribution and certificate, see Moving an alternate domain name to a different standard distribution or distribution tenant 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.
Method Signature¶
METHODS /AWS1/IF_FNT~LISTCONFLICTINGALIASES
IMPORTING
!IV_DISTRIBUTIONID TYPE /AWS1/FNTDISTRIBUTIONIDSTRING OPTIONAL
!IV_ALIAS TYPE /AWS1/FNTALIASSTRING OPTIONAL
!IV_MARKER TYPE /AWS1/FNTSTRING OPTIONAL
!IV_MAXITEMS TYPE /AWS1/FNTLSTCNFLALIASESMAXIT00 OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fntlistcnflaliasesrs
RAISING
/AWS1/CX_FNTINVALIDARGUMENT
/AWS1/CX_FNTNOSUCHDISTRIBUTION
/AWS1/CX_FNTCLIENTEXC
/AWS1/CX_FNTSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_distributionid TYPE /AWS1/FNTDISTRIBUTIONIDSTRING /AWS1/FNTDISTRIBUTIONIDSTRING¶
The ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias.
iv_alias TYPE /AWS1/FNTALIASSTRING /AWS1/FNTALIASSTRING¶
The alias (also called a CNAME) to search for conflicting aliases.
Optional arguments:¶
iv_marker TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING¶
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
NextMarkerfrom the current page's response.
iv_maxitems TYPE /AWS1/FNTLSTCNFLALIASESMAXIT00 /AWS1/FNTLSTCNFLALIASESMAXIT00¶
The maximum number of conflicting aliases that you want in the response.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_fntlistcnflaliasesrs /AWS1/CL_FNTLISTCNFLALIASESRS¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
Examples¶
Syntax Example¶
This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.
DATA(lo_result) = lo_client->listconflictingaliases(
iv_alias = |string|
iv_distributionid = |string|
iv_marker = |string|
iv_maxitems = 123
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lo_conflictingaliaseslist = lo_result->get_conflictingaliaseslist( ).
IF lo_conflictingaliaseslist IS NOT INITIAL.
lv_string = lo_conflictingaliaseslist->get_nextmarker( ).
lv_integer = lo_conflictingaliaseslist->get_maxitems( ).
lv_integer = lo_conflictingaliaseslist->get_quantity( ).
LOOP AT lo_conflictingaliaseslist->get_items( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_string = lo_row_1->get_alias( ).
lv_string = lo_row_1->get_distributionid( ).
lv_string = lo_row_1->get_accountid( ).
ENDIF.
ENDLOOP.
ENDIF.
ENDIF.