API for AWS SimSpace Weaver¶

ABAP Package	`/AWS1/API_SSW_IMPL`
ABAP SDK "TLA"	`SSW`
ABAP Interface	`/AWS1/IF_SSW`

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 SimSpace Weaver is SSW. 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 SimSpaceWeaver 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¶

SimSpace Weaver (SimSpace Weaver) is a service that you can use to build and run large-scale spatial simulations in the Amazon Web Services Cloud. For example, you can create crowd simulations, large real-world environments, and immersive and interactive experiences. For more information about SimSpace Weaver, see the SimSpace Weaver User Guide .

This API reference describes the API operations and data types that you can use to communicate directly with SimSpace Weaver.

SimSpace Weaver also provides the SimSpace Weaver app SDK, which you use for app development. The SimSpace Weaver app SDK API reference is included in the SimSpace Weaver app SDK documentation. This documentation is part of the SimSpace Weaver app SDK distributable package.

Using the SDK¶

In your code, create a client using the SDK module for AWS SimSpace Weaver, which is created with factory method /AWS1/CL_SSW_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_ssw)       = /aws1/cl_ssw_factory=>create( go_session ).

Your variable go_ssw is an instance of /AWS1/IF_SSW, and all of the operations in the AWS SimSpace Weaver service are accessed by calling methods in /AWS1/IF_SSW.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS SimSpace Weaver, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_SSW.

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_SSW` `/AWS1/IF_SSW`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS SimSpace Weaver can be created via get_paginator() which returns a paginator object of type /AWS1/IF_SSW_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 SimSpace Weaver can be found in interface /AWS1/IF_SSW_PAGINATOR.