AWS API Changes

2026/05/29 - Amazon QuickSight - 5 new api methods

Changes Adds support for creating, updating, describing, listing, and deleting an OAuthClientApplication resource, a new quicksight resource that allows customers to store OAuth configurations to connect to their databases via 3 Legged OAuth.

ListOAuthClientApplications (new)

Link ¶

Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_o_auth_client_applications(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The Amazon Web Services account ID.

type NextToken:

string

param NextToken:

A pagination token that can be used in a subsequent request.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

rtype:

dict

returns:

Response Syntax

{
    'OAuthClientApplications': [
        {
            'OAuthClientApplicationId': 'string',
            'Name': 'string',
            'OAuthClientAuthenticationType': 'TOKEN',
            'DataSourceType': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
            'IdentityProviderVpcConnectionProperties': {
                'VpcConnectionArn': 'string'
            },
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Arn': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- OAuthClientApplications (list) --
  
  A list of OAuthClientApplication summaries.
  - (dict) --
    
    A summary of an OAuthClientApplication.
    - OAuthClientApplicationId (string) --
      
      The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
    - Name (string) --
      
      The display name of the OAuthClientApplication.
    - OAuthClientAuthenticationType (string) --
      
      The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.
    - DataSourceType (string) --
      
      The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
    - IdentityProviderVpcConnectionProperties (dict) --
      
      VPC connection properties.
      - VpcConnectionArn (string) --
        
        The Amazon Resource Name (ARN) for the VPC connection.
    - CreatedTime (datetime) --
      
      The time that the OAuthClientApplication was created.
    - LastUpdatedTime (datetime) --
      
      The time that the OAuthClientApplication was last updated.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the OAuthClientApplication.
- NextToken (string) --
  
  A pagination token that can be used in a subsequent request.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

CreateOAuthClientApplication (new)

Link ¶

Creates an OAuthClientApplication.

See also: AWS API Documentation

Request Syntax

client.create_o_auth_client_application(
    AwsAccountId='string',
    OAuthClientApplicationId='string',
    Name='string',
    OAuthClientAuthenticationType='TOKEN',
    ClientId='string',
    ClientSecret='string',
    OAuthTokenEndpointUrl='string',
    OAuthAuthorizationEndpointUrl='string',
    OAuthScopes='string',
    DataSourceType='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
    IdentityProviderVpcConnectionProperties={
        'VpcConnectionArn': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The Amazon Web Services account ID.

type OAuthClientApplicationId:

string

param OAuthClientApplicationId:

[REQUIRED]

An ID for the OAuthClientApplication that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

type Name:

string

param Name:

[REQUIRED]

The display name for the OAuthClientApplication.

type OAuthClientAuthenticationType:

string

param OAuthClientAuthenticationType:

[REQUIRED]

The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.

type ClientId:

string

param ClientId:

[REQUIRED]

The client ID of the OAuth application that is registered with the identity provider.

type ClientSecret:

string

param ClientSecret:

[REQUIRED]

The client secret of the OAuth application that is registered with the identity provider.

type OAuthTokenEndpointUrl:

string

param OAuthTokenEndpointUrl:

[REQUIRED]

The token endpoint URL of the identity provider that is used to obtain access tokens.

type OAuthAuthorizationEndpointUrl:

string

param OAuthAuthorizationEndpointUrl:

The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

type OAuthScopes:

string

param OAuthScopes:

The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

type DataSourceType:

string

param DataSourceType:

The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

type IdentityProviderVpcConnectionProperties:

dict

param IdentityProviderVpcConnectionProperties:

VPC connection properties.

VpcConnectionArn (string) -- [REQUIRED]

The Amazon Resource Name (ARN) for the VPC connection.

type Tags:

list

param Tags:

Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

(dict) --

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
- Key (string) -- [REQUIRED]
  
  Tag key.
- Value (string) -- [REQUIRED]
  
  Tag value.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'OAuthClientApplicationId': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the OAuthClientApplication.
- OAuthClientApplicationId (string) --
  
  The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
- CreationStatus (string) --
  
  The status of creating the OAuthClientApplication.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

UpdateOAuthClientApplication (new)

Link ¶

Updates an OAuthClientApplication.

See also: AWS API Documentation

Request Syntax

client.update_o_auth_client_application(
    AwsAccountId='string',
    OAuthClientApplicationId='string',
    Name='string',
    ClientId='string',
    ClientSecret='string',
    OAuthTokenEndpointUrl='string',
    OAuthAuthorizationEndpointUrl='string',
    OAuthScopes='string',
    DataSourceType='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
    IdentityProviderVpcConnectionProperties={
        'VpcConnectionArn': 'string'
    }
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The Amazon Web Services account ID.

type OAuthClientApplicationId:

string

param OAuthClientApplicationId:

[REQUIRED]

The ID of the OAuthClientApplication that you want to update.

type Name:

string

param Name:

[REQUIRED]

The display name for the OAuthClientApplication.

type ClientId:

string

param ClientId:

The client ID of the OAuth application that is registered with the identity provider.

type ClientSecret:

string

param ClientSecret:

The client secret of the OAuth application that is registered with the identity provider.

type OAuthTokenEndpointUrl:

string

param OAuthTokenEndpointUrl:

The token endpoint URL of the identity provider that is used to obtain access tokens.

type OAuthAuthorizationEndpointUrl:

string

param OAuthAuthorizationEndpointUrl:

The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

type OAuthScopes:

string

param OAuthScopes:

The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

type DataSourceType:

string

param DataSourceType:

The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

type IdentityProviderVpcConnectionProperties:

dict

param IdentityProviderVpcConnectionProperties:

VPC connection properties.

VpcConnectionArn (string) -- [REQUIRED]

The Amazon Resource Name (ARN) for the VPC connection.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'OAuthClientApplicationId': 'string',
    'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the OAuthClientApplication.
- OAuthClientApplicationId (string) --
  
  The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
- UpdateStatus (string) --
  
  The status of updating the OAuthClientApplication.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

DescribeOAuthClientApplication (new)

Link ¶

Describes an OAuthClientApplication.

See also: AWS API Documentation

Request Syntax

client.describe_o_auth_client_application(
    AwsAccountId='string',
    OAuthClientApplicationId='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The Amazon Web Services account ID.

type OAuthClientApplicationId:

string

param OAuthClientApplicationId:

[REQUIRED]

The ID of the OAuthClientApplication that you want to describe.

rtype:

dict

returns:

Response Syntax

{
    'OAuthClientApplication': {
        'OAuthClientApplicationId': 'string',
        'Name': 'string',
        'OAuthClientAuthenticationType': 'TOKEN',
        'OAuthTokenEndpointUrl': 'string',
        'OAuthAuthorizationEndpointUrl': 'string',
        'OAuthScopes': 'string',
        'DataSourceType': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'S3_TABLES'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
        'IdentityProviderVpcConnectionProperties': {
            'VpcConnectionArn': 'string'
        },
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'Arn': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- OAuthClientApplication (dict) --
  
  The information about the OAuthClientApplication.
  - OAuthClientApplicationId (string) --
    
    The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  - Name (string) --
    
    The display name of the OAuthClientApplication.
  - OAuthClientAuthenticationType (string) --
    
    The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.
  - OAuthTokenEndpointUrl (string) --
    
    The token endpoint URL of the identity provider that is used to obtain access tokens.
  - OAuthAuthorizationEndpointUrl (string) --
    
    The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
  - OAuthScopes (string) --
    
    The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.
  - DataSourceType (string) --
    
    The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
  - IdentityProviderVpcConnectionProperties (dict) --
    
    VPC connection properties.
    - VpcConnectionArn (string) --
      
      The Amazon Resource Name (ARN) for the VPC connection.
  - CreatedTime (datetime) --
    
    The time that the OAuthClientApplication was created.
  - LastUpdatedTime (datetime) --
    
    The time that the OAuthClientApplication was last updated.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the OAuthClientApplication.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

DeleteOAuthClientApplication (new)

Link ¶

Deletes an OAuthClientApplication.

See also: AWS API Documentation

Request Syntax

client.delete_o_auth_client_application(
    AwsAccountId='string',
    OAuthClientApplicationId='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The Amazon Web Services account ID.

type OAuthClientApplicationId:

string

param OAuthClientApplicationId:

[REQUIRED]

The ID of the OAuthClientApplication that you want to delete.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'OAuthClientApplicationId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the OAuthClientApplication that you deleted.
- OAuthClientApplicationId (string) --
  
  The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.