API for AWS Control Catalog¶

ABAP Package	`/AWS1/API_CCG_IMPL`
ABAP SDK "TLA"	`CCG`
ABAP Interface	`/AWS1/IF_CCG`

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 Control Catalog is CCG. 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 ControlCatalog 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 Amazon Web Services Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Amazon Web Services Control Catalog.

Use the following links to get started with the Amazon Web Services Control Catalog API:

Actions: An alphabetical list of all Control Catalog API operations.
Data types: An alphabetical list of all Control Catalog data types.
Common parameters: Parameters that all operations can use.
Common errors: Client and server errors that all operations can return.

Using the SDK¶

In your code, create a client using the SDK module for AWS Control Catalog, which is created with factory method /AWS1/CL_CCG_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_ccg)       = /aws1/cl_ccg_factory=>create( go_session ).

Your variable go_ccg is an instance of /AWS1/IF_CCG, and all of the operations in the AWS Control Catalog service are accessed by calling methods in /AWS1/IF_CCG.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_CCG.

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_CCG` `/AWS1/IF_CCG`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Control Catalog can be created via get_paginator() which returns a paginator object of type /AWS1/IF_CCG_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 Control Catalog can be found in interface /AWS1/IF_CCG_PAGINATOR.