CreateActionConnector - Amazon Quick Sight
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

CreateActionConnector

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Request Syntax

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

{
   "ActionConnectorId": "string",
   "AuthenticationConfig": { 
      "AuthenticationMetadata": { ... },
      "AuthenticationType": "string"
   },
   "Description": "string",
   "Name": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Type": "string",
   "VpcConnectionArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS account ID associated with 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.

ActionConnectorId

A unique identifier for the action connector. This ID must be unique within the AWS account. The ActionConnectorId must not start with the prefix quicksuite-

Type: String

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

Pattern: [\w\-]+

Required: Yes

AuthenticationConfig

The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.

Type: AuthConfig object

Required: Yes

Name

A descriptive 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

Type

The type of action connector.

Type: String

Valid Values: GENERIC_HTTP | SERVICENOW_NOW_PLATFORM | SALESFORCE_CRM | MICROSOFT_OUTLOOK | PAGERDUTY_ADVANCE | JIRA_CLOUD | ATLASSIAN_CONFLUENCE | AMAZON_S3 | AMAZON_BEDROCK_AGENT_RUNTIME | AMAZON_BEDROCK_RUNTIME | AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME | AMAZON_TEXTRACT | AMAZON_COMPREHEND | AMAZON_COMPREHEND_MEDICAL | MICROSOFT_ONEDRIVE | MICROSOFT_SHAREPOINT | MICROSOFT_TEAMS | SAP_BUSINESSPARTNER | SAP_PRODUCTMASTERDATA | SAP_PHYSICALINVENTORY | SAP_BILLOFMATERIALS | SAP_MATERIALSTOCK | ZENDESK_SUITE | SMARTSHEET | SLACK | ASANA | BAMBOO_HR

Required: Yes

Description

An optional description of the action connector.

Type: String

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

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

Required: No

Permissions

The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.

Type: Array of ResourcePermission objects

Array Members: Minimum number of 1 item. Maximum number of 64 items.

Required: No

Tags

A list of tags to apply to the action connector for resource management and organization.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

VpcConnectionArn

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

Type: String

Required: No

Response Syntax

HTTP/1.1 Status
Content-type: application/json

{
   "ActionConnectorId": "string",
   "Arn": "string",
   "CreationStatus": "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 created action connector.

Type: String

Arn

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

Type: String

CreationStatus

The creation status of the action connector.

Type: String

Valid Values: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

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

ResourceExistsException

The resource specified already exists.

RequestId

The AWS request ID for this request.

ResourceType

The resource type for this request.

HTTP Status Code: 409

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: