API for Amazon Managed Blockchain¶
| ABAP Package | /AWS1/API_MBC_IMPL |
|---|---|
| ABAP SDK "TLA" | MBC |
| ABAP Interface | /AWS1/IF_MBC |
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 Managed Blockchain is MBC.
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 ManagedBlockchain 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 Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.
Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as CreateMember and DeleteMember don't apply to Ethereum.
The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.
Using the SDK¶
In your code, create a client using the SDK module for Amazon Managed Blockchain, which is created with
factory method /AWS1/CL_MBC_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_mbc) = /aws1/cl_mbc_factory=>create( go_session ).
Your variable go_mbc is an instance of /AWS1/IF_MBC,
and all of the operations
in the Amazon Managed Blockchain service are accessed by calling methods in /AWS1/IF_MBC.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon Managed Blockchain, see the Operation List.
Factory Method¶
/AWS1/CL_MBC_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_MBC.
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_MBC /AWS1/IF_MBC¶
/AWS1/IF_MBCrepresents the ABAP client for the ManagedBlockchain service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_mbc)->get_config( ).
lo_config is a variable of type /AWS1/CL_MBC_CONFIG. See the documentation for /AWS1/CL_MBC_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon Managed Blockchain can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_MBC_PAGINATOR`](./_AWS1_IF_MBC_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 Managed Blockchain can be found in interface [`/AWS1/IF_MBC_PAGINATOR`](./_AWS1_IF_MBC_PAGINATOR.md).