Amazon WorkLink
API Reference (API Version 2018-09-25)

DescribeIdentityProviderConfiguration

Describes the identity provider configuration of the specified fleet.

Request Syntax

POST /describeIdentityProviderConfiguration HTTP/1.1 Content-type: application/json { "FleetArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

FleetArn

The ARN of the fleet.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "IdentityProviderSamlMetadata": "string", "IdentityProviderType": "string", "ServiceProviderSamlMetadata": "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.

IdentityProviderSamlMetadata

The SAML metadata document provided by the user’s identity provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 204800.

IdentityProviderType

The type of identity provider.

Type: String

Valid Values: SAML

ServiceProviderSamlMetadata

The SAML metadata document uploaded to the user’s identity provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 204800.

Errors

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

InternalServerErrorException

The service is temporarily unavailable.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

TooManyRequestsException

The number of requests exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this action.

HTTP Status Code: 403

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: