API for Amazon Polly¶

ABAP Package	`/AWS1/API_PLY_IMPL`
ABAP SDK "TLA"	`PLY`
ABAP Interface	`/AWS1/IF_PLY`

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 Polly is PLY. 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 Polly 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 Polly is a web service that makes it easy to synthesize speech from text.

The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Polly, which is created with factory method /AWS1/CL_PLY_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_ply)       = /aws1/cl_ply_factory=>create( go_session ).

Your variable go_ply is an instance of /AWS1/IF_PLY, and all of the operations in the Amazon Polly service are accessed by calling methods in /AWS1/IF_PLY.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_PLY.

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_PLY` `/AWS1/IF_PLY`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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