AWS CLI Command Reference

[ aws . glue ]

test-connection

Description

Tests a connection to a service to validate the service credentials that you provide.

You can either provide an existing connection name or a TestConnectionInput for testing a non-existing connection input. Providing both at the same time will cause an error.

If the action is successful, the service sends back an HTTP 200 response.

See also: AWS API Documentation

Synopsis

  test-connection
[--connection-name <value>]
[--catalog-id <value>]
[--test-connection-input <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

--connection-name (string)

Optional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

--catalog-id (string)

The catalog ID where the connection resides.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

--test-connection-input (structure)

A structure that is used to specify testing a connection to a service.

ConnectionType -> (string) [required]

The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.

Possible values:

  • JDBC
  • SFTP
  • MONGODB
  • KAFKA
  • NETWORK
  • MARKETPLACE
  • CUSTOM
  • SALESFORCE
  • VIEW_VALIDATION_REDSHIFT
  • VIEW_VALIDATION_ATHENA
  • GOOGLEADS
  • GOOGLESHEETS
  • GOOGLEANALYTICS4
  • SERVICENOW
  • MARKETO
  • SAPODATA
  • ZENDESK
  • JIRACLOUD
  • NETSUITEERP
  • HUBSPOT
  • FACEBOOKADS
  • INSTAGRAMADS
  • ZOHOCRM
  • SALESFORCEPARDOT
  • SALESFORCEMARKETINGCLOUD
  • SLACK
  • STRIPE
  • INTERCOM
  • SNAPCHATADS

ConnectionProperties -> (map) [required]

The key-value pairs that define parameters for the connection.

JDBC connections use the following connection properties:

  • Required: All of (HOST , PORT , JDBC_ENGINE ) or JDBC_CONNECTION_URL .
  • Required: All of (USERNAME , PASSWORD ) or SECRET_ID .
  • Optional: JDBC_ENFORCE_SSL , CUSTOM_JDBC_CERT , CUSTOM_JDBC_CERT_STRING , SKIP_CUSTOM_JDBC_CERT_VALIDATION . These parameters are used to configure SSL with JDBC.

SALESFORCE connections require the AuthenticationConfiguration member to be configured.

Constraints:

  • min: 0
  • max: 100

key -> (string)

Possible values:

  • HOST
  • PORT
  • USERNAME
  • PASSWORD
  • ENCRYPTED_PASSWORD
  • JDBC_DRIVER_JAR_URI
  • JDBC_DRIVER_CLASS_NAME
  • JDBC_ENGINE
  • JDBC_ENGINE_VERSION
  • CONFIG_FILES
  • INSTANCE_ID
  • JDBC_CONNECTION_URL
  • JDBC_ENFORCE_SSL
  • CUSTOM_JDBC_CERT
  • SKIP_CUSTOM_JDBC_CERT_VALIDATION
  • CUSTOM_JDBC_CERT_STRING
  • CONNECTION_URL
  • KAFKA_BOOTSTRAP_SERVERS
  • KAFKA_SSL_ENABLED
  • KAFKA_CUSTOM_CERT
  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION
  • KAFKA_CLIENT_KEYSTORE
  • KAFKA_CLIENT_KEYSTORE_PASSWORD
  • KAFKA_CLIENT_KEY_PASSWORD
  • ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD
  • ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD
  • KAFKA_SASL_MECHANISM
  • KAFKA_SASL_PLAIN_USERNAME
  • KAFKA_SASL_PLAIN_PASSWORD
  • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD
  • KAFKA_SASL_SCRAM_USERNAME
  • KAFKA_SASL_SCRAM_PASSWORD
  • KAFKA_SASL_SCRAM_SECRETS_ARN
  • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD
  • KAFKA_SASL_GSSAPI_KEYTAB
  • KAFKA_SASL_GSSAPI_KRB5_CONF
  • KAFKA_SASL_GSSAPI_SERVICE
  • KAFKA_SASL_GSSAPI_PRINCIPAL
  • SECRET_ID
  • CONNECTOR_URL
  • CONNECTOR_TYPE
  • CONNECTOR_CLASS_NAME
  • ENDPOINT
  • ENDPOINT_TYPE
  • ROLE_ARN
  • REGION
  • WORKGROUP_NAME
  • CLUSTER_IDENTIFIER
  • DATABASE

value -> (string)

Constraints:

  • min: 1
  • max: 1024

AuthenticationConfiguration -> (structure)

A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.

AuthenticationType -> (string)

A structure containing the authentication configuration in the CreateConnection request.

Possible values:

  • BASIC
  • OAUTH2
  • CUSTOM
  • IAM

OAuth2Properties -> (structure)

The properties for OAuth2 authentication in the CreateConnection request.

OAuth2GrantType -> (string)

The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE , JWT_BEARER , or CLIENT_CREDENTIALS .

Possible values:

  • AUTHORIZATION_CODE
  • CLIENT_CREDENTIALS
  • JWT_BEARER

OAuth2ClientApplication -> (structure)

The client application type in the CreateConnection request. For example, AWS_MANAGED or USER_MANAGED .

UserManagedClientApplicationClientId -> (string)

The client application clientID if the ClientAppType is USER_MANAGED .

Constraints:

  • max: 2048
  • pattern: \S+

AWSManagedClientApplicationReference -> (string)

The reference to the SaaS-side client app that is Amazon Web Services managed.

Constraints:

  • max: 2048
  • pattern: \S+

TokenUrl -> (string)

The URL of the provider’s authentication server, to exchange an authorization code for an access token.

Constraints:

  • max: 256
  • pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

TokenUrlParametersMap -> (map)

A map of parameters that are added to the token GET request.

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 1
  • max: 512

AuthorizationCodeProperties -> (structure)

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

AuthorizationCode -> (string)

An authorization code to be used in the third leg of the AUTHORIZATION_CODE grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.

Constraints:

  • min: 1
  • max: 4096
  • pattern: \S+

RedirectUri -> (string)

The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.

Constraints:

  • max: 512
  • pattern: ^(https?):\/\/[^\s/$.?#].[^\s]*$

OAuth2Credentials -> (structure)

The credentials used when the authentication type is OAuth2 authentication.

UserManagedClientApplicationClientSecret -> (string)

The client application client secret if the client application is user managed.

Constraints:

  • max: 512
  • pattern: ^[\x20-\x7E]*$

AccessToken -> (string)

The access token used when the authentication type is OAuth2.

Constraints:

  • max: 4096
  • pattern: ^[\x20-\x7E]*$

RefreshToken -> (string)

The refresh token used when the authentication type is OAuth2.

Constraints:

  • max: 4096
  • pattern: ^[\x20-\x7E]*$

JwtToken -> (string)

The JSON Web Token (JWT) used when the authentication type is OAuth2.

Constraints:

  • max: 8000
  • pattern: ^([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_\-\+\/=]*)

SecretArn -> (string)

The secret manager ARN to store credentials in the CreateConnection request.

Constraints:

  • pattern: ^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$

KmsKeyArn -> (string)

The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.

Constraints:

  • pattern: arn:aws:kms:.*

BasicAuthenticationCredentials -> (structure)

The credentials used when the authentication type is basic authentication.

Username -> (string)

The username to connect to the data source.

Constraints:

  • max: 512
  • pattern: \S+

Password -> (string)

The password to connect to the data source.

Constraints:

  • max: 512
  • pattern: .*

CustomAuthenticationCredentials -> (map)

The credentials used when the authentication type is custom authentication.

key -> (string)

Constraints:

  • min: 1
  • max: 128

value -> (string)

Constraints:

  • min: 1
  • max: 2048

JSON Syntax:

{
  "ConnectionType": "JDBC"|"SFTP"|"MONGODB"|"KAFKA"|"NETWORK"|"MARKETPLACE"|"CUSTOM"|"SALESFORCE"|"VIEW_VALIDATION_REDSHIFT"|"VIEW_VALIDATION_ATHENA"|"GOOGLEADS"|"GOOGLESHEETS"|"GOOGLEANALYTICS4"|"SERVICENOW"|"MARKETO"|"SAPODATA"|"ZENDESK"|"JIRACLOUD"|"NETSUITEERP"|"HUBSPOT"|"FACEBOOKADS"|"INSTAGRAMADS"|"ZOHOCRM"|"SALESFORCEPARDOT"|"SALESFORCEMARKETINGCLOUD"|"SLACK"|"STRIPE"|"INTERCOM"|"SNAPCHATADS",
  "ConnectionProperties": {"HOST"|"PORT"|"USERNAME"|"PASSWORD"|"ENCRYPTED_PASSWORD"|"JDBC_DRIVER_JAR_URI"|"JDBC_DRIVER_CLASS_NAME"|"JDBC_ENGINE"|"JDBC_ENGINE_VERSION"|"CONFIG_FILES"|"INSTANCE_ID"|"JDBC_CONNECTION_URL"|"JDBC_ENFORCE_SSL"|"CUSTOM_JDBC_CERT"|"SKIP_CUSTOM_JDBC_CERT_VALIDATION"|"CUSTOM_JDBC_CERT_STRING"|"CONNECTION_URL"|"KAFKA_BOOTSTRAP_SERVERS"|"KAFKA_SSL_ENABLED"|"KAFKA_CUSTOM_CERT"|"KAFKA_SKIP_CUSTOM_CERT_VALIDATION"|"KAFKA_CLIENT_KEYSTORE"|"KAFKA_CLIENT_KEYSTORE_PASSWORD"|"KAFKA_CLIENT_KEY_PASSWORD"|"ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD"|"ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD"|"KAFKA_SASL_MECHANISM"|"KAFKA_SASL_PLAIN_USERNAME"|"KAFKA_SASL_PLAIN_PASSWORD"|"ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD"|"KAFKA_SASL_SCRAM_USERNAME"|"KAFKA_SASL_SCRAM_PASSWORD"|"KAFKA_SASL_SCRAM_SECRETS_ARN"|"ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD"|"KAFKA_SASL_GSSAPI_KEYTAB"|"KAFKA_SASL_GSSAPI_KRB5_CONF"|"KAFKA_SASL_GSSAPI_SERVICE"|"KAFKA_SASL_GSSAPI_PRINCIPAL"|"SECRET_ID"|"CONNECTOR_URL"|"CONNECTOR_TYPE"|"CONNECTOR_CLASS_NAME"|"ENDPOINT"|"ENDPOINT_TYPE"|"ROLE_ARN"|"REGION"|"WORKGROUP_NAME"|"CLUSTER_IDENTIFIER"|"DATABASE": "string"
    ...},
  "AuthenticationConfiguration": {
    "AuthenticationType": "BASIC"|"OAUTH2"|"CUSTOM"|"IAM",
    "OAuth2Properties": {
      "OAuth2GrantType": "AUTHORIZATION_CODE"|"CLIENT_CREDENTIALS"|"JWT_BEARER",
      "OAuth2ClientApplication": {
        "UserManagedClientApplicationClientId": "string",
        "AWSManagedClientApplicationReference": "string"
      },
      "TokenUrl": "string",
      "TokenUrlParametersMap": {"string": "string"
        ...},
      "AuthorizationCodeProperties": {
        "AuthorizationCode": "string",
        "RedirectUri": "string"
      },
      "OAuth2Credentials": {
        "UserManagedClientApplicationClientSecret": "string",
        "AccessToken": "string",
        "RefreshToken": "string",
        "JwtToken": "string"
      }
    },
    "SecretArn": "string",
    "KmsKeyArn": "string",
    "BasicAuthenticationCredentials": {
      "Username": "string",
      "Password": "string"
    },
    "CustomAuthenticationCredentials": {"string": "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

None

© Copyright 2025, Amazon Web Services. Created using Sphinx.