Skip to content

API for AWS Marketplace Reporting Service

ABAP Package /AWS1/API_MPR_IMPL
ABAP SDK "TLA" MPR
ABAP Interface /AWS1/IF_MPR

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 Reporting Service is MPR. 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 Reporting 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 Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights dashboard programmatically. The API gets the agreement and cost analysis dashboards with data for all of the Amazon Web Services accounts in your Amazon Web Services Organization.

To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:

  • Enable all features for your organization. For more information, see Enabling all features for an organization with Organizations, in the Organizations User Guide.

  • Call the service as the Organizations management account or an account registered as a delegated administrator for the procurement insights service.

    For more information about management accounts, see Tutorial: Creating and configuring an organization and Managing the management account with Organizations, both in the Organizations User Guide.

    For more information about delegated administrators, see Using delegated administrators, in the Amazon Web Services Marketplace Buyer Guide.

  • Create an IAM policy that enables the aws-marketplace:GetBuyerDashboard and organizations:DescribeOrganization permissions. In addition, the management account requires the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create. For more information about creating the policy, see Policies and permissions in Identity and Access Management, in the IAM User Guide.

    Access can be shared only by registering the desired linked account as a delegated administrator. That requires organizations:RegisterDelegatedAdministrator organizations:ListDelegatedAdministrators and organizations:DeregisterDelegatedAdministrator permissions.

  • Use the Amazon Web Services Marketplace console to create the AWSServiceRoleForProcurementInsightsPolicy service-linked role. The role enables Amazon Web Services Marketplace procurement visibility integration. The management account requires an IAM policy with the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create the service-linked role and enable the service access. For more information, see Granting access to Organizations and Service-linked role to share procurement data in the Amazon Web Services Marketplace Buyer Guide.

  • After creating the service-linked role, you must enable trusted access that grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information, see Granting access to Organizations in the Amazon Web Services Marketplace Buyer Guide.

Using the SDK

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

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

API Operations

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

Factory Method

/AWS1/CL_MPR_FACTORY=>create( )

Creates an object of type /AWS1/IF_MPR.

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_MPR /AWS1/IF_MPR

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

Configuring Programmatically

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

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