Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ 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 <value>]
[--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>]
Options¶
--aws-account-id (string)
The Amazon Web Services account ID that contains the action connector.
--action-connector-id (string)
The unique identifier of the action connector to describe.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
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
--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.
Output¶
ActionConnector -> (structure)
The detailed information about the action connector, including its configuration and current state.
Arn -> (string)
The Amazon Resource Name (ARN) of the action connector.ActionConnectorId -> (string)
The unique identifier of the action connector.Type -> (string)
The type of action connector.Name -> (string)
The name of the action connector.CreatedTime -> (timestamp)
The timestamp when the action connector was created.LastUpdatedTime -> (timestamp)
The date and time when the action connector was last updated.Status -> (string)
The current status of the action connector.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.Description -> (string)
The description of the action connector.AuthenticationConfig -> (structure)
The authentication configuration used to connect to the external service.
AuthenticationType -> (string)
The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).AuthenticationMetadata -> (tagged union structure)
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)
The base endpoint URL for the OAuth2 authorization code grant flow.RedirectUrl -> (string)
The redirect URL where the authorization server will send the user after authorization.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)
The client identifier for the OAuth2 authorization code grant flow.TokenEndpoint -> (string)
The authorization server endpoint used to obtain access tokens via the authorization code grant flow.AuthorizationEndpoint -> (string)
The authorization server endpoint used to obtain authorization codes from the resource owner.AuthorizationCodeGrantCredentialsSource -> (string)
The source of credentials for the authorization code grant flow.ClientCredentialsGrantMetadata -> (structure)
Read-only metadata for OAuth2 client credentials grant flow configuration.
BaseEndpoint -> (string)
The base endpoint URL for the OAuth2 client credentials grant flow.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)
The client identifier for the OAuth2 client credentials grant flow.TokenEndpoint -> (string)
The authorization server endpoint used to obtain access tokens via the client credentials grant flow.ClientCredentialsSource -> (string)
The source of client credentials for the OAuth2 client credentials grant flow.BasicAuthConnectionMetadata -> (structure)
Read-only metadata for basic authentication configuration.
BaseEndpoint -> (string)
The base endpoint URL for basic authentication.Username -> (string)
The username used for basic authentication.ApiKeyConnectionMetadata -> (structure)
Read-only metadata for API key authentication configuration.
BaseEndpoint -> (string)
The base endpoint URL for API key authentication.Email -> (string)
The email address associated with the API key authentication.NoneConnectionMetadata -> (structure)
Read-only metadata for connections that do not require authentication.
BaseEndpoint -> (string)
The base endpoint URL for connections that do not require authentication.IamConnectionMetadata -> (structure)
Read-only metadata for IAM-based authentication configuration.
RoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role to assume for authentication.SourceArn -> (string)
The Amazon Resource Name (ARN) of the source resource for IAM authentication.EnabledActions -> (list)
The list of actions that are enabled for this connector.
(string)
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.