Skip to content

API for AWS CodeStar

ABAP Package /AWS1/API_STR_IMPL
ABAP SDK "TLA" STR
ABAP Interface /AWS1/IF_STR

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 is STR. 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 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

AWS CodeStar

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

  • DeleteProject, which deletes a project.

  • DescribeProject, which lists the attributes of a project.

  • ListProjects, which lists all projects associated with your AWS account.

  • ListResources, which lists the resources associated with a project.

  • ListTagsForProject, which lists the tags associated with a project.

  • TagProject, which adds tags to a project.

  • UntagProject, which removes tags from a project.

  • UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

  • AssociateTeamMember, which adds an IAM user to the team for a project.

  • DisassociateTeamMember, which removes an IAM user from the team for a project.

  • ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.

  • UpdateTeamMember, which updates a team member's attributes in a project.

Users, by calling the following:

  • CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.

  • DeleteUserProfile, which deletes all user profile information across all projects.

  • DescribeUserProfile, which describes the profile of a user.

  • ListUserProfiles, which lists all user profiles.

  • UpdateUserProfile, which updates the profile for a user.

Using the SDK

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

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

API Operations

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

Factory Method

/AWS1/CL_STR_FACTORY=>create( )

Creates an object of type /AWS1/IF_STR.

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_STR /AWS1/IF_STR

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

Configuring Programmatically

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

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