Skip to content

/AWS1/IF_RSS=>GETIDENTITYCENTERAUTHTOKEN()

About GetIdentityCenterAuthToken

Returns an Identity Center authentication token for accessing Amazon Redshift Serverless workgroups.

The token provides secure access to data within the specified workgroups using Identity Center identity propagation. The token expires after a specified duration and must be refreshed for continued access.

The Identity and Access Management (IAM) user or role that runs GetIdentityCenterAuthToken must have appropriate permissions to access the specified workgroups and Identity Center integration must be configured for the workgroups.

Method Signature

METHODS /AWS1/IF_RSS~GETIDENTITYCENTERAUTHTOKEN
  IMPORTING
    !IT_WORKGROUPNAMES TYPE /AWS1/CL_RSSWORKGRPNAMELIST_W=>TT_WORKGROUPNAMELIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rssgetidcenauthtokrsp
  RAISING
    /AWS1/CX_RSSACCESSDENIEDEX
    /AWS1/CX_RSSCONFLICTEXCEPTION
    /AWS1/CX_RSSDRYRUNEXCEPTION
    /AWS1/CX_RSSINTERNALSERVEREX
    /AWS1/CX_RSSRESOURCENOTFOUNDEX
    /AWS1/CX_RSSTHROTTLINGEX
    /AWS1/CX_RSSVALIDATIONEX
    /AWS1/CX_RSSCLIENTEXC
    /AWS1/CX_RSSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

it_workgroupnames TYPE /AWS1/CL_RSSWORKGRPNAMELIST_W=>TT_WORKGROUPNAMELIST TT_WORKGROUPNAMELIST

A list of workgroup names for which to generate the Identity Center authentication token.

Constraints:

  • Must contain between 1 and 20 workgroup names.

  • Each workgroup name must be a valid Amazon Redshift Serverless workgroup identifier.

  • All specified workgroups must have Identity Center integration enabled.

RETURNING

oo_output TYPE REF TO /aws1/cl_rssgetidcenauthtokrsp /AWS1/CL_RSSGETIDCENAUTHTOKRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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->getidentitycenterauthtoken(
  it_workgroupnames = VALUE /aws1/cl_rssworkgrpnamelist_w=>tt_workgroupnamelist(
    ( new /aws1/cl_rssworkgrpnamelist_w( |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_token( ).
  lv_timestamp = lo_result->get_expirationtime( ).
ENDIF.