API for Amazon EC2 Container Service¶

ABAP Package	`/AWS1/API_ECS_IMPL`
ABAP SDK "TLA"	`ECS`
ABAP Interface	`/AWS1/IF_ECS`

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 EC2 Container Service is ECS. 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 ECS 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 Elastic Container Service

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.

Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.

Using the SDK¶

In your code, create a client using the SDK module for Amazon EC2 Container Service, which is created with factory method /AWS1/CL_ECS_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_ecs)       = /aws1/cl_ecs_factory=>create( go_session ).

Your variable go_ecs is an instance of /AWS1/IF_ECS, and all of the operations in the Amazon EC2 Container Service service are accessed by calling methods in /AWS1/IF_ECS.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_ECS.

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_ECS` `/AWS1/IF_ECS`¶

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

Configuring Programmatically¶

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

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

Waiters¶

Waiters for Implementation can be accessed via get_waiter() method followed by the waiter method to be called.

Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_ECS_WAITER.

Paginators¶

Paginators for Amazon EC2 Container Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_ECS_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 Amazon EC2 Container Service can be found in interface /AWS1/IF_ECS_PAGINATOR.