Skip to content

Creates an OAuthClientApplication

Description

Creates an OAuthClientApplication.

Usage

quicksight_create_o_auth_client_application(AwsAccountId,
  OAuthClientApplicationId, Name, OAuthClientAuthenticationType, ClientId,
  ClientSecret, OAuthTokenEndpointUrl, OAuthAuthorizationEndpointUrl,
  OAuthScopes, DataSourceType, IdentityProviderVpcConnectionProperties,
  Tags)

Arguments

  • AwsAccountId

[required] The Amazon Web Services account ID.

  • 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.

  • Name

[required] The display name for the OAuthClientApplication.

  • 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.

  • ClientId

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

  • ClientSecret

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

  • OAuthTokenEndpointUrl

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

  • OAuthAuthorizationEndpointUrl

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

  • OAuthScopes

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

  • DataSourceType

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

  • IdentityProviderVpcConnectionProperties

VPC connection properties.

  • Tags

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

Value

A list with the following syntax:

list(
  Arn = "string",
  OAuthClientApplicationId = "string",
  CreationStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
  RequestId = "string",
  Status = 123
)

Request syntax

svc$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 = list(
    VpcConnectionArn = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)