- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListSAMLProvidersCommand
Lists the SAML provider resource objects defined in IAM in the account. IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a SAML provider, see GetSAMLProvider.
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, ListSAMLProvidersCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, ListSAMLProvidersCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = {};
const command = new ListSAMLProvidersCommand(input);
const response = await client.send(command);
// { // ListSAMLProvidersResponse
// SAMLProviderList: [ // SAMLProviderListType
// { // SAMLProviderListEntry
// Arn: "STRING_VALUE",
// ValidUntil: new Date("TIMESTAMP"),
// CreateDate: new Date("TIMESTAMP"),
// },
// ],
// };
ListSAMLProvidersCommand Input
See ListSAMLProvidersCommandInput for more details
ListSAMLProvidersCommandInput extends ListSAMLProvidersRequest
ListSAMLProvidersCommand Output
See ListSAMLProvidersCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
SAMLProviderList | SAMLProviderListEntry[] | undefined | The list of SAML provider resource objects defined in IAM for this Amazon Web Services account. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
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. |