AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Glue TestConnection API operation.

Syntax

Test-GLUEConnection
-ConnectionName <String>
-OAuth2Credentials_AccessToken <String>
-AuthenticationConfiguration_AuthenticationType <AuthenticationType>
-AuthorizationCodeProperties_AuthorizationCode <String>
-OAuth2ClientApplication_AWSManagedClientApplicationReference <String>
-CatalogId <String>
-TestConnectionInput_ConnectionProperty <Hashtable>
-TestConnectionInput_ConnectionType <ConnectionType>
-AuthenticationConfiguration_CustomAuthenticationCredential <Hashtable>
-OAuth2Credentials_JwtToken <String>
-AuthenticationConfiguration_KmsKeyArn <String>
-OAuth2Properties_OAuth2GrantType <OAuth2GrantType>
-BasicAuthenticationCredentials_Password <String>
-AuthorizationCodeProperties_RedirectUri <String>
-OAuth2Credentials_RefreshToken <String>
-AuthenticationConfiguration_SecretArn <String>
-OAuth2Properties_TokenUrl <String>
-OAuth2Properties_TokenUrlParametersMap <Hashtable>
-OAuth2ClientApplication_UserManagedClientApplicationClientId <String>
-OAuth2Credentials_UserManagedClientApplicationClientSecret <String>
-BasicAuthenticationCredentials_Username <String>
-Select <String>
-ClientConfig <AmazonGlueConfig>

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.

Parameters

-AuthenticationConfiguration_AuthenticationType <AuthenticationType>
A structure containing the authentication configuration in the CreateConnection request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_AuthenticationType
-AuthenticationConfiguration_CustomAuthenticationCredential <Hashtable>
The credentials used when the authentication type is custom authentication. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_CustomAuthenticationCredentials
-AuthenticationConfiguration_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_KmsKeyArn
-AuthenticationConfiguration_SecretArn <String>
The secret manager ARN to store credentials in the CreateConnection request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_SecretArn
-AuthorizationCodeProperties_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_AuthorizationCode
-AuthorizationCodeProperties_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_AuthorizationCodeProperties_RedirectUri
-BasicAuthenticationCredentials_Password <String>
The password to connect to the data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_BasicAuthenticationCredentials_Password
-BasicAuthenticationCredentials_Username <String>
The username to connect to the data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_BasicAuthenticationCredentials_Username
-CatalogId <String>
The catalog ID where the connection resides.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonGlueConfig>
Amazon.PowerShell.Cmdlets.GLUE.AmazonGlueClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectionName <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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-OAuth2ClientApplication_AWSManagedClientApplicationReference <String>
The reference to the SaaS-side client app that is Amazon Web Services managed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_OAuth2ClientApplication_AWSManagedClientApplicationReference
-OAuth2ClientApplication_UserManagedClientApplicationClientId <String>
The client application clientID if the ClientAppType is USER_MANAGED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_OAuth2ClientApplication_UserManagedClientApplicationClientId
-OAuth2Credentials_AccessToken <String>
The access token used when the authentication type is OAuth2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_OAuth2Credentials_AccessToken
-OAuth2Credentials_JwtToken <String>
The JSON Web Token (JWT) used when the authentication type is OAuth2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_OAuth2Credentials_JwtToken
-OAuth2Credentials_RefreshToken <String>
The refresh token used when the authentication type is OAuth2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_OAuth2Credentials_RefreshToken
-OAuth2Credentials_UserManagedClientApplicationClientSecret <String>
The client application client secret if the client application is user managed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_OAuth2Credentials_UserManagedClientApplicationClientSecret
-OAuth2Properties_OAuth2GrantType <OAuth2GrantType>
The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_OAuth2GrantType
-OAuth2Properties_TokenUrl <String>
The URL of the provider's authentication server, to exchange an authorization code for an access token.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_TokenUrl
-OAuth2Properties_TokenUrlParametersMap <Hashtable>
A map of parameters that are added to the token GET request. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_AuthenticationConfiguration_OAuth2Properties_TokenUrlParametersMap
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Glue.Model.TestConnectionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TestConnectionInput_ConnectionProperty <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTestConnectionInput_ConnectionProperties
-TestConnectionInput_ConnectionType <ConnectionType>
The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.Glue.Model.TestConnectionResponse
This cmdlet does not generate any output.The service response (type Amazon.Glue.Model.TestConnectionResponse) be returned by specifying '-Select *'.
Developer Resources
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z