Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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

Request Syntax


{
   "workgroupNames": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

workgroupNames

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: [a-z0-9-]+

Required: Yes

Response Syntax


{
   "expirationTime": "string",
   "token": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

expirationTime

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

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

Type: Timestamp

token

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

The submitted action has conflicts.

HTTP Status Code: 400

DryRunException

This exception is thrown when the request was successful, but dry run was enabled so no action was taken.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

resourceName: The name of the resource that could not be found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400