Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions¶

Description¶

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.

Usage¶

quicksight_create_action_connector(AwsAccountId, ActionConnectorId,
  Name, Type, AuthenticationConfig, Description, Permissions,
  VpcConnectionArn, Tags)

Arguments¶

AwsAccountId

[required] The Amazon Web Services account ID associated with the action connector.
ActionConnectorId

[required] A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not start with the prefix quicksuite-
Name

[required] A descriptive name for the action connector.
Type

[required] The type of action connector.
AuthenticationConfig

[required] 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.
Description

An optional description of the action connector.
Permissions

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

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

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

Value¶

A list with the following syntax:

list(
  Arn = "string",
  CreationStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
  ActionConnectorId = "string",
  RequestId = "string",
  Status = 123
)

Request syntax¶

svc$create_action_connector(
  AwsAccountId = "string",
  ActionConnectorId = "string",
  Name = "string",
  Type = "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",
  AuthenticationConfig = list(
    AuthenticationType = "BASIC"|"API_KEY"|"OAUTH2_CLIENT_CREDENTIALS"|"NONE"|"IAM"|"OAUTH2_AUTHORIZATION_CODE",
    AuthenticationMetadata = list(
      AuthorizationCodeGrantMetadata = list(
        BaseEndpoint = "string",
        RedirectUrl = "string",
        AuthorizationCodeGrantCredentialsSource = "PLAIN_CREDENTIALS",
        AuthorizationCodeGrantCredentialsDetails = list(
          AuthorizationCodeGrantDetails = list(
            ClientId = "string",
            ClientSecret = "string",
            TokenEndpoint = "string",
            AuthorizationEndpoint = "string"
          )
        )
      ),
      ClientCredentialsGrantMetadata = list(
        BaseEndpoint = "string",
        ClientCredentialsSource = "PLAIN_CREDENTIALS",
        ClientCredentialsDetails = list(
          ClientCredentialsGrantDetails = list(
            ClientId = "string",
            ClientSecret = "string",
            TokenEndpoint = "string"
          )
        )
      ),
      BasicAuthConnectionMetadata = list(
        BaseEndpoint = "string",
        Username = "string",
        Password = "string"
      ),
      ApiKeyConnectionMetadata = list(
        BaseEndpoint = "string",
        ApiKey = "string",
        Email = "string"
      ),
      NoneConnectionMetadata = list(
        BaseEndpoint = "string"
      ),
      IamConnectionMetadata = list(
        RoleArn = "string"
      )
    )
  ),
  Description = "string",
  Permissions = list(
    list(
      Principal = "string",
      Actions = list(
        "string"
      )
    )
  ),
  VpcConnectionArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)