o_auth_client_applications

Creates, updates, deletes, gets or lists an o_auth_client_applications resource.

Overview

Name	o_auth_client_applications
Type	Resource
Id	aws.quicksight.o_auth_client_applications

Fields

The following fields are returned by SELECT queries:

describe_o_auth_client_application

Name	Datatype	Description
o_auth_client_application	object	The information about the OAuthClientApplication.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

list_o_auth_client_applications

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the OAuthClientApplication.
created_time	string (date-time)	The time that the OAuthClientApplication was created.
data_source_type	string	The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE. (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)
identity_provider_vpc_connection_properties	object	VPC connection properties.
last_updated_time	string (date-time)	The time that the OAuthClientApplication was last updated.
name	string	The display name of the OAuthClientApplication.
o_auth_client_application_id	string	The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. (pattern: <code>[^/][^\p{Cc}]*</code>)
o_auth_client_authentication_type	string	The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN. (TOKEN)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_o_auth_client_application	select	aws_account_id, o_auth_client_application_id, region		Describes an OAuthClientApplication.
list_o_auth_client_applications	select	aws_account_id, region	next-token, max-results	Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account.
create_o_auth_client_application	insert	aws_account_id, region, OAuthClientApplicationId, OAuthClientAuthenticationType, ClientId, ClientSecret, OAuthTokenEndpointUrl		Creates an OAuthClientApplication.
update_o_auth_client_application	update	aws_account_id, o_auth_client_application_id, region		Updates an OAuthClientApplication.
delete_o_auth_client_application	delete	aws_account_id, o_auth_client_application_id, region		Deletes an OAuthClientApplication.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The Amazon Web Services account ID.
o_auth_client_application_id	string	The ID of the OAuthClientApplication that you want to delete.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return.
next-token	string	A pagination token that can be used in a subsequent request.

SELECT examples

describe_o_auth_client_application

Describes an OAuthClientApplication.

SELECT
o_auth_client_application,
request_id,
status
FROM aws.quicksight.o_auth_client_applications
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND o_auth_client_application_id = '{{ o_auth_client_application_id }}' -- required
AND region = '{{ region }}' -- required
;

list_o_auth_client_applications

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

SELECT
arn,
created_time,
data_source_type,
identity_provider_vpc_connection_properties,
last_updated_time,
name,
o_auth_client_application_id,
o_auth_client_authentication_type
FROM aws.quicksight.o_auth_client_applications
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_o_auth_client_application

Creates an OAuthClientApplication.

INSERT INTO aws.quicksight.o_auth_client_applications (
OAuthClientApplicationId,
Name,
OAuthClientAuthenticationType,
ClientId,
ClientSecret,
OAuthTokenEndpointUrl,
OAuthAuthorizationEndpointUrl,
OAuthScopes,
DataSourceType,
IdentityProviderVpcConnectionProperties,
Tags,
aws_account_id,
region
)
SELECT 
'{{ OAuthClientApplicationId }}' /* required */,
'{{ Name }}',
'{{ OAuthClientAuthenticationType }}' /* required */,
'{{ ClientId }}' /* required */,
'{{ ClientSecret }}' /* required */,
'{{ OAuthTokenEndpointUrl }}' /* required */,
'{{ OAuthAuthorizationEndpointUrl }}',
'{{ OAuthScopes }}',
'{{ DataSourceType }}',
'{{ IdentityProviderVpcConnectionProperties }}',
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
creation_status,
o_auth_client_application_id,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: o_auth_client_applications
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the o_auth_client_applications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the o_auth_client_applications resource.
  - name: OAuthClientApplicationId
    value: "{{ OAuthClientApplicationId }}"
  - name: Name
    value: "{{ Name }}"
  - name: OAuthClientAuthenticationType
    value: "{{ OAuthClientAuthenticationType }}"
    valid_values: ['TOKEN']
  - name: ClientId
    value: "{{ ClientId }}"
  - name: ClientSecret
    value: "{{ ClientSecret }}"
  - name: OAuthTokenEndpointUrl
    value: "{{ OAuthTokenEndpointUrl }}"
  - name: OAuthAuthorizationEndpointUrl
    value: "{{ OAuthAuthorizationEndpointUrl }}"
  - name: OAuthScopes
    value: "{{ OAuthScopes }}"
  - name: DataSourceType
    value: "{{ DataSourceType }}"
    valid_values: ['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']
  - name: IdentityProviderVpcConnectionProperties
    description: |
      VPC connection properties.
    value:
      VpcConnectionArn: "{{ VpcConnectionArn }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_o_auth_client_application

Updates an OAuthClientApplication.

UPDATE aws.quicksight.o_auth_client_applications
SET 
Name = '{{ Name }}',
ClientId = '{{ ClientId }}',
ClientSecret = '{{ ClientSecret }}',
OAuthTokenEndpointUrl = '{{ OAuthTokenEndpointUrl }}',
OAuthAuthorizationEndpointUrl = '{{ OAuthAuthorizationEndpointUrl }}',
OAuthScopes = '{{ OAuthScopes }}',
DataSourceType = '{{ DataSourceType }}',
IdentityProviderVpcConnectionProperties = '{{ IdentityProviderVpcConnectionProperties }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND o_auth_client_application_id = '{{ o_auth_client_application_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
o_auth_client_application_id,
request_id,
status,
update_status;

DELETE examples

delete_o_auth_client_application

Deletes an OAuthClientApplication.

DELETE FROM aws.quicksight.o_auth_client_applications
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND o_auth_client_application_id = '{{ o_auth_client_application_id }}' --required
AND region = '{{ region }}' --required
;