QuickSight / Client / describe_o_auth_client_application

describe_o_auth_client_application

QuickSight.Client.describe_o_auth_client_application(**kwargs)

Describes an OAuthClientApplication.

See also: AWS API Documentation

Request Syntax

response = client.describe_o_auth_client_application(
    AwsAccountId='string',
    OAuthClientApplicationId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID.

  • OAuthClientApplicationId (string) –

    [REQUIRED]

    The ID of the OAuthClientApplication that you want to describe.

Return type:

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.

Exceptions