IAM / Client / get_saml_provider

get_saml_provider#

IAM.Client.get_saml_provider(**kwargs)#

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

Note

This operation requires Signature Version 4.

Request Syntax

response = client.get_saml_provider(
    SAMLProviderArn='string'
)

Parameters:

SAMLProviderArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

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

Return type:

dict

Returns:

Response Syntax

{
    'SAMLMetadataDocument': 'string',
    'CreateDate': datetime(2015, 1, 1),
    'ValidUntil': datetime(2015, 1, 1),
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –

Contains the response to a successful GetSAMLProvider request.
- SAMLMetadataDocument (string) –
  
  The XML metadata document that includes information about an identity provider.
- CreateDate (datetime) –
  
  The date and time when the SAML provider was created.
- ValidUntil (datetime) –
  
  The expiration date and time for the SAML provider.
- Tags (list) –
  
  A list of tags that are attached to the specified IAM SAML 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.NoSuchEntityException
IAM.Client.exceptions.InvalidInputException
IAM.Client.exceptions.ServiceFailureException