API for AWS Marketplace Agreement Service¶

ABAP Package	`/AWS1/API_MPG_IMPL`
ABAP SDK "TLA"	`MPG`
ABAP Interface	`/AWS1/IF_MPG`

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 Marketplace Agreement Service is MPG. 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 Marketplace Agreement 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¶

AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including listing, searching, and filtering agreements.

To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and Access Management (IAM) policies and roles are set up. The user must have the required policies/permissions that allow them to carry out the actions in AWS:

DescribeAgreement – Grants permission to users to obtain detailed meta data about any of their agreements.
GetAgreementTerms – Grants permission to users to obtain details about the terms of an agreement.
SearchAgreements – Grants permission to users to search through all their agreements.

Using the SDK¶

In your code, create a client using the SDK module for AWS Marketplace Agreement Service, which is created with factory method /AWS1/CL_MPG_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_mpg)       = /aws1/cl_mpg_factory=>create( go_session ).

Your variable go_mpg is an instance of /AWS1/IF_MPG, and all of the operations in the AWS Marketplace Agreement Service service are accessed by calling methods in /AWS1/IF_MPG.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Marketplace Agreement Service, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_MPG.

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_MPG` `/AWS1/IF_MPG`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Marketplace Agreement Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_MPG_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 Marketplace Agreement Service can be found in interface /AWS1/IF_MPG_PAGINATOR.