Amazon Redshift

2021/07/13 - Amazon Redshift - 4 new api methods

Changes  Release new APIs to support new Redshift feature - Authentication Profile

DeleteAuthenticationProfile (new) Link ¶

Deletes an authentication profile.

See also: AWS API Documentation

Request Syntax

client.delete_authentication_profile(
    AuthenticationProfileName='string'
)
type AuthenticationProfileName:

string

param AuthenticationProfileName:

[REQUIRED]

The name of the authentication profile to delete.

rtype:

dict

returns:

Response Syntax

{
    'AuthenticationProfileName': 'string'
}

Response Structure

  • (dict) --

    • AuthenticationProfileName (string) --

      The name of the authentication profile that was deleted.

CreateAuthenticationProfile (new) Link ¶

Creates an authentication profile with the specified parameters.

See also: AWS API Documentation

Request Syntax

client.create_authentication_profile(
    AuthenticationProfileName='string',
    AuthenticationProfileContent='string'
)
type AuthenticationProfileName:

string

param AuthenticationProfileName:

[REQUIRED]

The name of the authentication profile to be created.

type AuthenticationProfileContent:

string

param AuthenticationProfileContent:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'AuthenticationProfileName': 'string',
    'AuthenticationProfileContent': 'string'
}

Response Structure

  • (dict) --

    • AuthenticationProfileName (string) --

      The name of the authentication profile that was created.

    • AuthenticationProfileContent (string) --

      The content of the authentication profile in JSON format.

ModifyAuthenticationProfile (new) Link ¶

Modifies an authentication profile.

See also: AWS API Documentation

Request Syntax

client.modify_authentication_profile(
    AuthenticationProfileName='string',
    AuthenticationProfileContent='string'
)
type AuthenticationProfileName:

string

param AuthenticationProfileName:

[REQUIRED]

The name of the authentication profile to replace.

type AuthenticationProfileContent:

string

param AuthenticationProfileContent:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'AuthenticationProfileName': 'string',
    'AuthenticationProfileContent': 'string'
}

Response Structure

  • (dict) --

    • AuthenticationProfileName (string) --

      The name of the authentication profile that was replaced.

    • AuthenticationProfileContent (string) --

      The updated content of the authentication profile in JSON format.

DescribeAuthenticationProfiles (new) Link ¶

Describes an authentication profile.

See also: AWS API Documentation

Request Syntax

client.describe_authentication_profiles(
    AuthenticationProfileName='string'
)
type AuthenticationProfileName:

string

param AuthenticationProfileName:

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

rtype:

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.