action_connectors

Creates, updates, deletes, gets or lists an action_connectors resource.

Overview

Name	action_connectors
Type	Resource
Id	aws.quicksight.action_connectors

Fields

The following fields are returned by SELECT queries:

describe_action_connector

Name	Datatype	Description
action_connector	object	The detailed information about the action connector, including its configuration and current state.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status code of the request.

search_action_connectors

Name	Datatype	Description
action_connector_id	string	The unique identifier of the action connector. (pattern: <code>[\w-]+</code>)
arn	string	The Amazon Resource Name (ARN) of the action connector.
created_time	string (date-time)	The date and time when the action connector was created.
error	object	Error information if the action connector is in an error state.
last_updated_time	string (date-time)	The date and time when the action connector was last updated.
name	string	The name of the action connector. (pattern: <code>[A-Za-z0-9](?:[\w- ]*[A-Za-z0-9])?</code>)
status	string	The current status of the action connector. (CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, DELETED)
type	string	The type of action connector (e.g., SALESFORCE, JIRA, CUSTOM, BEDROCK). (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)

list_action_connectors

Name	Datatype	Description
action_connector_id	string	The unique identifier of the action connector. (pattern: <code>[\w-]+</code>)
arn	string	The Amazon Resource Name (ARN) of the action connector.
created_time	string (date-time)	The date and time when the action connector was created.
error	object	Error information if the action connector is in an error state.
last_updated_time	string (date-time)	The date and time when the action connector was last updated.
name	string	The name of the action connector. (pattern: <code>[A-Za-z0-9](?:[\w- ]*[A-Za-z0-9])?</code>)
status	string	The current status of the action connector. (CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, DELETED)
type	string	The type of action connector (e.g., SALESFORCE, JIRA, CUSTOM, BEDROCK). (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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_action_connector	select	aws_account_id, action_connector_id, region		Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
search_action_connectors	select	aws_account_id, region	max-results, next-token	Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
list_action_connectors	select	aws_account_id, region	max-results, next-token	Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
create_action_connector	insert	aws_account_id, region, ActionConnectorId, AuthenticationConfig		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.
update_action_connector	update	aws_account_id, action_connector_id, region, AuthenticationConfig		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.
delete_action_connector	delete	aws_account_id, action_connector_id, region		Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
action_connector_id	string	The unique identifier of the action connector to delete.
aws_account_id	string	The Amazon Web Services account ID that contains the action connector to delete.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of action connectors to return in a single response. Valid range is 1 to 100.
next-token	string	A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue listing action connectors.

SELECT examples

describe_action_connector

Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.

SELECT
action_connector,
request_id,
status
FROM aws.quicksight.action_connectors
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND action_connector_id = '{{ action_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

search_action_connectors

Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.

SELECT
action_connector_id,
arn,
created_time,
error,
last_updated_time,
name,
status,
type
FROM aws.quicksight.action_connectors
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

list_action_connectors

Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.

SELECT
action_connector_id,
arn,
created_time,
error,
last_updated_time,
name,
status,
type
FROM aws.quicksight.action_connectors
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_action_connector

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.

INSERT INTO aws.quicksight.action_connectors (
ActionConnectorId,
Name,
Type,
AuthenticationConfig,
Description,
Permissions,
VpcConnectionArn,
Tags,
aws_account_id,
region
)
SELECT 
'{{ ActionConnectorId }}' /* required */,
'{{ Name }}',
'{{ Type }}',
'{{ AuthenticationConfig }}' /* required */,
'{{ Description }}',
'{{ Permissions }}',
'{{ VpcConnectionArn }}',
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
action_connector_id,
arn,
creation_status,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: action_connectors
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the action_connectors resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the action_connectors resource.
  - name: ActionConnectorId
    value: "{{ ActionConnectorId }}"
  - name: Name
    value: "{{ Name }}"
  - name: Type
    value: "{{ Type }}"
    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']
  - name: AuthenticationConfig
    description: |
      Authentication configuration for connecting to external services.
    value:
      AuthenticationType: "{{ AuthenticationType }}"
      AuthenticationMetadata:
        AuthorizationCodeGrantMetadata:
          BaseEndpoint: "{{ BaseEndpoint }}"
          RedirectUrl: "{{ RedirectUrl }}"
          AuthorizationCodeGrantCredentialsSource: "{{ AuthorizationCodeGrantCredentialsSource }}"
          AuthorizationCodeGrantCredentialsDetails:
            AuthorizationCodeGrantDetails:
              ClientId: "{{ ClientId }}"
              ClientSecret: "{{ ClientSecret }}"
              TokenEndpoint: "{{ TokenEndpoint }}"
              AuthorizationEndpoint: "{{ AuthorizationEndpoint }}"
        ClientCredentialsGrantMetadata:
          BaseEndpoint: "{{ BaseEndpoint }}"
          ClientCredentialsSource: "{{ ClientCredentialsSource }}"
          ClientCredentialsDetails:
            ClientCredentialsGrantDetails:
              ClientId: "{{ ClientId }}"
              ClientSecret: "{{ ClientSecret }}"
              TokenEndpoint: "{{ TokenEndpoint }}"
        BasicAuthConnectionMetadata:
          BaseEndpoint: "{{ BaseEndpoint }}"
          Username: "{{ Username }}"
          Password: "{{ Password }}"
        ApiKeyConnectionMetadata:
          BaseEndpoint: "{{ BaseEndpoint }}"
          ApiKey: "{{ ApiKey }}"
          Email: "{{ Email }}"
        NoneConnectionMetadata:
          BaseEndpoint: "{{ BaseEndpoint }}"
        IamConnectionMetadata:
          RoleArn: "{{ RoleArn }}"
  - name: Description
    value: "{{ Description }}"
  - name: Permissions
    value:
      - Principal: "{{ Principal }}"
        Actions: "{{ Actions }}"
  - name: VpcConnectionArn
    value: "{{ VpcConnectionArn }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_action_connector

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.

UPDATE aws.quicksight.action_connectors
SET 
Name = '{{ Name }}',
AuthenticationConfig = '{{ AuthenticationConfig }}',
Description = '{{ Description }}',
VpcConnectionArn = '{{ VpcConnectionArn }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND action_connector_id = '{{ action_connector_id }}' --required
AND region = '{{ region }}' --required
AND AuthenticationConfig = '{{ AuthenticationConfig }}' --required
RETURNING
action_connector_id,
arn,
request_id,
status,
update_status;

DELETE examples

delete_action_connector

Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.

DELETE FROM aws.quicksight.action_connectors
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND action_connector_id = '{{ action_connector_id }}' --required
AND region = '{{ region }}' --required
;