UpdateActionConnectorPermissions
Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
Request Syntax
POST /accounts/AwsAccountId/action-connectors/ActionConnectorId/permissions HTTP/1.1
Content-type: application/json
{
"GrantPermissions": [
{
"Actions": [ "string" ],
"Principal": "string"
}
],
"RevokePermissions": [
{
"Actions": [ "string" ],
"Principal": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- ActionConnectorId
-
The unique identifier of the action connector whose permissions you want to update.
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- AwsAccountId
-
The AWS account ID that contains the action connector.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- GrantPermissions
-
The permissions to grant to users and groups for this action connector.
Type: Array of ResourcePermission objects
Array Members: Minimum number of 1 item. Maximum number of 64 items.
Required: No
- RevokePermissions
-
The permissions to revoke from users and groups for this action connector.
Type: Array of ResourcePermission objects
Array Members: Minimum number of 1 item. Maximum number of 64 items.
Required: No
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"ActionConnectorId": "string",
"Arn": "string",
"Permissions": [
{
"Actions": [ "string" ],
"Principal": "string"
}
],
"RequestId": "string"
}Response Elements
If the action is successful, the service sends back the following HTTP response.
- Status
-
The HTTP status code of the request.
The following data is returned in JSON format by the service.
- ActionConnectorId
-
The unique identifier of the action connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+ - Arn
-
The Amazon Resource Name (ARN) of the action connector.
Type: String
- Permissions
-
The updated permissions configuration for the action connector.
Type: Array of ResourcePermission objects
Array Members: Minimum number of 1 item. Maximum number of 64 items.
- RequestId
-
The AWS request ID for this operation.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
- UnsupportedUserEditionException
-
This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 403
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
