API for AWS Cloud9¶

ABAP Package	`/AWS1/API_CL9_IMPL`
ABAP SDK "TLA"	`CL9`
ABAP Interface	`/AWS1/IF_CL9`

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 Cloud9 is CL9. 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 Cloud9 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¶

Cloud9

Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

For more information about Cloud9, see the Cloud9 User Guide.

Cloud9 supports these operations:

CreateEnvironmentEC2: Creates an Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.
CreateEnvironmentMembership: Adds an environment member to an environment.
DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.
DeleteEnvironmentMembership: Deletes an environment member from an environment.
DescribeEnvironmentMemberships: Gets information about environment members for an environment.
DescribeEnvironments: Gets information about environments.
DescribeEnvironmentStatus: Gets status information for an environment.
ListEnvironments: Gets a list of environment identifiers.
ListTagsForResource: Gets the tags for an environment.
TagResource: Adds tags to an environment.
UntagResource: Removes tags from an environment.
UpdateEnvironment: Changes the settings of an existing environment.
UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.

Using the SDK¶

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

Your variable go_cl9 is an instance of /AWS1/IF_CL9, and all of the operations in the AWS Cloud9 service are accessed by calling methods in /AWS1/IF_CL9.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_CL9.

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_CL9` `/AWS1/IF_CL9`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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