LISTZONALSHIFTS()`¶

About ListZonalShifts¶

Lists all active and completed zonal shifts in Amazon Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that ARC started on your behalf for zonal autoshift.

For more information about listing autoshifts, see ">ListAutoshifts.

Method Signature¶

METHODS /AWS1/IF_AZS~LISTZONALSHIFTS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/AZSSTRING OPTIONAL
    !IV_STATUS TYPE /AWS1/AZSZONALSHIFTSTATUS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/AZSMAXRESULTS OPTIONAL
    !IV_RESOURCEIDENTIFIER TYPE /AWS1/AZSRESOURCEIDENTIFIER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_azslistzonalshiftsrsp
  RAISING
    /AWS1/CX_AZSACCESSDENIEDEX
    /AWS1/CX_AZSINTERNALSERVEREX
    /AWS1/CX_AZSTHROTTLINGEX
    /AWS1/CX_AZSVALIDATIONEX
    /AWS1/CX_AZSCLIENTEXC
    /AWS1/CX_AZSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/AZSSTRING` `/AWS1/AZSSTRING`¶

Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

`iv_status` `TYPE /AWS1/AZSZONALSHIFTSTATUS` `/AWS1/AZSZONALSHIFTSTATUS`¶

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

ACTIVE: The zonal shift has been started and is active.

EXPIRED: The zonal shift has expired (the expiry time was exceeded).

CANCELED: The zonal shift was canceled.

`iv_maxresults` `TYPE /AWS1/AZSMAXRESULTS` `/AWS1/AZSMAXRESULTS`¶

The number of objects that you want to return with this call.

`iv_resourceidentifier` `TYPE /AWS1/AZSRESOURCEIDENTIFIER` `/AWS1/AZSRESOURCEIDENTIFIER`¶

The identifier for the resource that you want to list zonal shifts for. The identifier is the Amazon Resource Name (ARN) for the resource.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_azslistzonalshiftsrsp` `/AWS1/CL_AZSLISTZONALSHIFTSRSP`¶

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->listzonalshifts(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_resourceidentifier = |string|
  iv_status = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_zonalshiftid = lo_row_1->get_zonalshiftid( ).
      lv_resourceidentifier = lo_row_1->get_resourceidentifier( ).
      lv_availabilityzone = lo_row_1->get_awayfrom( ).
      lv_expirytime = lo_row_1->get_expirytime( ).
      lv_starttime = lo_row_1->get_starttime( ).
      lv_zonalshiftstatus = lo_row_1->get_status( ).
      lv_zonalshiftcomment = lo_row_1->get_comment( ).
      lv_shifttype = lo_row_1->get_shifttype( ).
      lv_practicerunoutcome = lo_row_1->get_practicerunoutcome( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_AZS=>LISTZONALSHIFTS()¶