Skip to content

API for AWS Support App

ABAP Package /AWS1/API_SUA_IMPL
ABAP SDK "TLA" SUA
ABAP Interface /AWS1/IF_SUA

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 Support App is SUA. 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 Support App 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 Support App in Slack

You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can perform the following tasks directly in your Slack channel:

  • Create, search, update, and resolve your support cases

  • Request service quota increases for your account

  • Invite Amazon Web Services Support agents to your channel so that you can chat directly about your support cases

For more information about how to perform these actions in Slack, see the following documentation in the Amazon Web Services Support User Guide:

You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack configurations. For more information, see Authorize a Slack workspace to enable the Amazon Web Services Support App.

  • You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API.

  • For more information about the Amazon Web Services Support App endpoints, see the Amazon Web Services Support App in Slack endpoints in the Amazon Web Services General Reference.

Using the SDK

In your code, create a client using the SDK module for AWS Support App, which is created with factory method /AWS1/CL_SUA_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_sua)       = /aws1/cl_sua_factory=>create( go_session ).

Your variable go_sua is an instance of /AWS1/IF_SUA, and all of the operations in the AWS Support App service are accessed by calling methods in /AWS1/IF_SUA.

API Operations

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

Factory Method

/AWS1/CL_SUA_FACTORY=>create( )

Creates an object of type /AWS1/IF_SUA.

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_SUA /AWS1/IF_SUA

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

Configuring Programmatically

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

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

Paginators

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