View a markdown version of this page

UpdateAccessControlApplication - AWS Quick

UpdateAccessControlApplication

Updates an access control application. You can change its name, description, status, IdP settings such as the client ID and issuer URL, and its Quick Sight authentication settings such as redirect URIs.

You can't change the IdpAuthorizingType, the QuickAuthenticationType, or the trusted token issuer after the application is created. To manage client secrets, use CreateAccessControlApplicationSecret, UpdateAccessControlApplicationSecret, and DeleteAccessControlApplicationSecret.

Request Syntax

PATCH /accounts/AwsAccountId/access-control-applications/ApplicationId HTTP/1.1 Content-type: application/json { "Description": "string", "IdpAuthorizingConfiguration": { "IdcTrustedTokenIssuerConfiguration": { "IdcTrustedTokenIssuerArn": "string" }, "IdpAuthorizingConfigurationDetailInput": { ... }, "IdpAuthorizingType": "string" }, "Name": "string", "QuickAuthenticationConfiguration": { "QuickAuthenticationConfigurationDetailInput": { ... }, "QuickAuthenticationType": "string" }, "Status": "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

Request Body

The request accepts the following data in JSON format.

Description

The new description of the access control application.

Type: String

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

Pattern: [A-Za-z0-9 _.,!?\-]*

Required: No

IdpAuthorizingConfiguration

The identity provider settings to update, such as the client ID and issuer URL. You can't change the IdpAuthorizingType or the trusted token issuer. To manage client secrets, use the client secret operations.

Type: IdpAuthorizingConfigUpdateInput object

Required: No

Name

The new name of the access control application.

Type: String

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

Required: No

QuickAuthenticationConfiguration

The Quick Sight authentication settings to update, such as redirect URIs. You can't change the QuickAuthenticationType.

Type: QuickAuthenticationConfigInput object

Required: No

Status

The new status of the access control application.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "AccessControlApplicationStatus": "string", "ApplicationId": "string", "Arn": "string", "LastUpdatedTime": number, "RequestId": "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.

AccessControlApplicationStatus

The status of the access control application.

Type: String

Valid Values: ENABLED | DISABLED

ApplicationId

The ID of the access control application.

Type: String

Arn

The ARN of the access control application.

Type: String

LastUpdatedTime

The time when the access control application was last updated.

Type: Timestamp

RequestId

The AWS request ID for this operation.

Type: String

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: