Skip to content

/AWS1/IF_R53=>LISTTRAFPOLICYINSTSBYPOLICY()

About ListTrafficPolicyInstancesByPolicy

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

Method Signature

METHODS /AWS1/IF_R53~LISTTRAFPOLICYINSTSBYPOLICY
  IMPORTING
    !IV_TRAFFICPOLICYID TYPE /AWS1/R53TRAFFICPOLICYID OPTIONAL
    !IV_TRAFFICPOLICYVERSION TYPE /AWS1/R53TRAFFICPOLICYVERSION OPTIONAL
    !IV_HOSTEDZONEIDMARKER TYPE /AWS1/R53RESOURCEID OPTIONAL
    !IV_TRAFPOLICYINSTNAMEMARKER TYPE /AWS1/R53DNSNAME OPTIONAL
    !IV_TRAFPOLICYINSTTYPEMARKER TYPE /AWS1/R53RRTYPE OPTIONAL
    !IV_MAXITEMS TYPE /AWS1/R53INTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_r53lsttrfplyinstsby03
  RAISING
    /AWS1/CX_R53INVALIDINPUT
    /AWS1/CX_R53NOSUCHTRAFPOLICY
    /AWS1/CX_R53NOSUCHTRAFPLYINST
    /AWS1/CX_R53CLIENTEXC
    /AWS1/CX_R53SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_trafficpolicyid TYPE /AWS1/R53TRAFFICPOLICYID /AWS1/R53TRAFFICPOLICYID

The ID of the traffic policy for which you want to list traffic policy instances.

iv_trafficpolicyversion TYPE /AWS1/R53TRAFFICPOLICYVERSION /AWS1/R53TRAFFICPOLICYVERSION

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

Optional arguments:

iv_hostedzoneidmarker TYPE /AWS1/R53RESOURCEID /AWS1/R53RESOURCEID

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

iv_trafpolicyinstnamemarker TYPE /AWS1/R53DNSNAME /AWS1/R53DNSNAME

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

iv_trafpolicyinsttypemarker TYPE /AWS1/R53RRTYPE /AWS1/R53RRTYPE

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

iv_maxitems TYPE /AWS1/R53INTEGER /AWS1/R53INTEGER

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

RETURNING

oo_output TYPE REF TO /aws1/cl_r53lsttrfplyinstsby03 /AWS1/CL_R53LSTTRFPLYINSTSBY03

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->listtrafpolicyinstsbypolicy(
  iv_hostedzoneidmarker = |string|
  iv_maxitems = 123
  iv_trafficpolicyid = |string|
  iv_trafficpolicyversion = 123
  iv_trafpolicyinstnamemarker = |string|
  iv_trafpolicyinsttypemarker = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_trafficpolicyinstances( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_trafficpolicyinstanceid = lo_row_1->get_id( ).
      lv_resourceid = lo_row_1->get_hostedzoneid( ).
      lv_dnsname = lo_row_1->get_name( ).
      lv_ttl = lo_row_1->get_ttl( ).
      lv_trafficpolicyinstancest = lo_row_1->get_state( ).
      lv_message = lo_row_1->get_message( ).
      lv_trafficpolicyid = lo_row_1->get_trafficpolicyid( ).
      lv_trafficpolicyversion = lo_row_1->get_trafficpolicyversion( ).
      lv_rrtype = lo_row_1->get_trafficpolicytype( ).
    ENDIF.
  ENDLOOP.
  lv_resourceid = lo_result->get_hostedzoneidmarker( ).
  lv_dnsname = lo_result->get_trafpolicyinstnamemarker( ).
  lv_rrtype = lo_result->get_trafpolicyinsttypemarker( ).
  lv_pagetruncated = lo_result->get_istruncated( ).
  lv_integer = lo_result->get_maxitems( ).
ENDIF.