:doc:`DataZone <../../datazone>` / Client / create_connection

*****************
create_connection
*****************



.. py:method:: DataZone.Client.create_connection(**kwargs)

  

  Creates a new 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 <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateConnection>`_  


  **Request Syntax**
  ::

    response = client.create_connection(
        awsLocation={
            'accessRole': 'string',
            'awsAccountId': 'string',
            'awsRegion': 'string',
            'iamConnectionId': 'string'
        },
        clientToken='string',
        description='string',
        domainIdentifier='string',
        environmentIdentifier='string',
        name='string',
        props={
            'athenaProperties': {
                'workgroupName': 'string'
            },
            'glueProperties': {
                'glueConnectionInput': {
                    'connectionProperties': {
                        'string': 'string'
                    },
                    'physicalConnectionRequirements': {
                        'subnetId': 'string',
                        'subnetIdList': [
                            'string',
                        ],
                        'securityGroupIdList': [
                            'string',
                        ],
                        'availabilityZone': 'string'
                    },
                    'name': 'string',
                    'description': 'string',
                    'connectionType': 'SNOWFLAKE'|'BIGQUERY'|'DOCUMENTDB'|'DYNAMODB'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'SAPHANA'|'SQLSERVER'|'TERADATA'|'VERTICA',
                    'matchCriteria': 'string',
                    'validateCredentials': True|False,
                    'validateForComputeEnvironments': [
                        'SPARK'|'ATHENA'|'PYTHON',
                    ],
                    'sparkProperties': {
                        'string': 'string'
                    },
                    'athenaProperties': {
                        'string': 'string'
                    },
                    'pythonProperties': {
                        'string': 'string'
                    },
                    'authenticationConfiguration': {
                        'authenticationType': 'BASIC'|'OAUTH2'|'CUSTOM',
                        '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'
                        }
                    }
                }
            },
            'hyperPodProperties': {
                'clusterName': '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'
            },
            'sparkGlueProperties': {
                'additionalArgs': {
                    'connection': 'string'
                },
                'glueConnectionName': 'string',
                'glueVersion': 'string',
                'idleTimeout': 123,
                'javaVirtualEnv': 'string',
                'numberOfWorkers': 123,
                'pythonVirtualEnv': 'string',
                'workerType': 'string'
            },
            's3Properties': {
                's3Uri': 'string',
                's3AccessGrantLocationId': 'string'
            },
            'amazonQProperties': {
                'isEnabled': True|False,
                'profileArn': 'string',
                'authMode': 'string'
            },
            'mlflowProperties': {
                'trackingServerArn': 'string'
            }
        },
        enableTrustedIdentityPropagation=True|False,
        scope='DOMAIN'|'PROJECT'
    )
    
  :type awsLocation: dict
  :param awsLocation: 

    The location where the connection is created.

    

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

      

    
  
  :type clientToken: string
  :param clientToken: 

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  
  :type description: string
  :param description: 

    A connection description.

    

  
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

    The ID of the domain where the connection is created.

    

  
  :type environmentIdentifier: string
  :param environmentIdentifier: 

    The ID of the environment where the connection is created.

    

  
  :type name: string
  :param name: **[REQUIRED]** 

    The connection name.

    

  
  :type props: dict
  :param props: 

    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** *(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.

      

    
      - **glueConnectionInput** *(dict) --* 

        The Amazon Web Services Glue connection.

        

      
        - **connectionProperties** *(dict) --* 

          The connection properties of the Amazon Web Services Glue connection.

          

        
          - *(string) --* 

          
            - *(string) --* 

            
      
    
        - **physicalConnectionRequirements** *(dict) --* 

          The physical connection requirements for 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.

            

          
        
        - **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 connection type of the Amazon Web Services Glue connection.

          

        
        - **matchCriteria** *(string) --* 

          The match criteria of the Amazon Web Services Glue connection.

          

        
        - **validateCredentials** *(boolean) --* 

          Speciefies whether to validate credentials of the Amazon Web Services Glue connection.

          

        
        - **validateForComputeEnvironments** *(list) --* 

          Speciefies whether to validate for compute environments of the Amazon Web Services Glue connection.

          

        
          - *(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) --* 

            
      
    
        - **authenticationConfiguration** *(dict) --* 

          The authentication configuration of the Amazon Web Services Glue connection.

          

        
          - **authenticationType** *(string) --* 

            The authentication type 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.

                

              
            
          
          - **secretArn** *(string) --* 

            The secret ARN of a connection.

            

          
          - **kmsKeyArn** *(string) --* 

            The KMS key 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.

              

            
          
          - **customAuthenticationCredentials** *(dict) --* 

            The custom authentication credentials of a connection.

            

          
            - *(string) --* 

            
              - *(string) --* 

              
        
      
        
      
    
    - **hyperPodProperties** *(dict) --* 

      The hyper pod properties of a connection.

      

    
      - **clusterName** *(string) --* **[REQUIRED]** 

        The cluster name the hyper pod properties.

        

      
    
    - **iamProperties** *(dict) --* 

      The IAM properties of a 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 Amazon Redshift storage.

        .. 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 Amazon Redshift database name.

        

      
      - **host** *(string) --* 

        The Amazon Redshift host.

        

      
      - **port** *(integer) --* 

        The Amaon Redshift port.

        

      
      - **credentials** *(dict) --* 

        The Amaon 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** *(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 of the Amazon Redshift.

        

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

      

    
      - **computeArn** *(string) --* 

        The compute ARN of Spark EMR.

        

      
      - **instanceProfileArn** *(string) --* 

        The instance profile ARN of Spark EMR.

        

      
      - **javaVirtualEnv** *(string) --* 

        The java virtual env 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 certificates S3 URI of the Spark EMR.

        

      
      - **managedEndpointArn** *(string) --* 

        The managed endpoint ARN of the EMR on EKS cluster.

        

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

        

      
      - **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) --* **[REQUIRED]** 

        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.

        

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

        

      
    
  
  :type enableTrustedIdentityPropagation: boolean
  :param enableTrustedIdentityPropagation: 

    Specifies whether the trusted identity propagation is enabled.

    

  
  :type scope: string
  :param scope: 

    The scope of the connection.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'connectionId': 'string',
          'description': 'string',
          'domainId': 'string',
          'domainUnitId': 'string',
          'environmentId': 'string',
          'name': 'string',
          'physicalEndpoints': [
              {
                  'awsLocation': {
                      'accessRole': 'string',
                      'awsAccountId': 'string',
                      'awsRegion': 'string',
                      'iamConnectionId': 'string'
                  },
                  'glueConnectionName': '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',
                      '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',
                  'glueVersion': 'string',
                  'idleTimeout': 123,
                  'javaVirtualEnv': 'string',
                  'numberOfWorkers': 123,
                  'pythonVirtualEnv': 'string',
                  'workerType': 'string'
              },
              's3Properties': {
                  's3Uri': 'string',
                  's3AccessGrantLocationId': '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'
              }
          },
          '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',
          'scope': 'DOMAIN'|'PROJECT'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **connectionId** *(string) --* 

        The ID of the connection.

        
      

      - **description** *(string) --* 

        The connection description.

        
      

      - **domainId** *(string) --* 

        The ID of the domain where the connection is created.

        
      

      - **domainUnitId** *(string) --* 

        The ID of the domain unit where the connection is created.

        
      

      - **environmentId** *(string) --* 

        The ID of the environment where the connection is created.

        
      

      - **name** *(string) --* 

        The connection name.

        
      

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

            
          

          - **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 ID of the project where the connection is created.

        
      

      - **props** *(dict) --* 

        The connection props.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``athenaProperties``, ``glueProperties``, ``hyperPodProperties``, ``iamProperties``, ``redshiftProperties``, ``sparkEmrProperties``, ``sparkGlueProperties``, ``s3Properties``, ``amazonQProperties``, ``mlflowProperties``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


      
        

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

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``clusterName``, ``workgroupName``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

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

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``secretArn``, ``usernamePassword``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

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

            
          

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

            
          

          - **status** *(string) --* 

            The status of the Amazon S3 connection.

            
          

          - **errorMessage** *(string) --* 

            The error message that gets displayed.

            
      
        

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

            
      
    
      

      - **type** *(string) --* 

        The connection type.

        
      

      - **scope** *(string) --* 

        The scope of the connection.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`DataZone.Client.exceptions.ConflictException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  