Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DeleteOpenIDConnectProviderCommandProtected

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.

This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.

Example

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

import { IAMClient, DeleteOpenIDConnectProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, DeleteOpenIDConnectProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // DeleteOpenIDConnectProviderRequest
OpenIDConnectProviderArn: "STRING_VALUE", // required
};
const command = new DeleteOpenIDConnectProviderCommand(input);
const response = await client.send(command);
// {};

Param

DeleteOpenIDConnectProviderCommandInput

Returns

DeleteOpenIDConnectProviderCommandOutput

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