Skip to content

remove_client_id_from_open_id_connect_provider

Operation

remove_client_id_from_open_id_connect_provider

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.

Parameters:

Name Type Description Default
request RemoveClientIDFromOpenIDConnectProviderInput | RemoveClientIDFromOpenIDConnectProviderInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[RemoveClientIDFromOpenIDConnectProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RemoveClientIDFromOpenIDConnectProviderOutput

An instance of RemoveClientIDFromOpenIDConnectProviderOutput.

remove_client_id_from_open_id_connect_provider async

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.

Parameters:

Name Type Description Default
request RemoveClientIDFromOpenIDConnectProviderInput | RemoveClientIDFromOpenIDConnectProviderInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[RemoveClientIDFromOpenIDConnectProviderInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RemoveClientIDFromOpenIDConnectProviderOutput

An instance of RemoveClientIDFromOpenIDConnectProviderOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

RemoveClientIDFromOpenIDConnectProviderInputDict

Bases: TypedDict

Dictionary form of RemoveClientIDFromOpenIDConnectProviderInput.

Attributes

client_id instance-attribute
client_id: Required[str]

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

open_id_connect_provider_arn instance-attribute
open_id_connect_provider_arn: Required[str]

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.

RemoveClientIDFromOpenIDConnectProviderInput dataclass

Bases: _SerdeShape

Dataclass for RemoveClientIDFromOpenIDConnectProviderInput structure.

Attributes

client_id class-attribute instance-attribute
client_id: str | None = ...

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

open_id_connect_provider_arn class-attribute instance-attribute
open_id_connect_provider_arn: str | None = ...

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.

Output

RemoveClientIDFromOpenIDConnectProviderOutput dataclass

Bases: _SerdeShape

Dataclass for RemoveClientIDFromOpenIDConnectProviderOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.