CREATEWORKLOADSHARE()`¶

About CreateWorkloadShare¶

Create a workload share.

The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.

If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.

For more information, see Sharing a workload in the Well-Architected Tool User Guide.

Method Signature¶

METHODS /AWS1/IF_WAD~CREATEWORKLOADSHARE
  IMPORTING
    !IV_WORKLOADID TYPE /AWS1/WADWORKLOADID OPTIONAL
    !IV_SHAREDWITH TYPE /AWS1/WADSHAREDWITH OPTIONAL
    !IV_PERMISSIONTYPE TYPE /AWS1/WADPERMISSIONTYPE OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/WADCLIENTREQUESTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wadcreworkloadshare01
  RAISING
    /AWS1/CX_WADACCESSDENIEDEX
    /AWS1/CX_WADCONFLICTEXCEPTION
    /AWS1/CX_WADINTERNALSERVEREX
    /AWS1/CX_WADRESOURCENOTFOUNDEX
    /AWS1/CX_WADSERVICEQUOTAEXCDEX
    /AWS1/CX_WADTHROTTLINGEX
    /AWS1/CX_WADVALIDATIONEX
    /AWS1/CX_WADCLIENTEXC
    /AWS1/CX_WADSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workloadid` `TYPE /AWS1/WADWORKLOADID` `/AWS1/WADWORKLOADID`¶

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

`iv_sharedwith` `TYPE /AWS1/WADSHAREDWITH` `/AWS1/WADSHAREDWITH`¶

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

`iv_permissiontype` `TYPE /AWS1/WADPERMISSIONTYPE` `/AWS1/WADPERMISSIONTYPE`¶

Permission granted on a share request.

`iv_clientrequesttoken` `TYPE /AWS1/WADCLIENTREQUESTTOKEN` `/AWS1/WADCLIENTREQUESTTOKEN`¶

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wadcreworkloadshare01` `/AWS1/CL_WADCREWORKLOADSHARE01`¶

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->createworkloadshare(
  iv_clientrequesttoken = |string|
  iv_permissiontype = |string|
  iv_sharedwith = |string|
  iv_workloadid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_workloadid = lo_result->get_workloadid( ).
  lv_shareid = lo_result->get_shareid( ).
ENDIF.

/AWS1/IF_WAD=>CREATEWORKLOADSHARE()¶