Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateActionConnector

Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.

Request Syntax


PUT /accounts/AwsAccountId/action-connectors/ActionConnectorId HTTP/1.1
Content-type: application/json

{
   "AuthenticationConfig": { 
      "AuthenticationMetadata": { ... },
      "AuthenticationType": "string"
   },
   "Description": "string",
   "Name": "string",
   "VpcConnectionArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ActionConnectorId

The unique identifier of the action connector 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 to update.

Length Constraints: Fixed length of 12.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

AuthenticationConfig

The updated authentication configuration for connecting to the external service.

Type: AuthConfig object

Required: Yes

Name

The new name for the action connector.

Type: String

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

Pattern: [A-Za-z0-9](?:[\w- ]*[A-Za-z0-9])?

Required: Yes

Description

The updated description of the action connector.

Type: String

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

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

Required: No

VpcConnectionArn

The updated ARN of the VPC connection to use for secure connectivity.

Type: String

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "ActionConnectorId": "string",
   "Arn": "string",
   "RequestId": "string",
   "UpdateStatus": "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 updated action connector.

Type: String

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

Pattern: [\w\-]+

Arn

The Amazon Resource Name (ARN) of the updated action connector.

Type: String

RequestId

The AWS request ID for this operation.

Type: String

UpdateStatus

The status of the update 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

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