API for Amazon CodeCatalyst¶

ABAP Package	`/AWS1/API_CAT`
ABAP SDK "TLA"	`CAT`
ABAP Interface	`/AWS1/IF_CAT`

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 CodeCatalyst is CAT. 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 CodeCatalyst 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 CodeCatalyst is in preview release and subject to change.

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst API to work with the following objects.

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

CreateAccessToken, which creates a personal access token (PAT) for the current user.
CreateDevEnvironment, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
CreateProject which creates a project in a specified space.
CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
DeleteDevEnvironment, which deletes a Dev Environment.
GetDevEnvironment, which returns information about a Dev Environment.
GetProject, which returns information about a project.
GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source repository.
GetSubscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
ListDevEnvironments, which retrives a list of Dev Environments in a project.
ListProjects, which retrieves a list of projects in a space.
ListSourceRepositories, which retrieves a list of source repositories in a project.
ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
ListSpaces, which retrieves a list of spaces.
StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.
StartDevEnvironmentSession, which starts a session to a specified Dev Environment.
StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.
StopDevEnvironmentSession, which stops a session for a specified Dev Environment.
UpdateDevEnvironment, which changes one or more values for a Dev Environment.
VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

DeleteAccessToken, which deletes a specified personal access token (PAT).
ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.
ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.

Using the SDK¶

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

Your variable go_cat is an instance of /AWS1/IF_CAT, and all of the operations in the Amazon CodeCatalyst service are accessed by calling methods in /AWS1/IF_CAT.

API Operations¶

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

Factory Method¶

`/AWS1/CL_CAT_FACTORY=>CREATE( )`¶

Creates an object of type /AWS1/IF_CAT.

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_CAT`¶

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