API for AWS CodeStar Notifications¶
|ABAP SDK "TLA"
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
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
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
In this example we will assume you have configured
an SDK profile in transaction
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_stn) = /aws1/cl_stn_factory=>create( go_session ).
For an overview of ABAP method calls corresponding to API operations in AWS CodeStar Notifications, see the Operation List.
Creates an object of type
TYPE REF TO
TYPE REF TO
/AWS1/IF_STNrepresents the ABAP client for the codestar notifications service, representing each operation as a method call. For more information see the API Page page.
DATA(lo_config) = DATA(go_stn)->get_config( ).
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
Details about the paginator methods available for service AWS CodeStar Notifications can be found in interface