GetSAMLProviderCommand

Suggest an Edit

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

This operation requires Signature Version 4 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, GetSAMLProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, GetSAMLProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // GetSAMLProviderRequest
  SAMLProviderArn: "STRING_VALUE", // required
};
const command = new GetSAMLProviderCommand(input);
const response = await client.send(command);
// { // GetSAMLProviderResponse
//   SAMLProviderUUID: "STRING_VALUE",
//   SAMLMetadataDocument: "STRING_VALUE",
//   CreateDate: new Date("TIMESTAMP"),
//   ValidUntil: new Date("TIMESTAMP"),
//   Tags: [ // tagListType
//     { // Tag
//       Key: "STRING_VALUE", // required
//       Value: "STRING_VALUE", // required
//     },
//   ],
//   AssertionEncryptionMode: "Required" || "Allowed",
//   PrivateKeyList: [ // privateKeyList
//     { // SAMLPrivateKey
//       KeyId: "STRING_VALUE",
//       Timestamp: new Date("TIMESTAMP"),
//     },
//   ],
// };

GetSAMLProviderCommand Input

See GetSAMLProviderCommandInput for more details

Parameter
Type
Description
SAMLProviderArn
Required
string | undefined

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)  in the Amazon Web Services General Reference.

GetSAMLProviderCommand Output

See GetSAMLProviderCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AssertionEncryptionMode
AssertionEncryptionModeType | undefined

Specifies the encryption setting for the SAML provider.

CreateDate
Date | undefined

The date and time when the SAML provider was created.

PrivateKeyList
SAMLPrivateKey[] | undefined

The private key metadata for the SAML provider.

SAMLMetadataDocument
string | undefined

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

SAMLProviderUUID
string | undefined

The unique identifier assigned to the SAML provider.

Tags
Tag[] | undefined

A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources  in the IAM User Guide.

ValidUntil
Date | undefined

The expiration date and time for the SAML provider.

Throws

Name
Fault
Details
InvalidInputException
client

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

NoSuchEntityException
client

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

ServiceFailureException
server

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

IAMServiceException
Base exception class for all service exceptions from IAM service.