Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetSAMLProviderCommandProtected

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

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
// SAMLMetadataDocument: "STRING_VALUE",
// CreateDate: new Date("TIMESTAMP"),
// ValidUntil: new Date("TIMESTAMP"),
// Tags: [ // tagListType
// { // Tag
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// };

Param

GetSAMLProviderCommandInput

Returns

GetSAMLProviderCommandOutput

See

Throws

InvalidInputException (client fault)

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

Throws

NoSuchEntityException (client fault)

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

Throws

ServiceFailureException (server fault)

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

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods