UpdateOAuthClientApplication
Updates an OAuthClientApplication.
Request Syntax
PUT /accounts/AwsAccountId/oauth-client-applications/OAuthClientApplicationId HTTP/1.1
Content-type: application/json
{
"ClientId": "string",
"ClientSecret": "string",
"DataSourceType": "string",
"IdentityProviderVpcConnectionProperties": {
"VpcConnectionArn": "string"
},
"Name": "string",
"OAuthAuthorizationEndpointUrl": "string",
"OAuthScopes": "string",
"OAuthTokenEndpointUrl": "string"
}URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The AWS account ID.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
- OAuthClientApplicationId
-
The ID of the OAuthClientApplication that you want to update.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^/][^\p{Cc}]*Required: Yes
Request Body
The request accepts the following data in JSON format.
- Name
-
The display name for the OAuthClientApplication.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- ClientId
-
The client ID of the OAuth application that is registered with the identity provider.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\p{Cc}]+Required: No
- ClientSecret
-
The client secret of the OAuth application that is registered with the identity provider.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\p{Cc}]+Required: No
- DataSourceType
-
The type of data source that the OAuthClientApplication is used with. Valid values are
SNOWFLAKE.Type: String
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 | QBUSINESSRequired: No
- IdentityProviderVpcConnectionProperties
-
VPC connection properties.
Type: VpcConnectionProperties object
Required: No
- OAuthAuthorizationEndpointUrl
-
The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^https://[^\p{Cc}]+Required: No
- OAuthScopes
-
The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
[^\p{Cc}]+Required: No
- OAuthTokenEndpointUrl
-
The token endpoint URL of the identity provider that is used to obtain access tokens.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^https://[^\p{Cc}]+Required: No
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"OAuthClientApplicationId": "string",
"RequestId": "string",
"UpdateStatus": "string"
}Response Elements
If the action is successful, the service sends back the following HTTP response.
- Status
-
The HTTP status of the request.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) of the OAuthClientApplication.
Type: String
- OAuthClientApplicationId
-
The ID of the OAuthClientApplication. This ID is unique per AWS Region for each AWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^/][^\p{Cc}]* - RequestId
-
The AWS request ID for this operation.
Type: String
- UpdateStatus
-
The status of updating the OAuthClientApplication.
Type: String
Valid Values:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 401
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 409
- InternalFailureException
-
An internal failure occurred.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 400
- LimitExceededException
-
A limit is exceeded.
- RequestId
-
The AWS request ID for this request.
- ResourceType
-
Limit exceeded.
HTTP Status Code: 409
- ResourceNotFoundException
-
One or more resources can't be found.
- RequestId
-
The AWS request ID for this request.
- ResourceType
-
The resource type for this request.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
