AWS CLI Command Reference

[ aws . quicksight ]

describe-action-connector

Description

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

See also: AWS API Documentation

Synopsis

  describe-action-connector
--aws-account-id <value>
--action-connector-id <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 that contains the action connector.

Constraints:

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

--action-connector-id (string) [required]

The unique identifier of the action connector to describe.

Constraints:

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

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

ActionConnector -> (structure)

The detailed information about the action connector, including its configuration and current state.

Arn -> (string) [required]

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

ActionConnectorId -> (string) [required]

The unique identifier of the action connector.

Constraints:

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

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

Name -> (string) [required]

The name of the action connector.

Constraints:

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

CreatedTime -> (timestamp)

The timestamp when the action connector was created.

LastUpdatedTime -> (timestamp) [required]

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

Status -> (string)

The current status of the action connector.

Possible values:

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

Error -> (structure)

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

Message -> (string)

The error message describing what went wrong with the action connector.

Type -> (string)

The type or category of the error.

Possible values:

  • INTERNAL_FAILURE

Description -> (string)

The description of the action connector.

Constraints:

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

AuthenticationConfig -> (structure)

The authentication configuration used to connect to the external service.

AuthenticationType -> (string) [required]

The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).

Possible values:

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

AuthenticationMetadata -> (tagged union structure) [required]

The authentication metadata containing configuration details specific to the 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)

Read-only metadata for OAuth2 authorization code grant flow configuration.

BaseEndpoint -> (string) [required]

The base endpoint URL for the OAuth2 authorization code grant flow.

Constraints:

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

RedirectUrl -> (string) [required]

The redirect URL where the authorization server will send the user after authorization.

Constraints:

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

ReadAuthorizationCodeGrantCredentialsDetails -> (tagged union structure)

The read-only credentials details for the authorization code grant flow.

Note

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

ReadAuthorizationCodeGrantDetails -> (structure)

The read-only authorization code grant configuration details.

ClientId -> (string) [required]

The client identifier for the OAuth2 authorization code grant flow.

Constraints:

  • min: 0
  • max: 1024

TokenEndpoint -> (string) [required]

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

Constraints:

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

AuthorizationEndpoint -> (string) [required]

The authorization server endpoint used to obtain authorization codes from the resource owner.

Constraints:

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

AuthorizationCodeGrantCredentialsSource -> (string)

The source of credentials for the authorization code grant flow.

Possible values:

  • PLAIN_CREDENTIALS

ClientCredentialsGrantMetadata -> (structure)

Read-only metadata for OAuth2 client credentials grant flow configuration.

BaseEndpoint -> (string) [required]

The base endpoint URL for the OAuth2 client credentials grant flow.

Constraints:

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

ReadClientCredentialsDetails -> (tagged union structure)

The read-only client credentials configuration details.

Note

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

ReadClientCredentialsGrantDetails -> (structure)

The read-only client credentials grant configuration details.

ClientId -> (string) [required]

The client identifier for the OAuth2 client credentials grant flow.

Constraints:

  • min: 0
  • max: 1024

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://.*

ClientCredentialsSource -> (string)

The source of client credentials for the OAuth2 client credentials grant flow.

Possible values:

  • PLAIN_CREDENTIALS

BasicAuthConnectionMetadata -> (structure)

Read-only metadata for basic authentication configuration.

BaseEndpoint -> (string) [required]

The base endpoint URL for basic authentication.

Constraints:

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

Username -> (string) [required]

The username used for basic authentication.

ApiKeyConnectionMetadata -> (structure)

Read-only metadata for API key authentication configuration.

BaseEndpoint -> (string) [required]

The base endpoint URL for API key authentication.

Constraints:

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

Email -> (string)

The email address associated with the API key authentication.

Constraints:

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

NoneConnectionMetadata -> (structure)

Read-only metadata for connections that do not 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)

Read-only metadata for IAM-based authentication configuration.

RoleArn -> (string) [required]

The Amazon Resource Name (ARN) of the IAM role to assume for authentication.

Constraints:

  • min: 20
  • max: 2048

SourceArn -> (string) [required]

The Amazon Resource Name (ARN) of the source resource for IAM authentication.

EnabledActions -> (list)

The list of actions that are enabled for this connector.

Constraints:

  • min: 0
  • max: 100

(string)

Constraints:

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

VpcConnectionArn -> (string)

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

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.