federation_tokens

Creates, updates, deletes, gets or lists a federation_tokens resource.

Overview

Name	federation_tokens
Type	Resource
Id	aws.connect.federation_tokens

Fields

The following fields are returned by SELECT queries:

get_federation_token

Name	Datatype	Description
credentials	object	The credentials to use for federation.
sign_in_url	string	The URL to sign into the user's instance.
user_arn	string	The Amazon Resource Name (ARN) of the user.
user_id	string	The identifier for the user. This can be the ID or the ARN of the user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_federation_token	select	instance_id, region		Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Connect Customer, see Configure SAML with IAM for Connect Customer in the Connect Customer Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Connect Customer

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)

SELECT examples

get_federation_token

Supports SAML sign-in for Connect Customer. Retrieves a token for federation. The token is for the Connect Customer user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Connect Customer, see Configure SAML with IAM for Connect Customer in the Connect Customer Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Connect Customer

SELECT
credentials,
sign_in_url,
user_arn,
user_id
FROM aws.connect.federation_tokens
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
;