Redshift / Client / describe_authentication_profiles

describe_authentication_profiles#

Redshift.Client.describe_authentication_profiles(**kwargs)#

Describes an authentication profile.

See also: AWS API Documentation

Request Syntax

response = client.describe_authentication_profiles(
    AuthenticationProfileName='string'
)
Parameters:

AuthenticationProfileName (string) – The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.

Return type:

dict

Returns:

Response Syntax

{
    'AuthenticationProfiles': [
        {
            'AuthenticationProfileName': 'string',
            'AuthenticationProfileContent': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • AuthenticationProfiles (list) –

      The list of authentication profiles.

      • (dict) –

        Describes an authentication profile.

        • AuthenticationProfileName (string) –

          The name of the authentication profile.

        • AuthenticationProfileContent (string) –

          The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

Exceptions

  • Redshift.Client.exceptions.AuthenticationProfileNotFoundFault

  • Redshift.Client.exceptions.InvalidAuthenticationProfileRequestFault