API for AWS CodeStar Notifications¶

ABAP Package	`/AWS1/API_STN_IMPL`
ABAP SDK "TLA"	`STN`
ABAP Interface	`/AWS1/IF_STN`

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 CodeStar Notifications is STN. 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 codestar notifications 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¶

This CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the CodeStar Notifications API. You can use the CodeStar Notifications API to work with the following objects:

Notification rules, by calling the following:

CreateNotificationRule, which creates a notification rule for a resource in your account.
DeleteNotificationRule, which deletes a notification rule.
DescribeNotificationRule, which provides information about a notification rule.
ListNotificationRules, which lists the notification rules associated with your account.
UpdateNotificationRule, which changes the name, events, or targets associated with a notification rule.
Subscribe, which subscribes a target to a notification rule.
Unsubscribe, which removes a target from a notification rule.

Targets, by calling the following:

DeleteTarget, which removes a notification rule target from a notification rule.
ListTargets, which lists the targets associated with a notification rule.

Events, by calling the following:

ListEventTypes, which lists the event types you can include in a notification rule.

Tags, by calling the following:

ListTagsForResource, which lists the tags already associated with a notification rule in your account.
TagResource, which associates a tag you provide with a notification rule in your account.
UntagResource, which removes a tag from a notification rule in your account.

For information about how to use CodeStar Notifications, see the Amazon Web Services Developer Tools Console User Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS CodeStar Notifications, which is created with factory method /AWS1/CL_STN_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_stn)       = /aws1/cl_stn_factory=>create( go_session ).

Your variable go_stn is an instance of /AWS1/IF_STN, and all of the operations in the AWS CodeStar Notifications service are accessed by calling methods in /AWS1/IF_STN.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_STN.

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_STN` `/AWS1/IF_STN`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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