AWS CLI Command Reference

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 ]

update-action-connector

Description

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 .

See also: AWS API Documentation

Synopsis

  update-action-connector
--aws-account-id <value>
--action-connector-id <value>
--name <value>
--authentication-config <value>
[--description <value>]
[--vpc-connection-arn <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 to update.

--action-connector-id (string)

The unique identifier of the action connector to update.

--name (string)

The new name for the action connector.

--authentication-config (structure)

The updated authentication configuration for connecting to the external service.

AuthenticationType -> (string)

The type of authentication method.

AuthenticationMetadata -> (tagged union structure)

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)

The base URL endpoint for the external service.

RedirectUrl -> (string)

The redirect URL for the OAuth authorization flow.

AuthorizationCodeGrantCredentialsSource -> (string)

The source of the authorization code grant 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)

The client ID for the OAuth application.

ClientSecret -> (string)

The client secret for the OAuth application.

TokenEndpoint -> (string)

The token endpoint URL for obtaining access tokens.

AuthorizationEndpoint -> (string)

The authorization endpoint URL for the OAuth flow.

ClientCredentialsGrantMetadata -> (structure)

OAuth 2.0 client credentials grant authentication metadata.

BaseEndpoint -> (string)

The base endpoint URL for the external service.

ClientCredentialsSource -> (string)

The source of the client credentials configuration.

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)

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

ClientSecret -> (string)

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

TokenEndpoint -> (string)

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

BasicAuthConnectionMetadata -> (structure)

Basic authentication metadata using username and password.

BaseEndpoint -> (string)

The base URL endpoint for the external service.

Username -> (string)

The username for basic authentication.

Password -> (string)

The password for basic authentication.

ApiKeyConnectionMetadata -> (structure)

API key authentication metadata.

BaseEndpoint -> (string)

The base URL endpoint for the external service.

ApiKey -> (string)

The API key used for authentication.

Email -> (string)

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

NoneConnectionMetadata -> (structure)

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

BaseEndpoint -> (string)

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

IamConnectionMetadata -> (structure)

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

RoleArn -> (string)

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.

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)

The updated description of the action connector.

--vpc-connection-arn (string)

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

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

Arn -> (string)

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

ActionConnectorId -> (string)

The unique identifier of the updated action connector.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

UpdateStatus -> (string)

The status of the update operation.

Status -> (integer)

The HTTP status code of the request.