API for AWS Certificate Manager Private Certificate Authority¶

ABAP Package	`/AWS1/API_ACP_IMPL`
ABAP SDK "TLA"	`ACP`
ABAP Interface	`/AWS1/IF_ACP`

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 Certificate Manager Private Certificate Authority is ACP. 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 ACM PCA 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 is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.

The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.

Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.

To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.

Using the SDK¶

In your code, create a client using the SDK module for AWS Certificate Manager Private Certificate Authority, which is created with factory method /AWS1/CL_ACP_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_acp)       = /aws1/cl_acp_factory=>create( go_session ).

Your variable go_acp is an instance of /AWS1/IF_ACP, and all of the operations in the AWS Certificate Manager Private Certificate Authority service are accessed by calling methods in /AWS1/IF_ACP.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Certificate Manager Private Certificate Authority, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_ACP.

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_ACP` `/AWS1/IF_ACP`¶

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

Configuring Programmatically¶

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

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

Waiters¶

Waiters for Implementation can be accessed via get_waiter() method followed by the waiter method to be called.

Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_ACP_WAITER.

Paginators¶

Paginators for AWS Certificate Manager Private Certificate Authority can be created via get_paginator() which returns a paginator object of type /AWS1/IF_ACP_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 Certificate Manager Private Certificate Authority can be found in interface /AWS1/IF_ACP_PAGINATOR.