RemoveClientIDFromOpenIDConnectProviderCommand

Suggest an Edit

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 Syntax

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);
// {};

RemoveClientIDFromOpenIDConnectProviderCommand Input

See RemoveClientIDFromOpenIDConnectProviderCommandInput for more details

Parameter
Type
Description
ClientID
Required
string | undefined

The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider.

OpenIDConnectProviderArn
Required
string | undefined

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs)  in the Amazon Web Services General Reference.

RemoveClientIDFromOpenIDConnectProviderCommand Output

See RemoveClientIDFromOpenIDConnectProviderCommandOutput 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.

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.