get_open_id_connect_provider¶
Operation¶
get_open_id_connect_provider
¶
get_open_id_connect_provider(request: GetOpenIDConnectProviderInput | GetOpenIDConnectProviderInputDict | None = None, /, *, 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 |
|---|---|---|---|
request
|
GetOpenIDConnectProviderInput | GetOpenIDConnectProviderInputDict | 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[GetOpenIDConnectProviderInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetOpenIDConnectProviderOutput
|
An instance of |
get_open_id_connect_provider
async
¶
get_open_id_connect_provider(request: GetOpenIDConnectProviderInput | GetOpenIDConnectProviderInputDict | None = None, /, *, 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 |
|---|---|---|---|
request
|
GetOpenIDConnectProviderInput | GetOpenIDConnectProviderInputDict | 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[GetOpenIDConnectProviderInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetOpenIDConnectProviderOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetOpenIDConnectProviderInputDict
¶
Bases: TypedDict
Dictionary form of GetOpenIDConnectProviderInput.
Attributes¶
open_id_connect_provider_arn
instance-attribute
¶
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.
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.
Output¶
GetOpenIDConnectProviderOutput
dataclass
¶
Bases: _SerdeShape
Contains the response to a successful GetOpenIDConnectProvider request.
Attributes¶
client_id_list
class-attribute
instance-attribute
¶
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
¶
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
¶
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
¶
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.