Class AddClientIDToOpenIDConnectProviderCommandProtected

Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.

This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

Example

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

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

Param

AddClientIDToOpenIDConnectProviderCommandInput

Returns

AddClientIDToOpenIDConnectProviderCommandOutput

See

• AddClientIDToOpenIDConnectProviderCommandInput for command's input shape.
• AddClientIDToOpenIDConnectProviderCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

InvalidInputException (client fault)

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

Throws

LimitExceededException (client fault)

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.

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.

Example

To add a client ID (audience) to an Open-ID Connect (OIDC) provider

// The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:
const input = {
  "ClientID": "my-application-ID",
  "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com"
};
const command = new AddClientIDToOpenIDConnectProviderCommand(input);
await client.send(command);
// example id: 028e91f4-e2a6-4d59-9e3b-4965a3fb19be