QuickSight / Client / update_o_auth_client_application

update_o_auth_client_application

QuickSight.Client.update_o_auth_client_application(**kwargs)

Updates an OAuthClientApplication.

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID.

  • OAuthClientApplicationId (string) –

    [REQUIRED]

    The ID of the OAuthClientApplication that you want to update.

  • Name (string) –

    [REQUIRED]

    The display name for the OAuthClientApplication.

  • ClientId (string) – The client ID of the OAuth application that is registered with the identity provider.

  • ClientSecret (string) – The client secret of the OAuth application that is registered with the identity provider.

  • 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) – [REQUIRED]

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

Return type:

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.

Exceptions