API for AWS Resource Explorer¶

ABAP Package	`/AWS1/API_RE2_IMPL`
ABAP SDK "TLA"	`RE2`
ABAP Interface	`/AWS1/IF_RE2`

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 Resource Explorer is RE2. 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 Resource Explorer 2 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¶

Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can explore your resources using an internet search engine-like experience. Examples of resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB tables. You can search for your resources using resource metadata like names, tags, and IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn the service on, to simplify your cross-Region workloads.

Resource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which you turn on Resource Explorer. Resource Explorer creates and maintains an index in each Region, with the details of that Region's resources.

You can search across all of the indexed Regions in your account by designating one of your Amazon Web Services Regions to contain the aggregator index for the account. When you promote a local index in a Region to become the aggregator index for the account, Resource Explorer automatically replicates the index information from all local indexes in the other Regions to the aggregator index. Therefore, the Region with the aggregator index has a copy of all resource information for all Regions in the account where you turned on Resource Explorer. As a result, views in the aggregator index Region include resources from all of the indexed Regions in your account.

For more information about Amazon Web Services Resource Explorer, including how to enable and configure the service, see the Amazon Web Services Resource Explorer User Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS Resource Explorer, which is created with factory method /AWS1/CL_RE2_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_re2)       = /aws1/cl_re2_factory=>create( go_session ).

Your variable go_re2 is an instance of /AWS1/IF_RE2, and all of the operations in the AWS Resource Explorer service are accessed by calling methods in /AWS1/IF_RE2.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Resource Explorer, see the Operation List.

Factory Method¶

`/AWS1/CL_RE2_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_RE2.

IMPORTING¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE /AWS1/RT_PROTOCOL` `/AWS1/RT_PROTOCOL`¶

`IO_SESSION` `TYPE REF TO /AWS1/CL_RT_SESSION_BASE` `/AWS1/CL_RT_SESSION_BASE`¶

`IV_REGION` `TYPE /AWS1/RT_REGION_ID` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE /AWS1/RT_ENDPOINT` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO /AWS1/IF_RE2` `/AWS1/IF_RE2`¶

/AWS1/IF_RE2 represents the ABAP client for the Resource Explorer 2 service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Resource Explorer can be created via get_paginator() which returns a paginator object of type /AWS1/IF_RE2_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 Resource Explorer can be found in interface /AWS1/IF_RE2_PAGINATOR.