API for Braket

ABAP Package	/AWS1/API_BRK
ABAP SDK "TLA"	BRK
ABAP Interface	/AWS1/IF_BRK

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 Braket is BRK. 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 Braket 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

The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.

To learn about the permissions required to call an Amazon Braket API action, see Actions, resources, and condition keys for Amazon Braket. Amazon Braket Python SDK and the AWS Command Line Interface can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see What is Amazon Braket? and important terms and concepts in the Amazon Braket Developer Guide.

In this guide:

• CommonParameters

• CommonErrors

Available languages for AWS SDK:

• .NET

• C++

• Go API reference

• Java

• JavaScript

• PHP

• Python (Boto)

• Ruby

Code examples from the Amazon Braket Tutorials GitHub repository:

• Amazon Braket Examples

Using the SDK

In your code, create a client using the SDK module for Braket, which is created with factory method /AWS1/CL_BRK_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_brk)       = /aws1/cl_brk_factory=>create( go_session ).

Your variable go_brk is an instance of /AWS1/IF_BRK, and all of the operations in the Braket service are accessed by calling methods in /AWS1/IF_BRK.

API Operations

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

Factory Method

/AWS1/CL_BRK_FACTORY=>create( )

Creates an object of type /AWS1/IF_BRK.

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_brk /AWS1/IF_BRK

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

Configuring Programmatically

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

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

Paginators

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