View a markdown version of this page

UpdateAccessControlApplicationSecret - AWS Quick

UpdateAccessControlApplicationSecret

Updates the AWS Secrets Manager secret ARNs of an IdP-provided client secret. You can add, replace, or remove the ARN for a Region, but you can't remove the last remaining Region. To remove it, delete the client secret.

Request Syntax

PUT /accounts/AwsAccountId/access-control-applications/ApplicationId/client-secrets/ClientSecretId HTTP/1.1 Content-type: application/json { "RemoveRegionalSecretManagerArns": [ "string" ], "UpdateRegionalSecretManagerArns": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.

ApplicationId

The ID of the access control application.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

AwsAccountId

The ID of the AWS account that contains the Quick Sight account.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

ClientSecretId

The ID of the client secret.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

RemoveRegionalSecretManagerArns

The Regions whose ARNs to remove. You can't remove the last remaining Region. To remove it, delete the client secret instead.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 5. Maximum length of 30.

Pattern: [a-z]{2}(-[a-z]+)+-[0-9]+

Required: No

UpdateRegionalSecretManagerArns

The Region ARNs to add or replace. The Region in each ARN must match its key.

Type: String to string map

Map Entries: Maximum number of 10 items.

Key Length Constraints: Minimum length of 5. Maximum length of 30.

Key Pattern: [a-z]{2}(-[a-z]+)+-[0-9]+

Value Length Constraints: Minimum length of 20. Maximum length of 2048.

Value Pattern: arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "ClientSecretId": "string", "RegionalSecretManagerArns": { "string" : "string" }, "RequestId": "string", "UpdatedAt": number }

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.

ClientSecretId

The ID of the client secret.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

RegionalSecretManagerArns

The Region ARNs of the client secret after the update.

Type: String to string map

Map Entries: Maximum number of 10 items.

Key Length Constraints: Minimum length of 5. Maximum length of 30.

Key Pattern: [a-z]{2}(-[a-z]+)+-[0-9]+

Value Length Constraints: Minimum length of 20. Maximum length of 2048.

Value Pattern: arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+

RequestId

The AWS request ID for this operation.

Type: String

UpdatedAt

The time when the client secret was updated.

Type: Timestamp

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

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: