API for Amazon DynamoDB¶
| ABAP Package | /AWS1/API_DYN_IMPL |
|---|---|
| ABAP SDK "TLA" | DYN |
| ABAP Interface | /AWS1/IF_DYN |
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 DynamoDB is DYN.
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 DynamoDB 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 DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the Amazon Web Services Management Console to monitor resource utilization and performance metrics.
DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an Amazon Web Services Region, providing built-in high availability and data durability.
Using the SDK¶
In your code, create a client using the SDK module for Amazon DynamoDB, which is created with
factory method /AWS1/CL_DYN_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_dyn) = /aws1/cl_dyn_factory=>create( go_session ).
Your variable go_dyn is an instance of /AWS1/IF_DYN,
and all of the operations
in the Amazon DynamoDB service are accessed by calling methods in /AWS1/IF_DYN.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon DynamoDB, see the Operation List.
Factory Method¶
/AWS1/CL_DYN_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_DYN.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IV_REGION TYPE /AWS1/RT_REGION_ID /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
OO_CLIENT TYPE REF TO /AWS1/IF_DYN /AWS1/IF_DYN¶
/AWS1/IF_DYNrepresents the ABAP client for the DynamoDB service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_dyn)->get_config( ).
lo_config is a variable of type /AWS1/CL_DYN_CONFIG. See the documentation for /AWS1/CL_DYN_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_DYN_WAITER`](./_AWS1_IF_DYN_WAITER.md).
Paginators¶
Paginators for Amazon DynamoDB can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_DYN_PAGINATOR`](./_AWS1_IF_DYN_PAGINATOR.md). 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 DynamoDB can be found in interface [`/AWS1/IF_DYN_PAGINATOR`](./_AWS1_IF_DYN_PAGINATOR.md).