Skip to content

IAM  >  Operations  >  get_open_id_connect_provider

get_open_id_connect_provider

Operation

get_open_id_connect_provider async

get_open_id_connect_provider(request: GetOpenIDConnectProviderInput | GetOpenIDConnectProviderInputDict, /, *, plugins: list[Plugin] | None = None) -> GetOpenIDConnectProviderOutput
get_open_id_connect_provider(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOpenIDConnectProviderInputDict]) -> GetOpenIDConnectProviderOutput

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

Parameters:

Name Type Description Default
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

Returns:

Type Description
GetOpenIDConnectProviderOutput

An instance of GetOpenIDConnectProviderOutput.

Input

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

Model

GetOpenIDConnectProviderInput dataclass

Bases: _SerdeShape

Dataclass for GetOpenIDConnectProviderInput structure.

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

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

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

Dictionaries

GetOpenIDConnectProviderInputDict

Bases: TypedDict

Dictionary form of GetOpenIDConnectProviderInput.

Attributes
open_id_connect_provider_arn instance-attribute
open_id_connect_provider_arn: Required[str]

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

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

Output

GetOpenIDConnectProviderOutput dataclass

Bases: _SerdeShape

Contains the response to a successful GetOpenIDConnectProvider request.

Attributes

client_id_list class-attribute instance-attribute
client_id_list: list[str] | None = ...

A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

create_date class-attribute instance-attribute
create_date: datetime | None = ...

The date and time when the IAM OIDC provider resource object was created in the Amazon Web Services account.

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.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

A list of tags that are attached to the specified IAM OIDC provider. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

thumbprint_list class-attribute instance-attribute
thumbprint_list: list[str] | None = ...

A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

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

The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.