ATTACHDATASOURCE()`¶

About AttachDataSource¶

Attaches a data source to an OpenSearch application. The data source can be an Amazon OpenSearch Service domain or an Amazon OpenSearch Serverless collection. If both the application and data source are in the ACTIVE state, the attachment completes immediately and returns a status of ATTACHED. If either resource is not yet active, the operation stores the request and returns a status of PENDING. A background process then completes the attachment when both resources become active. Pending attachments that are not completed within 24 hours are marked as FAILED. This operation is idempotent. If a data source is already attached or pending for the same application, the existing attachment is returned.

Method Signature¶

METHODS /AWS1/IF_OSR~ATTACHDATASOURCE
  IMPORTING
    !IV_ID TYPE /AWS1/OSRID OPTIONAL
    !IV_DATASOURCEARN TYPE /AWS1/OSRARN OPTIONAL
    !IV_WORKSPACEID TYPE /AWS1/OSRSTRING OPTIONAL
    !IO_WORKSPACECONFIGURATION TYPE REF TO /AWS1/CL_OSRWORKSPACECONFINPUT OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/OSRCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrattchdatasourcersp
  RAISING
    /AWS1/CX_OSRACCESSDENIEDEX
    /AWS1/CX_OSRCONFLICTEXCEPTION
    /AWS1/CX_OSRDISABLEDOPEX
    /AWS1/CX_OSRINTERNALEXCEPTION
    /AWS1/CX_OSRRESOURCENOTFOUNDEX
    /AWS1/CX_OSRVALIDATIONEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_id` `TYPE /AWS1/OSRID` `/AWS1/OSRID`¶

The unique identifier or name of the OpenSearch application to attach the data source to. This is the same identifier used with UpdateApplication, GetApplication, and DeleteApplication.

`iv_datasourcearn` `TYPE /AWS1/OSRARN` `/AWS1/OSRARN`¶

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.

Optional arguments:¶

`iv_workspaceid` `TYPE /AWS1/OSRSTRING` `/AWS1/OSRSTRING`¶

The identifier of an existing workspace to update with the new data source. Mutually exclusive with workspaceConfiguration.

`io_workspaceconfiguration` `TYPE REF TO /AWS1/CL_OSRWORKSPACECONFINPUT` `/AWS1/CL_OSRWORKSPACECONFINPUT`¶

Configuration for creating a new workspace during the attachment. If specified, a workspace is created and linked to the data source after the attachment completes. Mutually exclusive with workspaceId.

`iv_clienttoken` `TYPE /AWS1/OSRCLIENTTOKEN` `/AWS1/OSRCLIENTTOKEN`¶

A unique, case-sensitive identifier to ensure idempotency of the request. If you retry a request with the same client token and the same parameters, the retry succeeds without performing any further actions.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osrattchdatasourcersp` `/AWS1/CL_OSRATTCHDATASOURCERSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->attachdatasource(
  io_workspaceconfiguration = new /aws1/cl_osrworkspaceconfinput(
    iv_name = |string|
    iv_workspacetype = |string|
  )
  iv_clienttoken = |string|
  iv_datasourcearn = |string|
  iv_id = |string|
  iv_workspaceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_attachmentid( ).
  lv_id = lo_result->get_id( ).
  lv_arn = lo_result->get_arn( ).
  lv_arn = lo_result->get_datasourcearn( ).
  lv_datasourceattachmentsta = lo_result->get_status( ).
ENDIF.

/AWS1/IF_OSR=>ATTACHDATASOURCE()¶