API for Amazon Chime¶

ABAP Package	`/AWS1/API_CHE_IMPL`
ABAP SDK "TLA"	`CHE`
ABAP Interface	`/AWS1/IF_CHE`

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 Amazon Chime is CHE. 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 Chime 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¶

Most of these APIs are no longer supported and will not be updated. We recommend using the latest versions in the Amazon Chime SDK API reference, in the Amazon Chime SDK.

Using the latest versions requires migrating to dedicated namespaces. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

The Amazon Chime application programming interface (API) is designed so administrators can perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls for Amazon Chime. We recommend using an AWS SDK or the AWS CLI. The page for each API action contains a See Also section that includes links to information about using the action with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST APIs

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Chime, which is created with factory method /AWS1/CL_CHE_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_che)       = /aws1/cl_che_factory=>create( go_session ).

Your variable go_che is an instance of /AWS1/IF_CHE, and all of the operations in the Amazon Chime service are accessed by calling methods in /AWS1/IF_CHE.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_CHE.

IMPORTING¶

Required arguments:¶

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

Optional arguments:¶

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

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

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

RETURNING¶

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

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon Chime can be created via get_paginator() which returns a paginator object of type /AWS1/IF_CHE_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 Amazon Chime can be found in interface /AWS1/IF_CHE_PAGINATOR.