AWS CLI Command Reference

[ aws . quicksight ]

create-action-connector

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.

See also: AWS API Documentation

Synopsis

  create-action-connector
--aws-account-id <value>
--action-connector-id <value>
--name <value>
--type <value>
--authentication-config <value>
[--description <value>]
[--permissions <value>]
[--vpc-connection-arn <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--aws-account-id (string) [required]

The Amazon Web Services account ID associated with the action connector.

Constraints:

  • min: 12
  • max: 12
  • pattern: ^[0-9]{12}$

--action-connector-id (string) [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-

Constraints:

  • min: 1
  • max: 512
  • pattern: [\w\-]+

--name (string) [required]

A descriptive name for the action connector.

Constraints:

  • min: 1
  • max: 255
  • pattern: [A-Za-z0-9](?:[\w- ]*[A-Za-z0-9])?

--type (string) [required]

The type of action connector.

Possible 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

--authentication-config (structure) [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.

AuthenticationType -> (string) [required]

The type of authentication method.

Possible values:

  • BASIC
  • API_KEY
  • OAUTH2_CLIENT_CREDENTIALS
  • NONE
  • IAM
  • OAUTH2_AUTHORIZATION_CODE

AuthenticationMetadata -> (tagged union structure) [required]

The authentication metadata containing the specific configuration for the chosen authentication type.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AuthorizationCodeGrantMetadata, ClientCredentialsGrantMetadata, BasicAuthConnectionMetadata, ApiKeyConnectionMetadata, NoneConnectionMetadata, IamConnectionMetadata.

AuthorizationCodeGrantMetadata -> (structure)

OAuth 2.0 authorization code grant authentication metadata.

BaseEndpoint -> (string) [required]

The base URL endpoint for the external service.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

RedirectUrl -> (string) [required]

The redirect URL for the OAuth authorization flow.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

AuthorizationCodeGrantCredentialsSource -> (string)

The source of the authorization code grant credentials.

Possible values:

  • PLAIN_CREDENTIALS

AuthorizationCodeGrantCredentialsDetails -> (tagged union structure)

The detailed credentials configuration for authorization code grant.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AuthorizationCodeGrantDetails.

AuthorizationCodeGrantDetails -> (structure)

The authorization code grant configuration details.

ClientId -> (string) [required]

The client ID for the OAuth application.

Constraints:

  • min: 0
  • max: 1024

ClientSecret -> (string) [required]

The client secret for the OAuth application.

Constraints:

  • min: 0
  • max: 2048

TokenEndpoint -> (string) [required]

The token endpoint URL for obtaining access tokens.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

AuthorizationEndpoint -> (string) [required]

The authorization endpoint URL for the OAuth flow.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

ClientCredentialsGrantMetadata -> (structure)

OAuth 2.0 client credentials grant authentication metadata.

BaseEndpoint -> (string) [required]

The base endpoint URL for the external service.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

ClientCredentialsSource -> (string)

The source of the client credentials configuration.

Possible values:

  • PLAIN_CREDENTIALS

ClientCredentialsDetails -> (tagged union structure)

The detailed client credentials configuration including client ID, client secret, and token endpoint.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ClientCredentialsGrantDetails.

ClientCredentialsGrantDetails -> (structure)

The OAuth2 client credentials grant configuration details for authentication.

ClientId -> (string) [required]

The client identifier issued to the client during the registration process with the authorization server.

Constraints:

  • min: 0
  • max: 1024

ClientSecret -> (string) [required]

The client secret issued to the client during the registration process with the authorization server.

Constraints:

  • min: 0
  • max: 2048

TokenEndpoint -> (string) [required]

The authorization server endpoint used to obtain access tokens via the client credentials grant flow.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

BasicAuthConnectionMetadata -> (structure)

Basic authentication metadata using username and password.

BaseEndpoint -> (string) [required]

The base URL endpoint for the external service.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

Username -> (string) [required]

The username for basic authentication.

Password -> (string) [required]

The password for basic authentication.

ApiKeyConnectionMetadata -> (structure)

API key authentication metadata.

BaseEndpoint -> (string) [required]

The base URL endpoint for the external service.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

ApiKey -> (string) [required]

The API key used for authentication.

Email -> (string)

The email address associated with the API key, if required.

Constraints:

  • pattern: [\w.%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}

NoneConnectionMetadata -> (structure)

No authentication metadata for services that don’t require authentication.

BaseEndpoint -> (string) [required]

The base endpoint URL for connections that do not require authentication.

Constraints:

  • min: 1
  • max: 8192
  • pattern: https://.*

IamConnectionMetadata -> (structure)

IAM role-based authentication metadata for Amazon Web Services services.

RoleArn -> (string) [required]

The Amazon Resource Name (ARN) of the IAM role to assume for authentication with Amazon Web Services services. This IAM role should be in the same account as Quick Sight.

Constraints:

  • min: 20
  • max: 2048

JSON Syntax:

{
  "AuthenticationType": "BASIC"|"API_KEY"|"OAUTH2_CLIENT_CREDENTIALS"|"NONE"|"IAM"|"OAUTH2_AUTHORIZATION_CODE",
  "AuthenticationMetadata": {
    "AuthorizationCodeGrantMetadata": {
      "BaseEndpoint": "string",
      "RedirectUrl": "string",
      "AuthorizationCodeGrantCredentialsSource": "PLAIN_CREDENTIALS",
      "AuthorizationCodeGrantCredentialsDetails": {
        "AuthorizationCodeGrantDetails": {
          "ClientId": "string",
          "ClientSecret": "string",
          "TokenEndpoint": "string",
          "AuthorizationEndpoint": "string"
        }
      }
    },
    "ClientCredentialsGrantMetadata": {
      "BaseEndpoint": "string",
      "ClientCredentialsSource": "PLAIN_CREDENTIALS",
      "ClientCredentialsDetails": {
        "ClientCredentialsGrantDetails": {
          "ClientId": "string",
          "ClientSecret": "string",
          "TokenEndpoint": "string"
        }
      }
    },
    "BasicAuthConnectionMetadata": {
      "BaseEndpoint": "string",
      "Username": "string",
      "Password": "string"
    },
    "ApiKeyConnectionMetadata": {
      "BaseEndpoint": "string",
      "ApiKey": "string",
      "Email": "string"
    },
    "NoneConnectionMetadata": {
      "BaseEndpoint": "string"
    },
    "IamConnectionMetadata": {
      "RoleArn": "string"
    }
  }
}

--description (string)

An optional description of the action connector.

Constraints:

  • min: 1
  • max: 2048
  • pattern: [A-Za-z0-9 _.,!?-]*

--permissions (list)

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

Constraints:

  • min: 1
  • max: 64

(structure)

Permission for the resource.

Principal -> (string) [required]

The Amazon Resource Name (ARN) of the principal. This can be one of the following:

  • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
  • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
  • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

Constraints:

  • min: 1
  • max: 256

Actions -> (list) [required]

The IAM action to grant or revoke permissions on.

Constraints:

  • min: 1
  • max: 20

(string)

Shorthand Syntax:

Principal=string,Actions=string,string ...

JSON Syntax:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--vpc-connection-arn (string)

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

--tags (list)

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

Constraints:

  • min: 1
  • max: 200

(structure)

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Key -> (string) [required]

Tag key.

Constraints:

  • min: 1
  • max: 128

Value -> (string) [required]

Tag value.

Constraints:

  • min: 1
  • max: 256

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Arn -> (string)

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

CreationStatus -> (string)

The creation status of the action connector.

Possible values:

  • CREATION_IN_PROGRESS
  • CREATION_SUCCESSFUL
  • CREATION_FAILED
  • UPDATE_IN_PROGRESS
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED
  • DELETED

ActionConnectorId -> (string)

The unique identifier of the created action connector.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status code of the request.
© Copyright 2025, Amazon Web Services. Created using Sphinx.