API for AWS ARC - Zonal Shift

ABAP Package	/AWS1/API_AZS
ABAP SDK "TLA"	AZS
ABAP Interface	/AWS1/IF_AZS

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for AWS ARC - Zonal Shift is AZS. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the ARC Zonal Shift module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Application Recovery Controller (ARC).

You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.

You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.

For more information about using zonal shift and zonal autoshift, see the Amazon Application Recovery Controller Developer Guide.

Using the SDK

In your code, create a client using the SDK module for AWS ARC - Zonal Shift, which is created with factory method /AWS1/CL_AZS_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_azs)       = /aws1/cl_azs_factory=>create( go_session ).

Your variable go_azs is an instance of /AWS1/IF_AZS, and all of the operations in the AWS ARC - Zonal Shift service are accessed by calling methods in /AWS1/IF_AZS.

API Operations

For an overview of ABAP method calls corresponding to API operations in AWS ARC - Zonal Shift, see the Operation List.

Factory Method

/AWS1/CL_AZS_FACTORY=>create( )

Creates an object of type /AWS1/IF_AZS.

IMPORTING

Optional arguments:

iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

RETURNING

oo_client TYPE REF TO /aws1/if_azs /AWS1/IF_AZS

/AWS1/IF_AZS represents the ABAP client for the ARC Zonal Shift service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_azs)->get_config( ).

lo_config is a variable of type /AWS1/CL_AZS_CONFIG. See the documentation for /AWS1/CL_AZS_CONFIG for details on the settings that can be configured.

Paginators

Paginators for AWS ARC - Zonal Shift can be created via get_paginator() which returns a paginator object of type /AWS1/IF_AZS_PAGINATOR. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using has_next() and get_next() methods.

Details about the paginator methods available for service AWS ARC - Zonal Shift can be found in interface /AWS1/IF_AZS_PAGINATOR.