Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class RemoveClientIDFromOpenIDConnectProviderCommandProtected

Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.

This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.

Example

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

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

Param

RemoveClientIDFromOpenIDConnectProviderCommandInput

Returns

RemoveClientIDFromOpenIDConnectProviderCommandOutput

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