QuickSight / Client / list_o_auth_client_applications

list_o_auth_client_applications¶

QuickSight.Client.list_o_auth_client_applications(**kwargs)¶

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

Request Syntax

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

Parameters:

AwsAccountId (string) –
[REQUIRED]

The Amazon Web Services account ID.
NextToken (string) – A pagination token that can be used in a subsequent request.
MaxResults (integer) – The maximum number of results to return.

Return type:

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.

Exceptions

QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidNextTokenException
QuickSight.Client.exceptions.InternalFailureException