IAM / Client / get_open_id_connect_provider

get_open_id_connect_provider#

IAM.Client.get_open_id_connect_provider(**kwargs)#

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

Request Syntax

response = client.get_open_id_connect_provider(
    OpenIDConnectProviderArn='string'
)

Parameters:

OpenIDConnectProviderArn (string) –

[REQUIRED]

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.

Return type:

dict

Returns:

Response Syntax

{
    'Url': 'string',
    'ClientIDList': [
        'string',
    ],
    'ThumbprintList': [
        'string',
    ],
    'CreateDate': datetime(2015, 1, 1),
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –

Contains the response to a successful GetOpenIDConnectProvider request.
- Url (string) –
  
  The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.
- ClientIDList (list) –
  
  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.
  - (string) –
- ThumbprintList (list) –
  
  A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.
  - (string) –
    
    Contains a thumbprint for an identity provider’s server certificate.
    
    The identity provider’s server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate. This thumbprint is used by the domain where the OpenID Connect provider makes its keys available. The thumbprint is always a 40-character string.
- CreateDate (datetime) –
  
  The date and time when the IAM OIDC provider resource object was created in the Amazon Web Services account.
- Tags (list) –
  
  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.
  - (dict) –
    
    A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    - Key (string) –
      
      The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.
    - Value (string) –
      
      The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.
      
      Note
      
      Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

Exceptions

IAM.Client.exceptions.InvalidInputException
IAM.Client.exceptions.NoSuchEntityException
IAM.Client.exceptions.ServiceFailureException