API for AWS Chatbot¶

ABAP Package	`/AWS1/API_CBO_IMPL`
ABAP SDK "TLA"	`CBO`
ABAP Interface	`/AWS1/IF_CBO`

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 Chatbot is CBO. 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 chatbot 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¶

The AWS Chatbot API Reference provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.

AWS Chatbot APIs are currently available in the following Regions:

US East (Ohio) - us-east-2
US West (Oregon) - us-west-2
Asia Pacific (Singapore) - ap-southeast-1
Europe (Ireland) - eu-west-1

The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions.

Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.

Using the SDK¶

In your code, create a client using the SDK module for AWS Chatbot, which is created with factory method /AWS1/CL_CBO_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_cbo)       = /aws1/cl_cbo_factory=>create( go_session ).

Your variable go_cbo is an instance of /AWS1/IF_CBO, and all of the operations in the AWS Chatbot service are accessed by calling methods in /AWS1/IF_CBO.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_CBO.

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_CBO` `/AWS1/IF_CBO`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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