Skip to content

Updates an OAuthClientApplication

Description

Updates an OAuthClientApplication.

Usage

quicksight_update_o_auth_client_application(AwsAccountId,
  OAuthClientApplicationId, Name, ClientId, ClientSecret,
  OAuthTokenEndpointUrl, OAuthAuthorizationEndpointUrl, OAuthScopes,
  DataSourceType, IdentityProviderVpcConnectionProperties)

Arguments

  • AwsAccountId

[required] The Amazon Web Services account ID.

  • OAuthClientApplicationId

[required] The ID of the OAuthClientApplication that you want to update.

  • Name

[required] The display name for the OAuthClientApplication.

  • ClientId

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

  • ClientSecret

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

  • OAuthTokenEndpointUrl

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.

Value

A list with the following syntax:

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

Request syntax

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