[ aws . connect ]

get-federation-token

Description

Retrieves a token for federation.

Note

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 Amazon Connect

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-federation-token
--instance-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Credentials -> (structure)

The credentials to use for federation.

AccessToken -> (string)

An access token generated for a federated user to access Amazon Connect.

AccessTokenExpiration -> (timestamp)

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

RefreshToken -> (string)

Renews a token generated for a user to access the Amazon Connect instance.

RefreshTokenExpiration -> (timestamp)

Renews the expiration timer for a generated token.