API for AWS Elemental MediaPackage v2¶

ABAP Package	`/AWS1/API_MD2_IMPL`
ABAP SDK "TLA"	`MD2`
ABAP Interface	`/AWS1/IF_MD2`

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 AWS Elemental MediaPackage v2 is MD2. 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 MediaPackageV2 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 guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2.

The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like "v2", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.

If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the MediaPackage v1 Live API Reference.

This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.

We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS Elemental MediaPackage v2, which is created with factory method /AWS1/CL_MD2_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_md2)       = /aws1/cl_md2_factory=>create( go_session ).

Your variable go_md2 is an instance of /AWS1/IF_MD2, and all of the operations in the AWS Elemental MediaPackage v2 service are accessed by calling methods in /AWS1/IF_MD2.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Elemental MediaPackage v2, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_MD2.

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_MD2` `/AWS1/IF_MD2`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Elemental MediaPackage v2 can be created via get_paginator() which returns a paginator object of type /AWS1/IF_MD2_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 AWS Elemental MediaPackage v2 can be found in interface /AWS1/IF_MD2_PAGINATOR.