Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.
update-connection¶
Description¶
Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
See also: AWS API Documentation
Synopsis¶
update-connection
--domain-identifier <value>
--identifier <value>
[--description <value>]
[--aws-location <value>]
[--props <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>]
[--v2-debug]
Options¶
--domain-identifier (string)
The ID of the domain where a connection is to be updated.
--identifier (string)
The ID of the connection to be updated.
--description (string)
The description of a connection.
--aws-location (structure)
The location where a connection is to be updated.
accessRole -> (string)
The access role of a connection.awsAccountId -> (string)
The account ID of a connection.awsRegion -> (string)
The Region of a connection.iamConnectionId -> (string)
The IAM connection ID of a connection.
Shorthand Syntax:
accessRole=string,awsAccountId=string,awsRegion=string,iamConnectionId=string
JSON Syntax:
{
"accessRole": "string",
"awsAccountId": "string",
"awsRegion": "string",
"iamConnectionId": "string"
}
--props (tagged union structure)
The connection props.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:athenaProperties,glueProperties,iamProperties,redshiftProperties,sparkEmrProperties,s3Properties,amazonQProperties,mlflowProperties.athenaProperties -> (structure)
The Amazon Athena properties of a connection properties patch.
workgroupName -> (string)
The Amazon Athena workgroup name of a connection.glueProperties -> (structure)
The Amazon Web Services Glue properties of a connection properties patch.
glueConnectionInput -> (structure)
The Amazon Web Services Glue properties patch of a connection.
description -> (string)
The description of the Amazon Web Services Glue connection patch.connectionProperties -> (map)
The properties of the Amazon Web Services Glue connection patch.
key -> (string)
value -> (string)
authenticationConfiguration -> (structure)
The authentication configuration of the Amazon Web Services Glue connection patch.
secretArn -> (string)
The secret ARN of a connection.basicAuthenticationCredentials -> (structure)
The basic authentication credentials of a connection.
userName -> (string)
The user name for the connecion.password -> (string)
The password for a connection.iamProperties -> (structure)
The IAM properties of a connection properties patch.
glueLineageSyncEnabled -> (boolean)
Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.redshiftProperties -> (structure)
The Amazon Redshift properties of a connection properties patch.
storage -> (tagged union structure)
The storage in the Amazon Redshift properties patch.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:clusterName,workgroupName.clusterName -> (string)
The cluster name in the Amazon Redshift storage properties.workgroupName -> (string)
The workgroup name in the Amazon Redshift storage properties.databaseName -> (string)
The name in the Amazon Redshift properties patch.host -> (string)
The host in the Amazon Redshift properties patch.port -> (integer)
The port in the Amazon Redshift properties patch.credentials -> (tagged union structure)
The credentials in the Amazon Redshift properties patch.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:secretArn,usernamePassword.secretArn -> (string)
The secret ARN of the Amazon Redshift credentials of a connection.usernamePassword -> (structure)
The username and password of the Amazon Redshift credentials of a connection.
password -> (string)
The password of a connection.username -> (string)
The username of a connection.lineageSync -> (structure)
The lineage sync in the Amazon Redshift properties patch.
enabled -> (boolean)
Specifies whether the Amaon Redshift lineage sync configuration is enabled.schedule -> (structure)
The schedule of the Amaon Redshift lineage sync configuration.
schedule -> (string)
The lineage sync schedule.sparkEmrProperties -> (structure)
The Spark EMR properties of a connection properties patch.
computeArn -> (string)
The compute ARN in the Spark EMR properties patch.instanceProfileArn -> (string)
The instance profile ARN in the Spark EMR properties patch.javaVirtualEnv -> (string)
The Java virtual evn in the Spark EMR properties patch.logUri -> (string)
The log URI in the Spark EMR properties patch.pythonVirtualEnv -> (string)
The Python virtual env in the Spark EMR properties patch.runtimeRole -> (string)
The runtime role in the Spark EMR properties patch.trustedCertificatesS3Uri -> (string)
The trusted certificates S3 URI in the Spark EMR properties patch.managedEndpointArn -> (string)
The managed endpoint ARN of the EMR on EKS cluster.s3Properties -> (structure)
The Amazon S3 properties of a connection properties patch.
s3Uri -> (string)
The Amazon S3 URI that’s part of the Amazon S3 properties patch of a connection.s3AccessGrantLocationId -> (string)
The Amazon S3 Access Grant location ID that’s part of the Amazon S3 properties patch of a connection.amazonQProperties -> (structure)
The Amazon Q properties of the connection.
isEnabled -> (boolean)
Specifies whether Amazon Q is enabled for the connection.profileArn -> (string)
The profile ARN of the connection’s Amazon Q properties.authMode -> (string)
The authentication mode of the connection’s Amazon Q properties.mlflowProperties -> (structure)
The MLflow properties of a connection.
trackingServerArn -> (string)
The tracking server ARN as part of the MLflow properties of a connection.
JSON Syntax:
{
"athenaProperties": {
"workgroupName": "string"
},
"glueProperties": {
"glueConnectionInput": {
"description": "string",
"connectionProperties": {"string": "string"
...},
"authenticationConfiguration": {
"secretArn": "string",
"basicAuthenticationCredentials": {
"userName": "string",
"password": "string"
}
}
}
},
"iamProperties": {
"glueLineageSyncEnabled": true|false
},
"redshiftProperties": {
"storage": {
"clusterName": "string",
"workgroupName": "string"
},
"databaseName": "string",
"host": "string",
"port": integer,
"credentials": {
"secretArn": "string",
"usernamePassword": {
"password": "string",
"username": "string"
}
},
"lineageSync": {
"enabled": true|false,
"schedule": {
"schedule": "string"
}
}
},
"sparkEmrProperties": {
"computeArn": "string",
"instanceProfileArn": "string",
"javaVirtualEnv": "string",
"logUri": "string",
"pythonVirtualEnv": "string",
"runtimeRole": "string",
"trustedCertificatesS3Uri": "string",
"managedEndpointArn": "string"
},
"s3Properties": {
"s3Uri": "string",
"s3AccessGrantLocationId": "string"
},
"amazonQProperties": {
"isEnabled": true|false,
"profileArn": "string",
"authMode": "string"
},
"mlflowProperties": {
"trackingServerArn": "string"
}
}
--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.
--v2-debug (boolean)
Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.
Output¶
connectionId -> (string)
The ID of the connection.
description -> (string)
The connection description.
domainId -> (string)
The ID of the domain where a connection is to be updated.
domainUnitId -> (string)
The ID of the domain unit where a connection is to be updated.
environmentId -> (string)
The ID of the environment where a connection is to be updated.
name -> (string)
The name of the connection.
physicalEndpoints -> (list)
The physical endpoints of the connection.
(structure)
The physical endpoints of a connection.
awsLocation -> (structure)
The location of a connection.
accessRole -> (string)
The access role of a connection.awsAccountId -> (string)
The account ID of a connection.awsRegion -> (string)
The Region of a connection.iamConnectionId -> (string)
The IAM connection ID of a connection.glueConnectionName -> (string)
The Amazon Web Services Glue connection name.glueConnection -> (structure)
The Amazon Web Services Glue connection.
name -> (string)
The name of the Amazon Web Services Glue connection.description -> (string)
The description of the Amazon Web Services Glue connection.connectionType -> (string)
The type of the Amazon Web Services Glue connection.matchCriteria -> (list)
The match criteria of the Amazon Web Services Glue connection.
(string)
connectionProperties -> (map)
The properties of the Amazon Web Services Glue connection.
key -> (string)
value -> (string)
sparkProperties -> (map)
The Spark properties of the Amazon Web Services Glue connection.
key -> (string)
value -> (string)
athenaProperties -> (map)
The Amazon Athena properties of the Amazon Web Services Glue connection.
key -> (string)
value -> (string)
pythonProperties -> (map)
The Python properties of the Amazon Web Services Glue connection.
key -> (string)
value -> (string)
physicalConnectionRequirements -> (structure)
The physical connection requirements of the Amazon Web Services Glue connection.
subnetId -> (string)
The subnet ID of the physical connection requirements of a connection.subnetIdList -> (list)
The subnet ID list of the physical connection requirements of a connection.
(string)
securityGroupIdList -> (list)
The group ID list of the physical connection requirements of a connection.
(string)
availabilityZone -> (string)
The availability zone of the physical connection requirements of a connection.creationTime -> (timestamp)
The creation time of the Amazon Web Services Glue connection.lastUpdatedTime -> (timestamp)
The timestamp at which the Amazon Web Services Glue connection was last updated.lastUpdatedBy -> (string)
The user who last updated the Amazon Web Services Glue connection.status -> (string)
The status of the Amazon Web Services Glue connection.statusReason -> (string)
The status reason of the Amazon Web Services Glue connection.lastConnectionValidationTime -> (timestamp)
The last validation time of the Amazon Web Services Glue connection.authenticationConfiguration -> (structure)
The authentication configuration of the Amazon Web Services Glue connection.
authenticationType -> (string)
The authentication type of a connection.secretArn -> (string)
The secret ARN of a connection.oAuth2Properties -> (structure)
The oAuth2 properties of a connection.
oAuth2GrantType -> (string)
The OAuth2 grant type of the OAuth2 properties.oAuth2ClientApplication -> (structure)
The OAuth2 client application of the OAuth2 properties.
userManagedClientApplicationClientId -> (string)
The user managed client application client ID in the OAuth2Client application.aWSManagedClientApplicationReference -> (string)
The Amazon Web Services managed client application reference in the OAuth2Client application.tokenUrl -> (string)
The OAuth2 token URL of the OAuth2 properties.tokenUrlParametersMap -> (map)
The OAuth2 token URL parameter map of the OAuth2 properties.
key -> (string)
value -> (string)
authorizationCodeProperties -> (structure)
The authorization code properties of the OAuth2 properties.
authorizationCode -> (string)
The authorization code of a connection.redirectUri -> (string)
The redirect URI of a connection.oAuth2Credentials -> (structure)
The OAuth2 credentials of the OAuth2 properties.
userManagedClientApplicationClientSecret -> (string)
The user managed client application client secret of the connection.accessToken -> (string)
The access token of a connection.refreshToken -> (string)
The refresh token of the connection.jwtToken -> (string)
The jwt token of the connection.connectionSchemaVersion -> (integer)
The connection schema version of the Amazon Web Services Glue connection.compatibleComputeEnvironments -> (list)
The compatible compute environments of the Amazon Web Services Glue connection.
(string)
enableTrustedIdentityPropagation -> (boolean)
Specified whether trusted identity propagation for the connection is enabled.host -> (string)
The host in the physical endpoints of a connection.port -> (integer)
The port in the physical endpoints of a connection.protocol -> (string)
The protocol in the physical endpoints of a connection.stage -> (string)
The stage in the physical endpoints of a connection.
projectId -> (string)
The project ID of the connection.
props -> (tagged union structure)
The connection props.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:athenaProperties,glueProperties,hyperPodProperties,iamProperties,redshiftProperties,sparkEmrProperties,sparkGlueProperties,s3Properties,amazonQProperties,mlflowProperties.athenaProperties -> (structure)
The Amazon Athena properties of a connection.
workgroupName -> (string)
The Amazon Athena workgroup name of a connection.glueProperties -> (structure)
The Amazon Web Services Glue properties of a connection.
status -> (string)
The status of a connection.errorMessage -> (string)
The error message generated if the action is not completed successfully.hyperPodProperties -> (structure)
The hyper pod properties of a connection.
clusterName -> (string)
The cluster name the hyper pod properties.clusterArn -> (string)
The cluster ARN of the hyper pod properties.orchestrator -> (string)
The orchestrator of the hyper pod properties.iamProperties -> (structure)
The IAM properties of a connection.
environmentId -> (string)
The environment ID of the connection.glueLineageSyncEnabled -> (boolean)
Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.redshiftProperties -> (structure)
The Amazon Redshift properties of a connection.
storage -> (tagged union structure)
The storage in the Amazon Redshift properties.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:clusterName,workgroupName.clusterName -> (string)
The cluster name in the Amazon Redshift storage properties.workgroupName -> (string)
The workgroup name in the Amazon Redshift storage properties.credentials -> (tagged union structure)
The Amazon Redshift credentials.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:secretArn,usernamePassword.secretArn -> (string)
The secret ARN of the Amazon Redshift credentials of a connection.usernamePassword -> (structure)
The username and password of the Amazon Redshift credentials of a connection.
password -> (string)
The password of a connection.username -> (string)
The username of a connection.isProvisionedSecret -> (boolean)
Specifies whether Amaon Redshift properties has a provisioned secret.jdbcIamUrl -> (string)
The jdbcIam URL of the Amazon Redshift properties.jdbcUrl -> (string)
The jdbcURL of the Amazon Redshift properties.redshiftTempDir -> (string)
The redshiftTempDir of the Amazon Redshift properties.lineageSync -> (structure)
The lineage syn of the Amazon Redshift properties.
lineageJobId -> (string)
The lineage job ID of the Amaon Redshift lineage sync configuration.enabled -> (boolean)
Specifies whether the Amaon Redshift lineage sync configuration is enabled.schedule -> (structure)
The schedule of teh Amaon Redshift lineage sync configuration.
schedule -> (string)
The lineage sync schedule.status -> (string)
The status in the Amazon Redshift properties.databaseName -> (string)
The Amazon Redshift database name.sparkEmrProperties -> (structure)
The Spark EMR properties of a connection.
computeArn -> (string)
The compute ARN of the Spark EMR.credentials -> (structure)
The credentials of the Spark EMR.
password -> (string)
The password of a connection.username -> (string)
The username of a connection.credentialsExpiration -> (timestamp)
The credential expiration of the Spark EMR.governanceType -> (string)
The governance type of the Spark EMR.instanceProfileArn -> (string)
The instance profile ARN of the Spark EMR.javaVirtualEnv -> (string)
The Java virtual env of the Spark EMR.livyEndpoint -> (string)
The livy endpoint of the Spark EMR.logUri -> (string)
The log URI of the Spark EMR.pythonVirtualEnv -> (string)
The Python virtual env of the Spark EMR.runtimeRole -> (string)
The runtime role of the Spark EMR.trustedCertificatesS3Uri -> (string)
The trusted certificate S3 URL of the Spark EMR.certificateData -> (string)
The certificate data of the EMR on EKS cluster.managedEndpointArn -> (string)
The managed endpoint ARN of the EMR on EKS cluster.managedEndpointCredentials -> (structure)
The managed endpoint credentials of the EMR on EKS cluster.
id -> (string)
The identifier of the managed endpoint credentials.token -> (string)
The ARN of the managed endpoint credentials.sparkGlueProperties -> (structure)
The Spark Amazon Web Services Glue properties of a connection.
additionalArgs -> (structure)
The additional args in the Spark Amazon Web Services Glue properties.
connection -> (string)
The connection in the Spark Amazon Web Services Glue args.glueConnectionName -> (string)
The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties.glueVersion -> (string)
The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties.idleTimeout -> (integer)
The idle timeout in the Spark Amazon Web Services Glue properties.javaVirtualEnv -> (string)
The Java virtual env in the Spark Amazon Web Services Glue properties.numberOfWorkers -> (integer)
The number of workers in the Spark Amazon Web Services Glue properties.pythonVirtualEnv -> (string)
The Python virtual env in the Spark Amazon Web Services Glue properties.workerType -> (string)
The worker type in the Spark Amazon Web Services Glue properties.s3Properties -> (structure)
The Amazon S3 properties of a connection.
s3Uri -> (string)
The Amazon S3 URI that’s part of the Amazon S3 properties of a connection.s3AccessGrantLocationId -> (string)
The Amazon S3 Access Grant location ID that’s part of the Amazon S3 properties of a connection.status -> (string)
The status of the Amazon S3 connection.errorMessage -> (string)
The error message that gets displayed.amazonQProperties -> (structure)
The Amazon Q properties of the connection.
isEnabled -> (boolean)
Specifies whether Amazon Q is enabled for the connection.profileArn -> (string)
The profile ARN of the connection’s Amazon Q properties.authMode -> (string)
The authentication mode of the connection’s Amazon Q properties.mlflowProperties -> (structure)
The MLflow properties of a connection.
trackingServerArn -> (string)
The tracking server ARN as part of the MLflow properties of a connection.
type -> (string)
The connection type.
scope -> (string)
The scope of the connection.