Get Identity Center Auth Token

redshiftserverless_get_identity_center_auth_token

R Documentation

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

Description¶

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.

Usage¶

redshiftserverless_get_identity_center_auth_token(workgroupNames)

Arguments¶

workgroupNames

[required] 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.

Value¶

A list with the following syntax:

list(
  expirationTime = as.POSIXct(
    "2015-01-01"
  ),
  token = "string"
)

Request syntax¶

svc$get_identity_center_auth_token(
  workgroupNames = list(
    "string"
  )
)