API for Amazon Elastic Compute Cloud¶
| ABAP Package | /AWS1/API_EC2 |
|---|---|
| ABAP SDK "TLA" | EC2 |
| ABAP Interface | /AWS1/IF_EC2 |
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 Elastic Compute Cloud is EC2.
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 EC2 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 is the Amazon EC2 API Reference. It provides descriptions, API request parameters, and the XML response for each of the Amazon EC2 Query API actions. Note that the Amazon EC2 API includes actions for Amazon EC2 plus additional services, such as Amazon EBS and Amazon VPC.
Learn more
-
To learn about using the Query API, see Using the API for Amazon EC2.
-
To learn about the permissions required to call an Amazon EC2 API action, see Actions, resources, and condition keys for Amazon EC2.
-
To get the list of API actions by service and resource, see Actions by service.
-
To get the alphabetical list of API actions, see .
-
To get descriptions of the API error codes, see Error codes for the Amazon EC2 API.
Alternatively, use one of the following methods to access the Amazon EC2 API, instead of using the Query API directly:
Using the SDK¶
In your code, create a client using the SDK module for Amazon Elastic Compute Cloud, which is created with
factory method /AWS1/CL_EC2_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_ec2) = /aws1/cl_ec2_factory=>create( go_session ).
Your variable go_ec2 is an instance of /AWS1/IF_EC2,
and all of the operations
in the Amazon Elastic Compute Cloud service are accessed by calling methods in /AWS1/IF_EC2.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon Elastic Compute Cloud, see the Operation List.
Factory Method¶
/AWS1/CL_EC2_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_EC2.
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_ec2 /AWS1/IF_EC2¶
/AWS1/IF_EC2represents the ABAP client for the EC2 service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_ec2)->get_config( ).
lo_config is a variable of type /AWS1/CL_EC2_CONFIG. See the documentation for /AWS1/CL_EC2_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_EC2_WAITER.
Paginators¶
Paginators for Amazon Elastic Compute Cloud can be created via get_paginator() which returns a paginator object of type /AWS1/IF_EC2_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 Elastic Compute Cloud can be found in interface /AWS1/IF_EC2_PAGINATOR.