2026/11/06 - Amazon DataZone - 1 updated api methods
Changes Adds support for updating OAuth 2.0 connection settings with UpdateConnection.
{'props': {'glueProperties': {'glueConnectionInput': {'authenticationConfiguration': {'oAuth2Properties': {'oAuth2ClientApplication': {'aWSManagedClientApplicationReference': 'string',
'userManagedClientApplicationClientId': 'string'},
'oAuth2GrantType': 'AUTHORIZATION_CODE '
'| '
'CLIENT_CREDENTIALS '
'| '
'JWT_BEARER',
'tokenUrl': 'string',
'tokenUrlParametersMap': {'string': 'string'}}}}},
'snowflakeProperties': {'connectivityPropertiesPatch': {'authenticationConfiguration': {'oAuth2Properties': {'oAuth2ClientApplication': {'aWSManagedClientApplicationReference': 'string',
'userManagedClientApplicationClientId': 'string'},
'oAuth2GrantType': 'AUTHORIZATION_CODE '
'| '
'CLIENT_CREDENTIALS '
'| '
'JWT_BEARER',
'tokenUrl': 'string',
'tokenUrlParametersMap': {'string': 'string'}}}}}}}
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
Request Syntax
client.update_connection(
configurations=[
{
'classification': 'string',
'properties': {
'string': 'string'
}
},
],
domainIdentifier='string',
identifier='string',
description='string',
awsLocation={
'accessRole': 'string',
'awsAccountId': 'string',
'awsRegion': 'string',
'iamConnectionId': 'string'
},
props={
'athenaProperties': {
'workgroupName': 'string'
},
'glueProperties': {
'glueConnectionInput': {
'description': 'string',
'connectionProperties': {
'string': 'string'
},
'authenticationConfiguration': {
'secretArn': 'string',
'basicAuthenticationCredentials': {
'userName': 'string',
'password': 'string'
},
'oAuth2Properties': {
'oAuth2GrantType': 'AUTHORIZATION_CODE'|'CLIENT_CREDENTIALS'|'JWT_BEARER',
'oAuth2ClientApplication': {
'userManagedClientApplicationClientId': 'string',
'aWSManagedClientApplicationReference': 'string'
},
'tokenUrl': 'string',
'tokenUrlParametersMap': {
'string': 'string'
}
}
}
}
},
'iamProperties': {
'glueLineageSyncEnabled': True|False
},
'redshiftProperties': {
'storage': {
'clusterName': 'string',
'workgroupName': 'string'
},
'databaseName': 'string',
'host': 'string',
'port': 123,
'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',
'registerS3AccessGrantLocation': True|False
},
'snowflakeProperties': {
'connectivityPropertiesPatch': {
'description': 'string',
'connectionProperties': {
'string': 'string'
},
'authenticationConfiguration': {
'secretArn': 'string',
'basicAuthenticationCredentials': {
'userName': 'string',
'password': 'string'
},
'oAuth2Properties': {
'oAuth2GrantType': 'AUTHORIZATION_CODE'|'CLIENT_CREDENTIALS'|'JWT_BEARER',
'oAuth2ClientApplication': {
'userManagedClientApplicationClientId': 'string',
'aWSManagedClientApplicationReference': 'string'
},
'tokenUrl': 'string',
'tokenUrlParametersMap': {
'string': 'string'
}
}
}
},
'snowflakeRole': 'string',
'lineageSync': {
'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC',
'enabled': True|False,
'schedule': 'string'
}
},
'amazonQProperties': {
'isEnabled': True|False,
'profileArn': 'string',
'authMode': 'string'
},
'mlflowProperties': {
'trackingServerArn': 'string'
},
'lakehouseProperties': {
'glueLineageSyncEnabled': True|False
},
'vpcProperties': {
'vpcId': 'string',
'subnetIds': [
'string',
],
'securityGroupId': 'string'
},
'gitProperties': {
'codeConnectionArn': 'string',
'defaultBranch': 'string'
}
}
)
list
The configurations of the connection.
(dict) --
The configuration of a connection.
classification (string) --
The classification of the connection configuration.
properties (dict) --
The properties of the connection configuration.
(string) --
(string) --
string
[REQUIRED]
The ID of the domain where a connection is to be updated.
string
[REQUIRED]
The ID of the connection to be updated.
string
The description of a connection.
dict
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.
dict
The connection props.
athenaProperties (dict) --
The Amazon Athena properties of a connection properties patch.
workgroupName (string) --
The Amazon Athena workgroup name of a connection.
glueProperties (dict) --
The Amazon Web Services Glue properties of a connection properties patch.
glueConnectionInput (dict) --
The Amazon Web Services Glue properties patch of a connection.
description (string) --
The description of the Amazon Web Services Glue connection patch.
connectionProperties (dict) --
The properties of the Amazon Web Services Glue connection patch.
(string) --
(string) --
authenticationConfiguration (dict) --
The authentication configuration of the Amazon Web Services Glue connection patch.
secretArn (string) --
The secret ARN of a connection.
basicAuthenticationCredentials (dict) --
The basic authentication credentials of a connection.
userName (string) --
The user name for the connecion.
password (string) --
The password for a connection.
oAuth2Properties (dict) --
The OAuth2 properties, such as the client application, grant type, and token URL, that you want to update for a connection. Only the properties that you specify are updated; the connection keeps its existing values for the properties that you omit.
oAuth2GrantType (string) --
The OAuth2 grant type of the OAuth2 properties to update.
oAuth2ClientApplication (dict) --
The OAuth2 client application of the OAuth2 properties to update.
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 to update.
tokenUrlParametersMap (dict) --
The OAuth2 token URL parameter map of the OAuth2 properties to update, for example the scope. If you specify an empty map, the existing parameters are kept.
(string) --
(string) --
iamProperties (dict) --
The IAM properties of a connection properties patch.
glueLineageSyncEnabled (boolean) --
Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection.
redshiftProperties (dict) --
The Amazon Redshift properties of a connection properties patch.
storage (dict) --
The storage in the Amazon Redshift properties patch.
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 (dict) --
The credentials in the Amazon Redshift properties patch.
secretArn (string) --
The secret ARN of the Amazon Redshift credentials of a connection.
usernamePassword (dict) --
The username and password of the Amazon Redshift credentials of a connection.
password (string) -- [REQUIRED]
The password of a connection.
username (string) -- [REQUIRED]
The username of a connection.
lineageSync (dict) --
The lineage sync in the Amazon Redshift properties patch.
enabled (boolean) --
Specifies whether the Amaon Redshift lineage sync configuration is enabled.
schedule (dict) --
The schedule of the Amaon Redshift lineage sync configuration.
schedule (string) --
The lineage sync schedule.
sparkEmrProperties (dict) --
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 (dict) --
The Amazon S3 properties of a connection properties patch.
s3Uri (string) -- [REQUIRED]
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.
registerS3AccessGrantLocation (boolean) --
Specifies whether to register the Amazon S3 Access Grant location.
snowflakeProperties (dict) --
The Snowflake-specific connection properties to update.
connectivityPropertiesPatch (dict) --
The connectivity properties patch of the Snowflake connection.
description (string) --
A description of the connectivity properties update.
connectionProperties (dict) --
The connection properties to update.
(string) --
(string) --
authenticationConfiguration (dict) --
The authentication settings to update.
secretArn (string) --
The secret ARN of a connection.
basicAuthenticationCredentials (dict) --
The basic authentication credentials of a connection.
userName (string) --
The user name for the connecion.
password (string) --
The password for a connection.
oAuth2Properties (dict) --
The OAuth2 properties, such as the client application, grant type, and token URL, that you want to update for a connection. Only the properties that you specify are updated; the connection keeps its existing values for the properties that you omit.
oAuth2GrantType (string) --
The OAuth2 grant type of the OAuth2 properties to update.
oAuth2ClientApplication (dict) --
The OAuth2 client application of the OAuth2 properties to update.
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 to update.
tokenUrlParametersMap (dict) --
The OAuth2 token URL parameter map of the OAuth2 properties to update, for example the scope. If you specify an empty map, the existing parameters are kept.
(string) --
(string) --
snowflakeRole (string) --
The Snowflake role used to access Snowflake resources.
lineageSync (dict) --
The lineage sync configuration for the Snowflake connection.
timezone (string) --
The timezone of the lineage sync schedule.
enabled (boolean) -- [REQUIRED]
Specifies whether lineage sync is enabled.
schedule (string) --
The schedule of the lineage sync.
amazonQProperties (dict) --
The Amazon Q properties of the connection.
isEnabled (boolean) -- [REQUIRED]
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 (dict) --
The MLflow properties of a connection.
trackingServerArn (string) --
The tracking server ARN as part of the MLflow properties of a connection.
lakehouseProperties (dict) --
The lakehouse properties of a connection properties patch.
glueLineageSyncEnabled (boolean) --
Specifies whether to enable Glue lineage sync for tables managed by Glue crawlers.
vpcProperties (dict) --
The VPC properties of a connection properties patch.
vpcId (string) --
The identifier of the VPC.
subnetIds (list) --
The subnet IDs of the VPC connection.
(string) --
securityGroupId (string) --
The security group ID of the VPC connection.
gitProperties (dict) --
The Git properties of a connection properties patch.
codeConnectionArn (string) --
The ARN of the CodeConnections connection used to connect to the Git repository.
defaultBranch (string) --
The default branch of the Git repository.
dict
Response Syntax
{
'configurations': [
{
'classification': 'string',
'properties': {
'string': 'string'
}
},
],
'connectionId': 'string',
'description': 'string',
'domainId': 'string',
'domainUnitId': 'string',
'environmentId': 'string',
'name': 'string',
'physicalEndpoints': [
{
'awsLocation': {
'accessRole': 'string',
'awsAccountId': 'string',
'awsRegion': 'string',
'iamConnectionId': 'string'
},
'glueConnectionName': 'string',
'glueConnectionNames': [
'string',
],
'glueConnection': {
'name': 'string',
'description': 'string',
'connectionType': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA'|'AMAZON_Q'|'MLFLOW'|'VPC'|'GIT'|'ICEBERGRESTCATALOG'|'SNOWFLAKEICEBERGRESTCATALOG'|'DATABRICKSICEBERGRESTCATALOG',
'matchCriteria': [
'string',
],
'connectionProperties': {
'string': 'string'
},
'sparkProperties': {
'string': 'string'
},
'athenaProperties': {
'string': 'string'
},
'pythonProperties': {
'string': 'string'
},
'physicalConnectionRequirements': {
'subnetId': 'string',
'subnetIdList': [
'string',
],
'securityGroupIdList': [
'string',
],
'availabilityZone': 'string'
},
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'lastUpdatedBy': 'string',
'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
'statusReason': 'string',
'lastConnectionValidationTime': datetime(2015, 1, 1),
'authenticationConfiguration': {
'authenticationType': 'BASIC'|'OAUTH2'|'CUSTOM',
'secretArn': 'string',
'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'
}
}
},
'connectionSchemaVersion': 123,
'compatibleComputeEnvironments': [
'SPARK'|'ATHENA'|'PYTHON',
]
},
'enableTrustedIdentityPropagation': True|False,
'host': 'string',
'port': 123,
'protocol': 'ATHENA'|'GLUE_INTERACTIVE_SESSION'|'HTTPS'|'JDBC'|'LIVY'|'ODBC'|'PRISM',
'stage': 'string'
},
],
'projectId': 'string',
'props': {
'athenaProperties': {
'workgroupName': 'string'
},
'glueProperties': {
'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
'errorMessage': 'string'
},
'hyperPodProperties': {
'clusterName': 'string',
'clusterArn': 'string',
'orchestrator': 'EKS'|'SLURM'
},
'iamProperties': {
'environmentId': 'string',
'glueLineageSyncEnabled': True|False
},
'redshiftProperties': {
'storage': {
'clusterName': 'string',
'workgroupName': 'string'
},
'credentials': {
'secretArn': 'string',
'usernamePassword': {
'password': 'string',
'username': 'string'
}
},
'isProvisionedSecret': True|False,
'jdbcIamUrl': 'string',
'jdbcUrl': 'string',
'redshiftTempDir': 'string',
'lineageSync': {
'lineageJobId': 'string',
'enabled': True|False,
'schedule': {
'schedule': 'string'
}
},
'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
'databaseName': 'string'
},
'sparkEmrProperties': {
'computeArn': 'string',
'credentials': {
'password': 'string',
'username': 'string'
},
'credentialsExpiration': datetime(2015, 1, 1),
'governanceType': 'AWS_MANAGED'|'USER_MANAGED',
'instanceProfileArn': 'string',
'javaVirtualEnv': 'string',
'livyEndpoint': 'string',
'logUri': 'string',
'pythonVirtualEnv': 'string',
'runtimeRole': 'string',
'trustedCertificatesS3Uri': 'string',
'certificateData': 'string',
'managedEndpointArn': 'string',
'managedEndpointCredentials': {
'id': 'string',
'token': 'string'
}
},
'sparkGlueProperties': {
'additionalArgs': {
'connection': 'string'
},
'glueConnectionName': 'string',
'glueConnectionNames': [
'string',
],
'glueVersion': 'string',
'idleTimeout': 123,
'javaVirtualEnv': 'string',
'numberOfWorkers': 123,
'pythonVirtualEnv': 'string',
'workerType': 'string'
},
's3Properties': {
's3Uri': 'string',
's3AccessGrantLocationId': 'string',
'registerS3AccessGrantLocation': True|False,
'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
'errorMessage': 'string'
},
'snowflakeProperties': {
'snowflakeRole': 'string',
'identityMapping': {
'usernameAttribute': 'string',
'prefix': 'string'
},
'lineageSync': {
'lineageJobId': 'string',
'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC',
'enabled': True|False,
'schedule': 'string'
},
'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
'errorMessage': 'string'
},
'amazonQProperties': {
'isEnabled': True|False,
'profileArn': 'string',
'authMode': 'string'
},
'mlflowProperties': {
'trackingServerArn': 'string'
},
'workflowsMwaaProperties': {
'mwaaEnvironmentName': 'string'
},
'workflowsServerlessProperties': {},
'lakehouseProperties': {
'glueLineageSyncEnabled': True|False
},
'vpcProperties': {
'vpcId': 'string',
'subnetIds': [
'string',
],
'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
'securityGroupId': 'string',
'glueConnectionNames': [
'string',
]
},
'gitProperties': {
'codeConnectionArn': 'string',
'repositoryId': 'string',
'defaultBranch': 'string',
'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED',
'errorMessage': 'string'
}
},
'type': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA'|'AMAZON_Q'|'MLFLOW'|'VPC'|'GIT'|'ICEBERGRESTCATALOG'|'SNOWFLAKEICEBERGRESTCATALOG'|'DATABRICKSICEBERGRESTCATALOG',
'scope': 'DOMAIN'|'PROJECT'
}
Response Structure
(dict) --
configurations (list) --
The configurations of the connection.
(dict) --
The configuration of a connection.
classification (string) --
The classification of the connection configuration.
properties (dict) --
The properties of the connection configuration.
(string) --
(string) --
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.
(dict) --
The physical endpoints of a connection.
awsLocation (dict) --
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.
glueConnectionNames (list) --
The Amazon Web Services Glue connection names in the physical endpoint.
(string) --
glueConnection (dict) --
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 (dict) --
The properties of the Amazon Web Services Glue connection.
(string) --
(string) --
sparkProperties (dict) --
The Spark properties of the Amazon Web Services Glue connection.
(string) --
(string) --
athenaProperties (dict) --
The Amazon Athena properties of the Amazon Web Services Glue connection.
(string) --
(string) --
pythonProperties (dict) --
The Python properties of the Amazon Web Services Glue connection.
(string) --
(string) --
physicalConnectionRequirements (dict) --
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 (datetime) --
The creation time of the Amazon Web Services Glue connection.
lastUpdatedTime (datetime) --
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 (datetime) --
The last validation time of the Amazon Web Services Glue connection.
authenticationConfiguration (dict) --
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 (dict) --
The oAuth2 properties of a connection.
oAuth2GrantType (string) --
The OAuth2 grant type of the OAuth2 properties.
oAuth2ClientApplication (dict) --
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 (dict) --
The OAuth2 token URL parameter map of the OAuth2 properties.
(string) --
(string) --
authorizationCodeProperties (dict) --
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 (dict) --
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 (dict) --
The connection props.
athenaProperties (dict) --
The Amazon Athena properties of a connection.
workgroupName (string) --
The Amazon Athena workgroup name of a connection.
glueProperties (dict) --
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 (dict) --
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 (dict) --
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 (dict) --
The Amazon Redshift properties of a connection.
storage (dict) --
The storage in the Amazon Redshift properties.
clusterName (string) --
The cluster name in the Amazon Redshift storage properties.
workgroupName (string) --
The workgroup name in the Amazon Redshift storage properties.
credentials (dict) --
The Amazon Redshift credentials.
secretArn (string) --
The secret ARN of the Amazon Redshift credentials of a connection.
usernamePassword (dict) --
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 (dict) --
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 (dict) --
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 (dict) --
The Spark EMR properties of a connection.
computeArn (string) --
The compute ARN of the Spark EMR.
credentials (dict) --
The credentials of the Spark EMR.
password (string) --
The password of a connection.
username (string) --
The username of a connection.
credentialsExpiration (datetime) --
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 (dict) --
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 (dict) --
The Spark Amazon Web Services Glue properties of a connection.
additionalArgs (dict) --
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.
glueConnectionNames (list) --
The Amazon Web Services Glue connection names in the Spark Amazon Web Services Glue properties.
(string) --
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 (dict) --
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.
registerS3AccessGrantLocation (boolean) --
Specifies whether to register the Amazon S3 Access Grant location.
status (string) --
The status of the Amazon S3 connection.
errorMessage (string) --
The error message that gets displayed.
snowflakeProperties (dict) --
The Snowflake-specific connection properties for an existing connection.
snowflakeRole (string) --
The Snowflake role used to access Snowflake resources.
identityMapping (dict) --
The identity mapping configuration for the Snowflake connection.
usernameAttribute (string) --
The username attribute used for the identity mapping.
prefix (string) --
The prefix used for the identity mapping.
lineageSync (dict) --
The lineage sync configuration for the Snowflake connection.
lineageJobId (string) --
The ID of the lineage sync job.
timezone (string) --
The timezone of the lineage sync schedule.
enabled (boolean) --
Specifies whether lineage sync is enabled.
schedule (string) --
The schedule of the lineage sync.
status (string) --
The status of the Snowflake connection.
errorMessage (string) --
An error message returned if the Snowflake connection failed to establish or validate.
amazonQProperties (dict) --
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 (dict) --
The MLflow properties of a connection.
trackingServerArn (string) --
The tracking server ARN as part of the MLflow properties of a connection.
workflowsMwaaProperties (dict) --
The Amazon MWAA properties of a connection.
mwaaEnvironmentName (string) --
The MWAA environment name.
workflowsServerlessProperties (dict) --
The MWAA serverless properties of a connection.
lakehouseProperties (dict) --
The lakehouse properties of a connection.
glueLineageSyncEnabled (boolean) --
Specifies whether Glue lineage sync is enabled for tables managed by Glue crawlers.
vpcProperties (dict) --
The VPC properties of a connection.
vpcId (string) --
The identifier of the VPC.
subnetIds (list) --
The subnet IDs of the VPC connection.
(string) --
status (string) --
The status of the VPC connection.
securityGroupId (string) --
The security group ID of the VPC connection.
glueConnectionNames (list) --
The Amazon Web Services Glue connection names associated with the VPC connection.
(string) --
gitProperties (dict) --
The Git properties of a connection.
codeConnectionArn (string) --
The ARN of the CodeConnections connection used to connect to the Git repository.
repositoryId (string) --
The ID of the Git repository. This is the owner and repository name, for example, owner/repo-name.
defaultBranch (string) --
The default branch of the Git repository.
status (string) --
The status of the Git connection.
errorMessage (string) --
The error message that describes why the Git connection failed. This member is populated when the connection status is CREATE_FAILED or UPDATE_FAILED.
type (string) --
The connection type.
scope (string) --
The scope of the connection.