Menu
AWS Identity and Access Management
API Reference (API Version 2010-05-08)

GetSAMLProvider

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

Note

This operation requires Signature Version 4.

Request Parameters

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

SAMLProviderArn

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Type: String

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

Required: Yes

Response Elements

The following elements are returned by the service.

CreateDate

The date and time when the SAML provider was created.

Type: Timestamp

SAMLMetadataDocument

The XML metadata document that includes information about an identity provider.

Type: String

Length Constraints: Minimum length of 1000. Maximum length of 10000000.

ValidUntil

The expiration date and time for the SAML provider.

Type: Timestamp

Errors

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

InvalidInput

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

NoSuchEntity

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

HTTP Status Code: 404

ServiceFailure

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

HTTP Status Code: 500

Example

Sample Request

Copy
https://iam.amazonaws.com/?Action=GetSAMLProvider &Name=arn:aws:iam::123456789012:saml-provider/MyUniversity &Version=2010-05-08 &AUTHPARAMS

Sample Response

Copy
<GetSAMLProviderResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/"> <GetSAMLProviderResult> <CreateDate>2012-05-09T16:27:11Z</CreateDate> <ValidUntil>2015-12-31T211:59:59Z</ValidUntil> <SAMLMetadataDocument>Pd9fexDssTkRgGNqs...DxptfEs==</SAMLMetadataDocument> </GetSAMLProviderResult> <ResponseMetadata> <RequestId>29f47818-99f5-11e1-a4c3-27EXAMPLE804</RequestId> </ResponseMetadata> </GetSAMLProviderResponse>

See Also

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