DeleteSAMLProviderCommand

Suggest an Edit

Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

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, DeleteSAMLProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, DeleteSAMLProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // DeleteSAMLProviderRequest
  SAMLProviderArn: "STRING_VALUE", // required
};
const command = new DeleteSAMLProviderCommand(input);
const response = await client.send(command);
// {};

DeleteSAMLProviderCommand Input

See DeleteSAMLProviderCommandInput for more details

Parameter
Type
Description
SAMLProviderArn
Required
string | undefined

The Amazon Resource Name (ARN) of the SAML provider to delete.

DeleteSAMLProviderCommand Output

See DeleteSAMLProviderCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidInputException
client

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

LimitExceededException
client

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

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.