Skip to content

API for AWS Resource Groups

ABAP Package /AWS1/API_RGR_IMPL
ABAP SDK "TLA" RGR
ABAP Interface /AWS1/IF_RGR

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 Groups is RGR. 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 Groups 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

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member resources.

To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.

For more information about Resource Groups, see the Resource Groups User Guide.

Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.

  • Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities

  • Applying, editing, and removing tags from resource groups

  • Resolving resource group member ARNs so they can be returned as search results

  • Getting data about resources that are members of a group

  • Searching Amazon Web Services resources based on a resource query

Using the SDK

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

Your variable go_rgr is an instance of /AWS1/IF_RGR, and all of the operations in the AWS Resource Groups service are accessed by calling methods in /AWS1/IF_RGR.

API Operations

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

Factory Method

/AWS1/CL_RGR_FACTORY=>create( )

Creates an object of type /AWS1/IF_RGR.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE

IV_REGION TYPE /AWS1/RT_REGION_ID

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_RGR

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

Configuring Programmatically

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

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

Paginators

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