AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect 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
Amazon Connect
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetFederationToken and EndGetFederationToken.
Namespace: Amazon.Connect
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z
public abstract Task<GetFederationTokenResponse> GetFederationTokenAsync( GetFederationTokenRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetFederationToken service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| DuplicateResourceException | A resource with the specified name already exists. |
| InternalServiceException | Request processing failed because of an error or failure with the service. |
| InvalidParameterException | One or more of the specified parameters are not valid. |
| InvalidRequestException | The request is not valid. |
| ResourceNotFoundException | The specified resource was not found. |
| UserNotFoundException | No user with the specified credentials was found in the Amazon Connect instance. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer