ActionConnector - Amazon Quick Sight
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ActionConnector

Contains detailed information about an action connector, including its configuration, status, and enabled actions.

Contents

Note

In the following list, the required parameters are described first.

ActionConnectorId

The unique identifier of the action connector.

Type: String

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

Pattern: [\w\-]+

Required: Yes

Arn

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

Type: String

Required: Yes

LastUpdatedTime

The date and time when the action connector was last updated.

Type: Timestamp

Required: Yes

Name

The name of 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

AuthenticationConfig

The authentication configuration used to connect to the external service.

Type: ReadAuthConfig object

Required: No

CreatedTime

The timestamp when the action connector was created.

Type: Timestamp

Required: No

Description

The description of the action connector.

Type: String

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

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

Required: No

EnabledActions

The list of actions that are enabled for this connector.

Type: Array of strings

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

Pattern: [\w@:_.,!?+-/]+

Required: No

Error

Error information if the action connector is in an error state.

Type: ActionConnectorError object

Required: No

Status

The current status of the action connector.

Type: String

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

Required: No

VpcConnectionArn

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: