RedshiftServerless / Client / get_identity_center_auth_token

get_identity_center_auth_token

RedshiftServerless.Client.get_identity_center_auth_token(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_identity_center_auth_token(
    workgroupNames=[
        'string',
    ]
)
Parameters:

workgroupNames (list) –

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

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'expirationTime': datetime(2015, 1, 1),
    'token': 'string'
}

Response Structure

  • (dict) –

    • expirationTime (datetime) –

      The date and time when the Identity Center authentication token expires.

      After this time, a new token must be requested for continued access.

    • token (string) –

      The Identity Center authentication token that can be used to access data in the specified workgroups.

      This token contains the Identity Center identity information and is encrypted for secure transmission.

Exceptions

  • RedshiftServerless.Client.exceptions.InternalServerException

  • RedshiftServerless.Client.exceptions.ResourceNotFoundException

  • RedshiftServerless.Client.exceptions.ValidationException

  • RedshiftServerless.Client.exceptions.ConflictException

  • RedshiftServerless.Client.exceptions.AccessDeniedException

  • RedshiftServerless.Client.exceptions.DryRunException

  • RedshiftServerless.Client.exceptions.ThrottlingException