

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# Koneksi API
<a name="aws-glue-api-catalog-connections"></a>

Connections API menjelaskan tipe data dan API yang terkait dengan bekerja dengan koneksi di AWS Glue.

**Topics**
+ [API Koneksi](aws-glue-api-catalog-connections-connections.md)
+ [Jenis Koneksi API](aws-glue-api-catalog-connections-connections-type.md)
+ [Metadata Koneksi dan API Pratinjau](aws-glue-api-catalog-connections-connections-metadata.md)

# API Koneksi
<a name="aws-glue-api-catalog-connections-connections"></a>

Connection API menjelaskan tipe data AWS Glue koneksi, dan API untuk membuat, menghapus, memperbarui, dan mencantumkan koneksi.

## Jenis Data
<a name="aws-glue-api-catalog-connections-connections-objects"></a>
+ [Struktur koneksi](#aws-glue-api-catalog-connections-connections-Connection)
+ [ConnectionInput struktur](#aws-glue-api-catalog-connections-connections-ConnectionInput)
+ [TestConnectionInput struktur](#aws-glue-api-catalog-connections-connections-TestConnectionInput)
+ [PhysicalConnectionRequirements struktur](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
+ [GetConnectionsFilter struktur](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
+ [AuthenticationConfiguration struktur](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
+ [AuthenticationConfigurationInput struktur](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
+ [OAuth2Struktur properti](#aws-glue-api-catalog-connections-connections-OAuth2Properties)
+ [OAuth2PropertiesInput struktur](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
+ [OAuth2ClientApplication struktur](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
+ [AuthorizationCodeProperties struktur](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
+ [BasicAuthenticationCredentials struktur](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
+ [OAuth2Struktur kredensial](#aws-glue-api-catalog-connections-connections-OAuth2Credentials)

## Struktur koneksi
<a name="aws-glue-api-catalog-connections-connections-Connection"></a>

Mendefinisikan sebuah koneksi ke sumber data.

**Bidang**
+ `Name` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama definisi koneksi.
+ `Description` — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Deskripsi koneksi.
+ `ConnectionType`— UTF-8 string (nilai valid: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE`\$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).

  Jenis koneksi. Saat ini, SFTP tidak didukung.
+ `MatchCriteria` — Susunan string UTF-8, tidak lebih dari 10 string.

  Daftar kriteria yang dapat digunakan dalam memilih koneksi ini.
+ `ConnectionProperties` — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 100 pasang.

  Setiap kunci adalah string UTF-8 (nilai yang valid: `HOST` \$1 \$1 \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` `KAFKA_SASL_GSSAPI_KEYTAB` `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1`DATABASE`).

  Setiap nilai adalah string Nilai, panjangnya tidak kurang dari 1 atau lebih dari 1024 byte.

  Pasangan nilai kunci ini menentukan parameter untuk koneksi saat menggunakan skema Koneksi versi 1:
  + `HOST`- URI host: baik nama domain yang memenuhi syarat (FQDN) atau IPv4 alamat host database.
  + `PORT` - Nomor port, antara 1024 dan 65535, port di mana host basis data mendengarkan untuk koneksi basis data.
  + `USER_NAME` - Nama yang digunakan untuk log in ke basis data. Nilai string untuk `USER_NAME` adalah "`USERNAME`".
  + `PASSWORD` - Sebuah kata sandi, jika salah satu digunakan, untuk nama pengguna.
  + `ENCRYPTED_PASSWORD` - Bila Anda mengaktifkan perlindungan kata sandi koneksi dengan menetapkan `ConnectionPasswordEncryption` dalam pengaturan enkripsi Katalog Data, bidang ini menyimpan kata sandi terenkripsi.
  + `JDBC_DRIVER_JAR_URI` - Path Amazon Simple Storage Service (Amazon S3) dari file JAR yang berisi driver JDBC yang akan digunakan.
  + `JDBC_DRIVER_CLASS_NAME` - Nama kelas driver JDBC yang akan digunakan.
  + `JDBC_ENGINE` - Nama mesin JDBC yang akan digunakan.
  + `JDBC_ENGINE_VERSION` - Versi mesin JDBC yang akan digunakan.
  + `CONFIG_FILES` - (Dicadangkan untuk digunakan di masa depan.)
  + `INSTANCE_ID` - ID instans yang akan digunakan.
  + `JDBC_CONNECTION_URL` - URL untuk menghubungkan ke sumber data JDBC.
  + `JDBC_ENFORCE_SSL`- String Boolean case-insensitive (true, false) yang menentukan apakah Secure Sockets Layer (SSL) dengan pencocokan nama host diberlakukan untuk koneksi JDBC pada klien. Default-nya adalah salah.
  + `CUSTOM_JDBC_CERT`- Lokasi Amazon S3 yang menentukan sertifikat root pelanggan. AWS Glue menggunakan sertifikat root ini untuk memvalidasi sertifikat pelanggan saat menghubungkan ke database pelanggan. AWS Glue hanya menangani sertifikat X.509. Sertifikat yang diberikan harus dikodekan-DER dan disediakan dalam format PEM encoding Base64.
  + `SKIP_CUSTOM_JDBC_CERT_VALIDATION`- Secara default, ini`false`. AWS Glue memvalidasi algoritma Signature dan Subject Public Key Algorithm untuk sertifikat pelanggan. Satu-satunya algoritma yang diizinkan untuk algoritma Signature adalah SHA256with RSA, RSA atau SHA384with RSA. SHA512with Untuk Algoritme Kunci Publik Subjek, panjang kunci paling tidak 2048. Anda dapat mengatur nilai properti ini ke `true` untuk melompati validasi sertifikat pelanggan AWS Glue.
  + `CUSTOM_JDBC_CERT_STRING`- String sertifikat JDBC kustom yang digunakan untuk pencocokan domain atau pencocokan nama yang dibedakan untuk mencegah serangan. man-in-the-middle Dalam basis data Oracle, ini digunakan sebagai `SSL_SERVER_CERT_DN`; di Microsoft SQL Server, ini digunakan sebagai `hostNameInCertificate`.
  + `CONNECTION_URL` - URL untuk menghubungkan ke sumber data umum (non-JDBC).
  + `SECRET_ID` - ID rahasia yang digunakan untuk secret manager kredensialnya.
  + `CONNECTOR_URL` - URL konektor untuk koneksi MARKETPLACE atau KUSTOM.
  + `CONNECTOR_TYPE` - Jenis konektor untuk koneksi MARKETPLACE atau KUSTOM.
  + `CONNECTOR_CLASS_NAME` - Nama kelas konektor untuk koneksi MARKETPLACE atau KUSTOM.
  + `KAFKA_BOOTSTRAP_SERVERS` - Sebuah daftar yang dipisahkan koma dari pasangan host dan port yang merupakan alamat dari broker Apache Kafka dalam klaster Kafka yang akan terhubung dengan klien Kafka dan bootstrap itu sendiri.
  + `KAFKA_SSL_ENABLED` - Baik untuk mengaktifkan atau menonaktifkan SSL pada koneksi Apache Kafka. Nilai default-nya adalah "BETUL".
  + `KAFKA_CUSTOM_CERT` - URL Amazon S3 untuk file sertifikat CA privat (format.pem). Default-nya adalah string kosong.
  + `KAFKA_SKIP_CUSTOM_CERT_VALIDATION`- Apakah akan melewatkan validasi file sertifikat CA atau tidak. AWS Glue memvalidasi untuk tiga algoritma: SHA256with RSA, RSA dan SHA384with RSA. SHA512with Nilai default-nya adalah "SALAH".
  + `KAFKA_CLIENT_KEYSTORE` - Lokasi Amazon S3 dari file keystore klien untuk autentikasi sisi klien Kafka (Opsional).
  + `KAFKA_CLIENT_KEYSTORE_PASSWORD` - Kata sandi untuk mengakses keystore yang disediakan (Opsional).
  + `KAFKA_CLIENT_KEY_PASSWORD` - Sebuah keystore dapat terdiri dari beberapa kunci, jadi ini adalah kata sandi untuk mengakses kunci klien yang akan digunakan dengan kunci sisi klien Kafka (Opsional).
  + `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`- Versi terenkripsi dari kata sandi keystore klien Kafka (jika pengguna memiliki pengaturan kata sandi AWS Glue enkripsi yang dipilih).
  + `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`- Versi terenkripsi dari kata sandi kunci klien Kafka (jika pengguna memiliki pengaturan kata sandi AWS Glue enkripsi yang dipilih).
  + `KAFKA_SASL_MECHANISM`-`"SCRAM-SHA-512"`,`"GSSAPI"`,`"AWS_MSK_IAM"`, atau`"PLAIN"`. Ini adalah [Mekanisme SASL](https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml) yang didukung.
  + `KAFKA_SASL_PLAIN_USERNAME`- Nama pengguna plaintext yang digunakan untuk mengautentikasi dengan mekanisme “PLAIN”.
  + `KAFKA_SASL_PLAIN_PASSWORD`- Kata sandi plaintext yang digunakan untuk mengautentikasi dengan mekanisme “PLAIN”.
  + `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD`- Versi terenkripsi dari kata sandi Kafka SASL PLAIN (jika pengguna memiliki pengaturan kata sandi AWS Glue enkripsi yang dipilih).
  + `KAFKA_SASL_SCRAM_USERNAME`- Nama pengguna plaintext yang digunakan untuk mengautentikasi dengan mekanisme “SCRAM-SHA-512".
  + `KAFKA_SASL_SCRAM_PASSWORD`- Kata sandi plaintext yang digunakan untuk mengautentikasi dengan mekanisme “SCRAM-SHA-512".
  + `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`- Versi terenkripsi dari kata sandi Kafka SASL SCRAM (jika pengguna memiliki pengaturan kata sandi AWS Glue enkripsi yang dipilih).
  + `KAFKA_SASL_SCRAM_SECRETS_ARN`- Nama Sumber Daya Amazon dari AWS rahasia di Secrets Manager.
  + `KAFKA_SASL_GSSAPI_KEYTAB`- Lokasi S3 dari file Kerberos`keytab`. Keytab menyimpan kunci jangka panjang untuk satu atau lebih prinsipal. Untuk informasi selengkapnya, lihat [Dokumentasi MIT Kerberos: Keytab](https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html).
  + `KAFKA_SASL_GSSAPI_KRB5_CONF`- Lokasi S3 dari file Kerberos`krb5.conf`. Krb5.conf menyimpan informasi konfigurasi Kerberos, seperti lokasi server KDC. Untuk informasi lebih lanjut, lihat [Dokumentasi MIT Kerberos:](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html) krb5.conf.
  + `KAFKA_SASL_GSSAPI_SERVICE`- Nama layanan Kerberos, seperti yang diatur `sasl.kerberos.service.name` dalam Konfigurasi [Kafka](https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name) Anda.
  + `KAFKA_SASL_GSSAPI_PRINCIPAL`- Nama princial Kerberos yang digunakan oleh. AWS Glue Untuk informasi lebih lanjut, lihat [Dokumentasi Kafka: Mengkonfigurasi Broker Kafka](https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig).
  + `ROLE_ARN`- Peran yang akan digunakan untuk menjalankan query.
  + `REGION`- AWS Wilayah tempat kueri akan dijalankan.
  + `WORKGROUP_NAME`- Nama workgroup tanpa server Amazon Redshift atau workgroup Amazon Athena tempat kueri akan berjalan.
  + `CLUSTER_IDENTIFIER`- Pengidentifikasi cluster dari cluster Amazon Redshift tempat kueri akan berjalan.
  + `DATABASE`- Basis data Amazon Redshift yang Anda sambungkan.
+ `SparkProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte.

  Properti koneksi khusus untuk lingkungan komputasi Spark.
+ `AthenaProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte.

  Properti koneksi khusus untuk lingkungan komputasi Athena.
+ `PythonProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte.

  Properti koneksi khusus untuk lingkungan komputasi Python.
+ `PhysicalConnectionRequirements` — Sebuah objek [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements).

  Persyaratan koneksi fisik, seperti virtual private cloud (VPC) dan`SecurityGroup`, yang diperlukan untuk membuat koneksi ini berhasil.
+ `CreationTime` — Stempel waktu.

  Stempel waktu waktu definisi koneksi ini dibuat.
+ `LastUpdatedTime` — Stempel waktu.

  Stempel waktu terakhir kali definisi koneksi diperbarui.
+ `LastUpdatedBy` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Pengguna, grup, atau peran yang terakhir memperbarui definisi koneksi ini.
+ `Status` – String UTF-8 (nilai yang valid: `READY` \$1 `IN_PROGRESS` \$1 `FAILED`).

  Status koneksi. Bisa menjadi salah satu dari:`READY`,`IN_PROGRESS`, atau`FAILED`.
+ `StatusReason`— String UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 16384 byte.

  Alasan status koneksi.
+ `LastConnectionValidationTime` — Stempel waktu.

  Stempel waktu saat koneksi ini terakhir divalidasi.
+ `AuthenticationConfiguration` — Sebuah objek [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration).

  Properti otentikasi koneksi.
+ `ConnectionSchemaVersion`— Angka (bilangan bulat), tidak kurang dari 1 atau lebih dari 2.

  Versi skema koneksi untuk koneksi ini. Versi 2 mendukung properti untuk lingkungan komputasi tertentu.
+ `CompatibleComputeEnvironments` – Susunan string UTF-8.

  Daftar lingkungan komputasi yang kompatibel dengan koneksi.

## ConnectionInput struktur
<a name="aws-glue-api-catalog-connections-connections-ConnectionInput"></a>

Sebuah struktur yang digunakan untuk menentukan koneksi yang akan dibuat atau diperbarui.

**Bidang**
+ `Name` — *Wajib:* String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama koneksi.
+ `Description` — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Deskripsi koneksi.
+ `ConnectionType`— *Diperlukan:* UTF-8 string (nilai valid: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` `DATADOG` `WOOCOMMERCE`\$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO`\$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).

  Jenis koneksi. Saat ini, jenis-jenis berikut ini didukung:
  + `JDBC` - Menunjuk koneksi ke database melalui Java Database Connectivity (JDBC).

    `JDBC`Koneksi menggunakan yang berikut ini ConnectionParameters.
    + Diperlukan: Semua (`HOST`,`PORT`,`JDBC_ENGINE`) atau`JDBC_CONNECTION_URL`.
    + Diperlukan: Semua (`USERNAME`,`PASSWORD`) atau`SECRET_ID`.
    + Opsional:`JDBC_ENFORCE_SSL`,`CUSTOM_JDBC_CERT`,`CUSTOM_JDBC_CERT_STRING`,`SKIP_CUSTOM_JDBC_CERT_VALIDATION`. Parameter ini digunakan untuk mengkonfigurasi SSL dengan JDBC.
  + `KAFKA` - Menunjuk koneksi ke platform streaming Apache Kafka.

    `KAFKA`Koneksi menggunakan yang berikut ini ConnectionParameters.
    + Diperlukan:`KAFKA_BOOTSTRAP_SERVERS`.
    + Opsional:`KAFKA_SSL_ENABLED`,`KAFKA_CUSTOM_CERT`,`KAFKA_SKIP_CUSTOM_CERT_VALIDATION`. Parameter ini digunakan untuk mengkonfigurasi SSL dengan`KAFKA`.
    + Opsional:`KAFKA_CLIENT_KEYSTORE`,`KAFKA_CLIENT_KEYSTORE_PASSWORD`,`KAFKA_CLIENT_KEY_PASSWORD`,`ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`,`ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`. Parameter ini digunakan untuk mengkonfigurasi konfigurasi klien TLS dengan SSL di. `KAFKA`
    + Opsional:`KAFKA_SASL_MECHANISM`. Dapat ditentukan sebagai`SCRAM-SHA-512`,`GSSAPI`, atau`AWS_MSK_IAM`.
    + Opsional:`KAFKA_SASL_SCRAM_USERNAME`,`KAFKA_SASL_SCRAM_PASSWORD`,`ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`. Parameter ini digunakan untuk mengkonfigurasi otentikasi SASL/SCRAM-SHA-512 dengan. `KAFKA`
    + Opsional:`KAFKA_SASL_GSSAPI_KEYTAB`,`KAFKA_SASL_GSSAPI_KRB5_CONF`,`KAFKA_SASL_GSSAPI_SERVICE`,`KAFKA_SASL_GSSAPI_PRINCIPAL`. Parameter ini digunakan untuk mengkonfigurasi SASL/GSSAPI otentikasi dengan`KAFKA`.
  + `MONGODB` - Menunjuk koneksi ke database dokumen MongoDB.

    `MONGODB`Koneksi menggunakan yang berikut ini ConnectionParameters.
    + Diperlukan:`CONNECTION_URL`.
    + Diperlukan: Semua (`USERNAME`,`PASSWORD`) atau`SECRET_ID`.
  + `VIEW_VALIDATION_REDSHIFT`- Menetapkan koneksi yang digunakan untuk validasi tampilan oleh Amazon Redshift.
  + `VIEW_VALIDATION_ATHENA`- Menentukan koneksi yang digunakan untuk validasi tampilan oleh Amazon Athena.
  + `NETWORK` - Menunjuk koneksi jaringan ke sumber data dalam lingkungan Amazon Virtual Private Cloud (Amazon VPC).

    `NETWORK`Koneksi tidak memerlukan ConnectionParameters. Sebaliknya, berikan a PhysicalConnectionRequirements.
  + `MARKETPLACE`- Menggunakan pengaturan konfigurasi yang terdapat dalam konektor yang dibeli AWS Marketplace untuk membaca dan menulis ke penyimpanan data yang tidak didukung secara asli oleh AWS Glue.

    `MARKETPLACE`Koneksi menggunakan yang berikut ini ConnectionParameters.
    + Diperlukan:`CONNECTOR_TYPE`,`CONNECTOR_URL`,`CONNECTOR_CLASS_NAME`,`CONNECTION_URL`.
    + Diperlukan untuk `JDBC` `CONNECTOR_TYPE` koneksi: Semua (`USERNAME`,`PASSWORD`) atau`SECRET_ID`.
  + `CUSTOM` - Menggunakan pengaturan konfigurasi yang terkandung dalam sebuah konektor kustom untuk membaca dari dan menulis ke penyimpanan data yang tidak didukung secara asli oleh AWS Glue.

  Untuk informasi selengkapnya tentang parameter koneksi yang diperlukan untuk konektor tertentu, lihat dokumentasi untuk konektor di [Menambahkan AWS Glue koneksi](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html) di Panduan AWS Glue Pengguna.

  `SFTP` tidak didukung.

  Untuk informasi selengkapnya tentang cara opsional ConnectionProperties digunakan untuk mengonfigurasi fitur AWS Glue, lihat [properti AWS Glue koneksi](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html).

  Untuk informasi selengkapnya tentang cara opsional ConnectionProperties digunakan untuk mengonfigurasi fitur di AWS Glue Studio, lihat [Menggunakan konektor dan koneksi](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html).
+ `MatchCriteria` — Susunan string UTF-8, tidak lebih dari 10 string.

  Daftar kriteria yang dapat digunakan dalam memilih koneksi ini.
+ `ConnectionProperties` — *Wajib:* Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 100 pasang.

  Setiap kunci adalah string UTF-8 (nilai yang valid: `HOST` \$1 \$1 \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` `KAFKA_SASL_GSSAPI_KEYTAB` `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1`DATABASE`).

  Setiap nilai adalah string Nilai, panjangnya tidak kurang dari 1 atau lebih dari 1024 byte.

  Pasangan nilai-kunci ini menentukan parameter untuk koneksi.
+ `SparkProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte.

  Properti koneksi khusus untuk lingkungan komputasi Spark.
+ `AthenaProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte.

  Properti koneksi khusus untuk lingkungan komputasi Athena.
+ `PythonProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte.

  Properti koneksi khusus untuk lingkungan komputasi Python.
+ `PhysicalConnectionRequirements` — Sebuah objek [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements).

  Persyaratan koneksi fisik, seperti virtual private cloud (VPC) dan`SecurityGroup`, yang diperlukan untuk berhasil membuat koneksi ini.
+ `AuthenticationConfiguration` — Sebuah objek [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput).

  Properti otentikasi koneksi.
+ `ValidateCredentials` – Boolean.

  Bendera untuk memvalidasi kredensyal selama membuat koneksi. Default benar. 
+ `ValidateForComputeEnvironments` – Susunan string UTF-8.

  Lingkungan komputasi yang properti koneksi tertentu divalidasi terhadap.

## TestConnectionInput struktur
<a name="aws-glue-api-catalog-connections-connections-TestConnectionInput"></a>

Struktur yang digunakan untuk menentukan pengujian koneksi ke layanan.

**Bidang**
+ `ConnectionType`— *Diperlukan:* UTF-8 string (nilai valid: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` `DATADOG` `WOOCOMMERCE`\$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO`\$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).

  Jenis koneksi yang akan diuji. Operasi ini hanya tersedia untuk jenis `JDBC` atau `SALESFORCE` koneksi.
+ `ConnectionProperties` — *Wajib:* Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 100 pasang.

  Setiap kunci adalah string UTF-8 (nilai yang valid: `HOST` \$1 \$1 \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` `KAFKA_SASL_GSSAPI_KEYTAB` `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1`DATABASE`).

  Setiap nilai adalah string Nilai, panjangnya tidak kurang dari 1 atau lebih dari 1024 byte.

  Pasangan kunci-nilai yang menentukan parameter untuk koneksi.

  Koneksi JDBC menggunakan properti koneksi berikut:
  + Diperlukan: Semua (`HOST`,`PORT`,`JDBC_ENGINE`) atau`JDBC_CONNECTION_URL`.
  + Diperlukan: Semua (`USERNAME`,`PASSWORD`) atau`SECRET_ID`.
  + Opsional:`JDBC_ENFORCE_SSL`,`CUSTOM_JDBC_CERT`,`CUSTOM_JDBC_CERT_STRING`,`SKIP_CUSTOM_JDBC_CERT_VALIDATION`. Parameter ini digunakan untuk mengkonfigurasi SSL dengan JDBC.

  Koneksi SALESFORCE mengharuskan `AuthenticationConfiguration` anggota untuk dikonfigurasi.
+ `AuthenticationConfiguration` — Sebuah objek [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput).

  Struktur yang berisi konfigurasi otentikasi dalam TestConnection permintaan. Diperlukan untuk koneksi ke Salesforce menggunakan OAuth otentikasi.

## PhysicalConnectionRequirements struktur
<a name="aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements"></a>

Aplikasi OAuth klien GetConnection sebagai tanggapan.

**Bidang**
+ `SubnetId` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID subnet yang digunakan oleh koneksi.
+ `SecurityGroupIdList` — Susunan string UTF-8, tidak lebih dari 50 string.

  Daftar ID grup keamanan yang digunakan oleh koneksi.
+ `AvailabilityZone` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Availability Zone koneksi.

## GetConnectionsFilter struktur
<a name="aws-glue-api-catalog-connections-connections-GetConnectionsFilter"></a>

Mem-filter definisi koneksi yang dikembalikan oleh operasi API `GetConnections`.

**Bidang**
+ `MatchCriteria` — Susunan string UTF-8, tidak lebih dari 10 string.

  Sebuah kriteria string yang harus sesuai dengan kriteria yang dicatat dalam definisi koneksi untuk definisi koneksi yang akan dikembalikan.
+ `ConnectionType`— UTF-8 string (nilai valid: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE`\$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).

  Jenis koneksi yang akan dikembalikan. Saat ini, SFTP tidak didukung.
+ `ConnectionSchemaVersion`— Angka (bilangan bulat), tidak kurang dari 1 atau lebih dari 2.

  Menunjukkan jika koneksi dibuat dengan skema versi 1 atau 2.

## AuthenticationConfiguration struktur
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfiguration"></a>

Struktur yang berisi konfigurasi otentikasi.

**Bidang**
+ `AuthenticationType` – String UTF-8 (nilai yang valid: `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`).

  Struktur yang berisi konfigurasi otentikasi.
+ `SecretArn` — String UTF-8, yang cocok dengan [Custom string pattern #36](aws-glue-api-common.md#regex_36).

  Manajer rahasia ARN untuk menyimpan kredensi.
+ `KmsKeyArn` — String UTF-8, yang cocok dengan [Custom string pattern #42](aws-glue-api-common.md#regex_42).

  Nama Sumber Daya Amazon (ARN) dari kunci KMS yang digunakan untuk mengenkripsi informasi otentikasi sensitif. Kunci ini digunakan untuk melindungi kredensyal dan data sensitif lainnya yang disimpan dalam konfigurasi otentikasi.
+ `OAuth2Properties` — Sebuah objek [OAuth2Properti](#aws-glue-api-catalog-connections-connections-OAuth2Properties).

  Properti untuk OAuth2 otentikasi.

## AuthenticationConfigurationInput struktur
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput"></a>

Struktur yang berisi konfigurasi otentikasi dalam CreateConnection permintaan.

**Bidang**
+ `AuthenticationType` – String UTF-8 (nilai yang valid: `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`).

  Struktur yang berisi konfigurasi otentikasi dalam CreateConnection permintaan.
+ `OAuth2Properties` — Sebuah objek [OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput).

  Properti untuk OAuth2 otentikasi dalam CreateConnection permintaan.
+ `SecretArn` — String UTF-8, yang cocok dengan [Custom string pattern #36](aws-glue-api-common.md#regex_36).

  Manajer rahasia ARN untuk menyimpan kredensyal dalam permintaan. CreateConnection 
+ `KmsKeyArn` — String UTF-8, yang cocok dengan [Custom string pattern #42](aws-glue-api-common.md#regex_42).

  ARN dari kunci KMS digunakan untuk mengenkripsi koneksi. Hanya diambil sebagai input dalam permintaan dan disimpan di Secret Manager.
+ `BasicAuthenticationCredentials` — Sebuah objek [BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials).

  Kredensyal yang digunakan ketika jenis otentikasi adalah otentikasi dasar.
+ `CustomAuthenticationCredentials` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte.

  Kredensyal yang digunakan ketika jenis otentikasi adalah otentikasi kustom.

## OAuth2Struktur properti
<a name="aws-glue-api-catalog-connections-connections-OAuth2Properties"></a>

Struktur yang berisi properti untuk OAuth2 otentikasi.

**Bidang**
+ `OAuth2GrantType` – String UTF-8 (nilai yang valid: `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`).

  Jenis OAuth2 hibah. Sebagai contoh, `AUTHORIZATION_CODE`, `JWT_BEARER`, atau `CLIENT_CREDENTIALS`.
+ `OAuth2ClientApplication` — Sebuah objek [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication).

  Jenis aplikasi klien. Misalnya, AWS\$1MANAGED atau USER\$1MANAGED.
+ `TokenUrl`— String UTF-8, panjangnya tidak lebih dari 256 byte, cocok dengan file. [Custom string pattern #40](aws-glue-api-common.md#regex_40)

  URL server otentikasi penyedia, untuk menukar kode otorisasi untuk token akses.
+ `TokenUrlParametersMap` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 512 byte.

  Peta parameter yang ditambahkan ke `GET` permintaan token.

## OAuth2PropertiesInput struktur
<a name="aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput"></a>

Struktur yang berisi properti untuk OAuth2 dalam CreateConnection permintaan.

**Bidang**
+ `OAuth2GrantType` – String UTF-8 (nilai yang valid: `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`).

  Jenis OAuth2 hibah dalam CreateConnection permintaan. Sebagai contoh, `AUTHORIZATION_CODE`, `JWT_BEARER`, atau `CLIENT_CREDENTIALS`.
+ `OAuth2ClientApplication` — Sebuah objek [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication).

  Jenis aplikasi klien dalam CreateConnection permintaan. Misalnya, `AWS_MANAGED` atau `USER_MANAGED`.
+ `TokenUrl`— String UTF-8, panjangnya tidak lebih dari 256 byte, cocok dengan file. [Custom string pattern #40](aws-glue-api-common.md#regex_40)

  URL server otentikasi penyedia, untuk menukar kode otorisasi untuk token akses.
+ `TokenUrlParametersMap` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 512 byte.

  Peta parameter yang ditambahkan ke `GET` permintaan token.
+ `AuthorizationCodeProperties` — Sebuah objek [AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties).

  Kumpulan properti yang diperlukan untuk jenis OAuth2 `AUTHORIZATION_CODE` hibah.
+ `OAuth2Credentials` — Sebuah objek [OAuth2Kredensialnya](#aws-glue-api-catalog-connections-connections-OAuth2Credentials).

  Kredensyal yang digunakan saat jenis otentikasi adalah otentikasi. OAuth2 

## OAuth2ClientApplication struktur
<a name="aws-glue-api-catalog-connections-connections-OAuth2ClientApplication"></a>

Aplikasi OAuth2 klien yang digunakan untuk koneksi.

**Bidang**
+ `UserManagedClientApplicationClientId` — String UTF-8, sepanjang tidak lebih dari 2048, yang cocok dengan [Custom string pattern #37](aws-glue-api-common.md#regex_37).

  Aplikasi klien ClientID jika ada. ClientAppType `USER_MANAGED`
+ `AWSManagedClientApplicationReference` — String UTF-8, sepanjang tidak lebih dari 2048, yang cocok dengan [Custom string pattern #37](aws-glue-api-common.md#regex_37).

  Referensi ke aplikasi klien sisi SaaS yang dikelola AWS .

## AuthorizationCodeProperties struktur
<a name="aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties"></a>

Kumpulan properti yang diperlukan untuk alur kerja jenis OAuth2 `AUTHORIZATION_CODE` hibah.

**Bidang**
+ `AuthorizationCode`— String UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 4096 byte, cocok dengan file. [Custom string pattern #37](aws-glue-api-common.md#regex_37)

  Kode otorisasi yang akan digunakan di bagian ketiga alur kerja `AUTHORIZATION_CODE` hibah. Ini adalah kode sekali pakai yang menjadi tidak valid setelah ditukar dengan token akses, sehingga dapat diterima untuk memiliki nilai ini sebagai parameter permintaan.
+ `RedirectUri`— String UTF-8, panjangnya tidak lebih dari 512 byte, cocok dengan. [Custom string pattern #41](aws-glue-api-common.md#regex_41)

  URI pengalihan tempat pengguna diarahkan oleh server otorisasi saat mengeluarkan kode otorisasi. URI selanjutnya digunakan ketika kode otorisasi ditukar dengan token akses.

## BasicAuthenticationCredentials struktur
<a name="aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials"></a>

Untuk menyediakan kredensyal autentikasi dasar saat tidak memberikan nilai. `SecretArn`

**Bidang**
+ `Username`— String UTF-8, panjangnya tidak lebih dari 512 byte, cocok dengan. [Custom string pattern #37](aws-glue-api-common.md#regex_37)

  Nama pengguna untuk terhubung ke sumber data.
+ `Password`— String UTF-8, panjangnya tidak lebih dari 512 byte, cocok dengan. [Custom string pattern #33](aws-glue-api-common.md#regex_33)

  Kata sandi untuk terhubung ke sumber data.

## OAuth2Struktur kredensial
<a name="aws-glue-api-catalog-connections-connections-OAuth2Credentials"></a>

Kredensyal yang digunakan saat jenis otentikasi adalah otentikasi. OAuth2 

**Bidang**
+ `UserManagedClientApplicationClientSecret`— String UTF-8, panjangnya tidak lebih dari 512 byte, cocok dengan. [Custom string pattern #38](aws-glue-api-common.md#regex_38)

  Rahasia klien aplikasi klien jika aplikasi klien dikelola pengguna.
+ `AccessToken`— String UTF-8, panjangnya tidak lebih dari 4096 byte, cocok dengan. [Custom string pattern #38](aws-glue-api-common.md#regex_38)

  Token akses yang digunakan saat jenis otentikasi. OAuth2
+ `RefreshToken`— String UTF-8, panjangnya tidak lebih dari 4096 byte, cocok dengan. [Custom string pattern #38](aws-glue-api-common.md#regex_38)

  Token penyegaran yang digunakan saat jenis otentikasi. OAuth2
+ `JwtToken`— String UTF-8, panjangnya tidak lebih dari 8000 byte, cocok dengan. [Custom string pattern #39](aws-glue-api-common.md#regex_39)

  JSON Web Token (JWT) digunakan ketika jenis otentikasi. OAuth2

## Operasi
<a name="aws-glue-api-catalog-connections-connections-actions"></a>
+ [CreateConnection tindakan (Python: create\$1connection)](#aws-glue-api-catalog-connections-connections-CreateConnection)
+ [DeleteConnection tindakan (Python: delete\$1connection)](#aws-glue-api-catalog-connections-connections-DeleteConnection)
+ [GetConnection tindakan (Python: get\$1connection)](#aws-glue-api-catalog-connections-connections-GetConnection)
+ [GetConnections tindakan (Python: get\$1connections)](#aws-glue-api-catalog-connections-connections-GetConnections)
+ [UpdateConnection tindakan (Python: update\$1connection)](#aws-glue-api-catalog-connections-connections-UpdateConnection)
+ [TestConnection tindakan (Python: test\$1connection)](#aws-glue-api-catalog-connections-connections-TestConnection)
+ [BatchDeleteConnection tindakan (Python: batch\$1delete\$1connection)](#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)

## CreateConnection tindakan (Python: create\$1connection)
<a name="aws-glue-api-catalog-connections-connections-CreateConnection"></a>

Menciptakan sebuah definisi koneksi baru dalam Katalog Data.

Koneksi yang digunakan untuk membuat sumber daya federasi memerlukan izin IAM`glue:PassConnection`.

**Permintaan**
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID Katalog Data tempat koneksi akan dibuat. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.
+ `ConnectionInput` — *Wajib:* Sebuah objek [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput).

  Sebuah objek `ConnectionInput` yang mendefinisikan koneksi yang akan dibuat.
+ `Tags` — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 50 pasang.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak lebih dari 256 byte.

  Tag yang Anda tetapkan ke koneksi.

**Respons**
+ `CreateConnectionStatus` – String UTF-8 (nilai yang valid: `READY` \$1 `IN_PROGRESS` \$1 `FAILED`).

  Status permintaan pembuatan koneksi. Permintaan dapat memakan waktu untuk jenis otentikasi tertentu, misalnya saat membuat OAuth koneksi dengan pertukaran token melalui VPC.

**Kesalahan**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`

## DeleteConnection tindakan (Python: delete\$1connection)
<a name="aws-glue-api-catalog-connections-connections-DeleteConnection"></a>

Menghapus sebuah koneksi dari Katalog Data.

**Permintaan**
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.
+ `ConnectionName` — *Wajib:* String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama koneksi yang akan dihapus.

**Respons**
+ *Tidak ada parameter Respons.*

**Kesalahan**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetConnection tindakan (Python: get\$1connection)
<a name="aws-glue-api-catalog-connections-connections-GetConnection"></a>

Mengambil sebuah definisi koneksi dari Katalog Data.

**Permintaan**
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.
+ `Name` — *Wajib:* String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama definisi koneksi yang akan diambil.
+ `HidePassword` – Boolean.

  Memungkinkan Anda untuk mengambil metadata koneksi tanpa perlu mengembalikan kata sandi. Misalnya, AWS Glue konsol menggunakan bendera ini untuk mengambil koneksi, dan tidak menampilkan kata sandi. Tetapkan parameter ini ketika pemanggil mungkin tidak memiliki izin untuk menggunakan AWS KMS kunci untuk mendekripsi kata sandi, tetapi ia memiliki izin untuk mengakses properti koneksi lainnya.
+ `ApplyOverrideForComputeEnvironment` – String UTF-8 (nilai yang valid: `SPARK` \$1 `ATHENA` \$1 `PYTHON`).

  Untuk koneksi yang dapat digunakan dalam beberapa layanan, menentukan properti kembali untuk lingkungan komputasi yang ditentukan.

**Respons**
+ `Connection` — Sebuah objek [Koneksi](#aws-glue-api-catalog-connections-connections-Connection).

  Definisi koneksi yang diminta.

**Kesalahan**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## GetConnections tindakan (Python: get\$1connections)
<a name="aws-glue-api-catalog-connections-connections-GetConnections"></a>

Mengambil sebuah daftar definisi koneksi dari Katalog Data.

**Permintaan**
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.
+ `Filter` — Sebuah objek [GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter).

  Filter yang mengontrol koneksi mana yang dikembalikan.
+ `HidePassword` – Boolean.

  Memungkinkan Anda untuk mengambil metadata koneksi tanpa perlu mengembalikan kata sandi. Misalnya, AWS Glue konsol menggunakan bendera ini untuk mengambil koneksi, dan tidak menampilkan kata sandi. Tetapkan parameter ini ketika pemanggil mungkin tidak memiliki izin untuk menggunakan AWS KMS kunci untuk mendekripsi kata sandi, tetapi ia memiliki izin untuk mengakses properti koneksi lainnya.
+ `NextToken` – String UTF-8.

  Sebuah token kelanjutan, jika ini adalah panggilan kelanjutan.
+ `MaxResults` — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 1000.

  Jumlah maksimum koneksi yang akan dikembalikan dalam satu respons.

**Respons**
+ `ConnectionList` – Susunan objek [Koneksi](#aws-glue-api-catalog-connections-connections-Connection).

  Daftar definisi koneksi yang diminta.
+ `NextToken` – String UTF-8.

  Sebuah token kelanjutan, jika daftar koneksi yang dikembalikan tidak mencakup koneksi disaring yang terakhir.

**Kesalahan**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## UpdateConnection tindakan (Python: update\$1connection)
<a name="aws-glue-api-catalog-connections-connections-UpdateConnection"></a>

Memperbarui sebuah definisi koneksi baru dalam Katalog Data.

**Permintaan**
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.
+ `Name` — *Wajib:* String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama definisi koneksi yang akan diperbarui.
+ `ConnectionInput` — *Wajib:* Sebuah objek [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput).

  Sebuah objek `ConnectionInput` yang mengubah koneksi yang dimaksud.

**Respons**
+ *Tidak ada parameter Respons.*

**Kesalahan**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## TestConnection tindakan (Python: test\$1connection)
<a name="aws-glue-api-catalog-connections-connections-TestConnection"></a>

Menguji koneksi ke layanan untuk memvalidasi kredensyal layanan yang Anda berikan.

Anda dapat memberikan nama koneksi yang ada atau `TestConnectionInput` untuk menguji input koneksi yang tidak ada. Menyediakan keduanya pada saat yang sama akan menyebabkan kesalahan.

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

**Permintaan**
+ `ConnectionName` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Tidak wajib. Nama koneksi yang akan diuji. Jika hanya nama yang diberikan, operasi akan mendapatkan koneksi dan menggunakannya untuk pengujian.
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID katalog tempat koneksi berada.
+ `TestConnectionInput` — Sebuah objek [TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput).

  Struktur yang digunakan untuk menentukan pengujian koneksi ke layanan.

**Respons**
+ *Tidak ada parameter Respons.*

**Kesalahan**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `InternalServiceException`

## BatchDeleteConnection tindakan (Python: batch\$1delete\$1connection)
<a name="aws-glue-api-catalog-connections-connections-BatchDeleteConnection"></a>

Menghapus sebuah daftar definisi koneksi dari Katalog Data.

**Permintaan**
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.
+ `ConnectionNameList` — *Wajib:* Susunan string UTF-8, tidak lebih dari 25 string.

  Daftar nama koneksi yang akan dihapus.

**Respons**
+ `Succeeded` – Susunan string UTF-8.

  Daftar nama definisi koneksi yang sudah berhasil dihapus.
+ `Errors` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Setiap nilai adalah sebuah objek [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).

  Peta nama koneksi yang tidak berhasil dihapus ke detail kesalahan.

**Kesalahan**
+ `InternalServiceException`
+ `OperationTimeoutException`

# Jenis Koneksi API
<a name="aws-glue-api-catalog-connections-connections-type"></a>

Connection Type API menjelaskan AWS Glue APIs terkait dengan mendeskripsikan jenis koneksi.

## Manajemen koneksi APIs
<a name="aws-glue-api-catalog-connections-connections-type-connection-management"></a>
+ [DescribeConnectionType tindakan (Python: describe\$1connection\$1type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes tindakan (Python: list\$1connection\$1types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [ConnectionTypeBrief struktur](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [ConnectionTypeVariant struktur](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)

## DescribeConnectionType tindakan (Python: describe\$1connection\$1type)
<a name="aws-glue-api-catalog-connections-connections-type-DescribeConnectionType"></a>

`DescribeConnectionType`API memberikan rincian lengkap tentang opsi yang didukung untuk jenis koneksi tertentu AWS Glue.

**Permintaan**
+ `ConnectionType` — *Wajib:* String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama jenis koneksi yang akan dijelaskan.

**Respons**
+ `ConnectionType` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama jenis koneksi.
+ `Description`— String UTF-8, panjangnya tidak lebih dari 1024 byte.

  Deskripsi jenis koneksi.
+ `Capabilities` — Sebuah objek [Kemampuan](#aws-glue-api-catalog-connections-connections-type-Capabilities).

  Jenis otentikasi yang didukung, tipe antarmuka data (lingkungan komputasi), dan operasi data konektor.
+ `ConnectionProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Properti koneksi yang umum di seluruh lingkungan komputasi.
+ `ConnectionOptions` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Mengembalikan properti yang dapat diatur saat membuat koneksi di`ConnectionInput.ConnectionProperties`. `ConnectionOptions`mendefinisikan parameter yang dapat diatur dalam skrip Spark ETL di peta opsi koneksi yang diteruskan ke kerangka data.
+ `AuthenticationConfiguration` — Sebuah objek [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration).

  Jenis otentikasi yang digunakan untuk koneksi.
+ `ComputeEnvironmentConfigurations` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) A.

  Lingkungan komputasi yang didukung oleh koneksi.
+ `PhysicalConnectionRequirements` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Persyaratan fisik untuk koneksi, seperti spesifikasi VPC, Subnet, dan Grup Keamanan.
+ `AthenaConnectionProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Properti koneksi khusus untuk lingkungan komputasi Athena.
+ `PythonConnectionProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Properti koneksi khusus untuk lingkungan komputasi Python.
+ `SparkConnectionProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Properti koneksi khusus untuk lingkungan komputasi Spark.

**Kesalahan**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`

## ListConnectionTypes tindakan (Python: list\$1connection\$1types)
<a name="aws-glue-api-catalog-connections-connections-type-ListConnectionTypes"></a>

`ListConnectionTypes`API menyediakan mekanisme penemuan untuk mempelajari jenis koneksi yang tersedia di AWS Glue. Respons berisi daftar jenis koneksi dengan detail tingkat tinggi tentang apa yang didukung untuk setiap jenis koneksi. Jenis koneksi yang tercantum adalah kumpulan opsi yang didukung untuk `ConnectionType` nilai di `CreateConnection` API.

**Permintaan**
+ `MaxResults` — Nomor (bilangan bulat), tidak kurang dari 1 atau lebih dari 1000.

  Jumlah hasil maksimum yang akan dikembalikan.
+ `NextToken` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 2048 byte, yang cocok dengan [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Sebuah token kelanjutan, jika ini adalah panggilan kelanjutan.

**Respons**
+ `ConnectionTypes` – Susunan objek [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief).

  Daftar `ConnectionTypeBrief` objek yang berisi informasi singkat tentang jenis koneksi yang didukung.
+ `NextToken` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 2048 byte, yang cocok dengan [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Token kelanjutan, jika segmen daftar saat ini bukan yang terakhir.

**Kesalahan**
+ `InternalServiceException`

## ConnectionTypeBrief struktur
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief"></a>

Informasi singkat tentang jenis koneksi yang didukung yang dikembalikan oleh `ListConnectionTypes` API.

**Bidang**
+ `ConnectionType`— UTF-8 string (nilai yang valid: `JDBC` `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE`\$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).

  Nama jenis koneksi.
+ `DisplayName` — String UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Nama yang dapat dibaca manusia untuk jenis koneksi yang ditampilkan di konsol. AWS Glue 
+ `Vendor` — String UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Nama vendor atau penyedia yang membuat atau memelihara jenis koneksi ini.
+ `Description`— String UTF-8, panjangnya tidak lebih dari 1024 byte.

  Deskripsi jenis koneksi.
+ `Categories` – .

  Daftar kategori yang dimiliki oleh jenis koneksi ini. Kategori membantu pengguna memfilter dan menemukan jenis koneksi yang sesuai berdasarkan kasus penggunaannya.
+ `Capabilities` — Sebuah objek [Kemampuan](#aws-glue-api-catalog-connections-connections-type-Capabilities).

  Jenis otentikasi yang didukung, tipe antarmuka data (lingkungan komputasi), dan operasi data konektor.
+ `LogoUrl` – String UTF-8.

  URL logo yang terkait dengan jenis koneksi.
+ `ConnectionTypeVariants` – Susunan objek [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant).

  Daftar varian yang tersedia untuk jenis koneksi ini. Varian yang berbeda dapat menyediakan konfigurasi khusus untuk kasus penggunaan tertentu atau implementasi dari jenis koneksi umum yang sama.

## ConnectionTypeVariant struktur
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant"></a>

Merupakan varian dari jenis koneksi dalam Katalog AWS Glue Data. Varian tipe koneksi menyediakan konfigurasi dan perilaku spesifik untuk implementasi yang berbeda dari jenis koneksi umum yang sama.

**Bidang**
+ `ConnectionTypeVariantName` — String UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Pengidentifikasi unik untuk varian tipe koneksi. Nama ini digunakan secara internal untuk mengidentifikasi varian spesifik dari jenis koneksi. 
+ `DisplayName` — String UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Nama yang dapat dibaca manusia untuk varian jenis koneksi yang ditampilkan di konsol. AWS Glue 
+ `Description`— String UTF-8, panjangnya tidak lebih dari 1024 byte.

  Penjelasan rinci tentang varian jenis koneksi, termasuk tujuannya, kasus penggunaan, dan persyaratan konfigurasi spesifik apa pun.
+ `LogoUrl` – String UTF-8.

  URL logo yang terkait dengan varian jenis koneksi.

## tipe data
<a name="aws-glue-api-catalog-connections-connections-type-connection-types"></a>
+ [Struktur validasi](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [AuthConfiguration struktur](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [Struktur kemampuan](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [Struktur properti](#aws-glue-api-catalog-connections-connections-type-Property)
+ [AllowedValue struktur](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [ComputeEnvironmentConfiguration struktur](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)

## Struktur validasi
<a name="aws-glue-api-catalog-connections-connections-type-Validation"></a>

Mendefinisikan bagaimana validasi dilakukan pada properti koneksi.

**Bidang**
+ `ValidationType` – *Wajib:* String UTF-8 (nilai yang valid: `REGEX` \$1 `RANGE`).

  Jenis validasi yang akan dilakukan, seperti`REGEX`.
+ `Patterns` – .

  Daftar pola yang berlaku untuk validasi.
+ `Description`- *Diperlukan:* string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 1024 byte.

  Deskripsi untuk validasi.
+ `MaxLength` — Nomor (bilangan bulat).

  Panjang maksimum untuk properti koneksi string.
+ `Maximum` — Nomor (bilangan bulat).

  Nilai maksimum saat menentukan `RANGE` jenis validasi.
+ `Minimum` — Nomor (bilangan bulat).

  Nilai minimum saat menentukan `RANGE` jenis validasi.

## AuthConfiguration struktur
<a name="aws-glue-api-catalog-connections-connections-type-AuthConfiguration"></a>

Konfigurasi otentikasi untuk koneksi yang dikembalikan oleh `DescribeConnectionType` API.

**Bidang**
+ `AuthenticationType` — *Wajib:* Sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property).

  Jenis otentikasi untuk koneksi.
+ `SecretArn` — Sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property).

  Nama Sumber Daya Amazon (ARN) untuk Secrets Manager.
+ `OAuth2Properties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Peta pasangan kunci-nilai untuk properti. OAuth2 Setiap nilai adalah `Property` objek.
+ `BasicAuthenticationProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Peta pasangan kunci-nilai untuk properti. OAuth2 Setiap nilai adalah `Property` objek.
+ `CustomAuthenticationProperties` – Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Peta pasangan kunci-nilai untuk properti otentikasi kustom. Setiap nilai adalah `Property` objek.

## Struktur kemampuan
<a name="aws-glue-api-catalog-connections-connections-type-Capabilities"></a>

Menentukan jenis otentikasi didukung dikembalikan oleh API. `DescribeConnectionType`

**Bidang**
+ `SupportedAuthenticationTypes` – *Wajib:* Susunan string UTF-8.

  Daftar jenis otentikasi yang didukung.
+ `SupportedDataOperations` – *Wajib:* Susunan string UTF-8.

  Daftar operasi data yang didukung.
+ `SupportedComputeEnvironments` – *Wajib:* Susunan string UTF-8.

  Daftar lingkungan komputasi yang didukung.

## Struktur properti
<a name="aws-glue-api-catalog-connections-connections-type-Property"></a>

Objek yang mendefinisikan jenis koneksi untuk lingkungan komputasi.

**Bidang**
+ `Name`- *Diperlukan:* string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 128 byte.

  Nama properti.
+ `Description`- *Diperlukan:* string UTF-8, panjangnya tidak lebih dari 1024 byte.

  Deskripsi properti.
+ `Required` – *Wajib:* Boolean.

  Menunjukkan apakah properti diperlukan.
+ `PropertyTypes` – *Wajib:* Susunan string UTF-8.

  Menjelaskan jenis properti.
+ `AllowedValues` – Susunan objek [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue).

  Daftar `AllowedValue` objek yang mewakili nilai yang diizinkan untuk properti.
+ `DataOperationScopes` – Susunan string UTF-8.

  Menunjukkan operasi data mana yang berlaku untuk properti.

## AllowedValue struktur
<a name="aws-glue-api-catalog-connections-connections-type-AllowedValue"></a>

Objek yang mewakili nilai yang diizinkan untuk properti.

**Bidang**
+ `Description`— String UTF-8, panjangnya tidak lebih dari 1024 byte.

  Deskripsi nilai yang diizinkan.
+ `Value`- *Diperlukan:* string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 128 byte.

  Nilai yang diizinkan untuk properti.

## ComputeEnvironmentConfiguration struktur
<a name="aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration"></a>

Objek yang berisi konfigurasi untuk lingkungan komputasi (seperti Spark, Python, atau Athena) yang dikembalikan oleh API. `DescribeConnectionType`

**Bidang**
+ `Name`- *Diperlukan:* string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 128 byte.

  Nama untuk konfigurasi lingkungan komputasi.
+ `Description`- *Diperlukan:* string UTF-8, panjangnya tidak lebih dari 1024 byte.

  Deskripsi lingkungan komputasi.
+ `ComputeEnvironment` – *Wajib:* String UTF-8 (nilai yang valid: `SPARK` \$1 `ATHENA` \$1 `PYTHON`).

  Tipe lingkungan komputasi.
+ `SupportedAuthenticationTypes` – *Wajib:* Susunan string UTF-8.

  Jenis otentikasi yang didukung untuk lingkungan komputasi.
+ `ConnectionOptions` – *Wajib:* Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah sebuah objek [Properti](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Parameter yang digunakan sebagai opsi koneksi untuk lingkungan komputasi.
+ `ConnectionPropertyNameOverrides` – *Wajib:* Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 128 byte.

  Nama properti koneksi diganti untuk lingkungan komputasi.
+ `ConnectionOptionNameOverrides` – *Wajib:* Susunan peta pasangan nilai kunci.

  Masing-masing kunci adalah sebuah string UTF-8, dengan panjang tidak kurang dari 1 atau lebih dari 128 byte.

  Setiap nilai adalah string UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 128 byte.

  Nama opsi koneksi menggantikan untuk lingkungan komputasi.
+ `ConnectionPropertiesRequiredOverrides`— *Diperlukan:*.

  Properti koneksi yang diperlukan sebagai penggantian untuk lingkungan komputasi.
+ `PhysicalConnectionPropertiesRequired` – Boolean.

  Menunjukkan `PhysicalConnectionProperties` apakah diperlukan untuk lingkungan komputasi.

# Metadata Koneksi dan API Pratinjau
<a name="aws-glue-api-catalog-connections-connections-metadata"></a>

Koneksi berikut APIs menjelaskan operasi untuk menggambarkan metadata koneksi.

## Jenis Data
<a name="aws-glue-api-catalog-connections-connections-metadata-objects"></a>
+ [Struktur entitas](#aws-glue-api-catalog-connections-connections-metadata-Entity)
+ [Struktur lapangan](#aws-glue-api-catalog-connections-connections-metadata-Field)

## Struktur entitas
<a name="aws-glue-api-catalog-connections-connections-metadata-Entity"></a>

Entitas yang didukung oleh yang diberikan`ConnectionType`.

**Bidang**
+ `EntityName` – String UTF-8.

  Nama entitas.
+ `Label` – String UTF-8.

  Label yang digunakan untuk entitas.
+ `IsParentEntity` – Boolean.

  Sebuah nilai Boolean yang membantu untuk menentukan apakah ada sub objek yang dapat terdaftar.
+ `Description` – String UTF-8.

  Deskripsi entitas.
+ `Category` – String UTF-8.

  Jenis entitas yang hadir dalam respons. Nilai ini tergantung pada koneksi sumber. Misalnya ini `SObjects` untuk Salesforce dan `databases` atau `schemas` atau `tables` untuk sumber seperti Amazon Redshift.
+ `CustomProperties` – 

  Peta opsional kunci yang dapat dikembalikan untuk entitas oleh konektor.

## Struktur lapangan
<a name="aws-glue-api-catalog-connections-connections-metadata-Field"></a>

`Field`Objek memiliki informasi tentang berbagai properti yang terkait dengan bidang di konektor.

**Bidang**
+ `FieldName` – String UTF-8.

  Pengenal unik untuk bidang tersebut.
+ `Label` – String UTF-8.

  Label yang dapat dibaca yang digunakan untuk bidang tersebut.
+ `Description` – String UTF-8.

  Deskripsi lapangan.
+ `FieldType`— UTF-8 string (nilai valid: `INT` \$1 \$1 `SMALLINT` \$1 `BIGINT` \$1 `FLOAT` \$1 `LONG` \$1 `DATE` \$1 `BOOLEAN` \$1 `MAP` \$1 `ARRAY` \$1 \$1 `STRING` \$1 `TIMESTAMP` \$1 `DECIMAL` \$1 `BYTE` `SHORT` `DOUBLE` \$1`STRUCT`).

  Jenis data di lapangan.
+ `IsPrimaryKey` – Boolean.

  Menunjukkan apakah bidang ini dapat digunakan sebagai kunci utama untuk entitas yang diberikan.
+ `IsNullable` – Boolean.

  Menunjukkan apakah bidang ini dapat dibatalkan atau tidak.
+ `IsRetrievable` – Boolean.

  Menunjukkan apakah bidang ini dapat ditambahkan dalam klausa Pilih dari kueri SQL atau apakah itu dapat diambil atau tidak.
+ `IsFilterable` – Boolean.

   Menunjukkan apakah bidang ini dapat digunakan dalam klausa filter (`WHERE`klausa) dari pernyataan SQL saat menanyakan data. 
+ `IsPartitionable` – Boolean.

  Menunjukkan apakah bidang tertentu dapat digunakan dalam mempartisi kueri yang dibuat untuk SaaS.
+ `IsCreateable` – Boolean.

  Menunjukkan apakah bidang ini dapat dibuat sebagai bagian dari penulisan tujuan.
+ `IsUpdateable` – Boolean.

  Menunjukkan apakah bidang ini dapat diperbarui sebagai bagian dari penulisan tujuan.
+ `IsUpsertable` – Boolean.

  Menunjukkan apakah bidang ini dapat diangkat sebagai bagian dari penulisan tujuan.
+ `IsDefaultOnCreate` – Boolean.

  Menunjukkan apakah bidang ini diisi secara otomatis ketika objek dibuat, seperti dibuat pada stempel waktu.
+ `SupportedValues` – .

  Daftar nilai yang didukung untuk bidang tersebut.
+ `SupportedFilterOperators` – Susunan string UTF-8.

  Menunjukkan operator filter dukungan untuk bidang ini.
+ `CustomProperties` – 

  Peta opsional kunci yang dapat dikembalikan.

## Operasi
<a name="aws-glue-api-catalog-connections-connections-metadata-actions"></a>
+ [ListEntities tindakan (Python: list\$1entities)](#aws-glue-api-catalog-connections-connections-metadata-ListEntities)
+ [DescribeEntity tindakan (Python: describe\$1entity)](#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity)
+ [GetEntityRecords tindakan (Python: get\$1entity\$1records)](#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords)

## ListEntities tindakan (Python: list\$1entities)
<a name="aws-glue-api-catalog-connections-connections-metadata-ListEntities"></a>

Mengembalikan entitas yang tersedia didukung oleh jenis koneksi. 

**Permintaan**
+ `ConnectionName` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama untuk koneksi yang memerlukan kredensi untuk menanyakan jenis koneksi apa pun.
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID katalog katalog yang berisi koneksi. Ini bisa null, Secara default, ID AWS Akun adalah ID katalog.
+ `ParentEntityName` – String UTF-8.

  Nama entitas induk yang ingin Anda daftarkan anak-anak. Parameter ini mengambil jalur entitas yang sepenuhnya memenuhi syarat untuk membuat daftar entitas anak.
+ `NextToken` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 2048 byte, yang cocok dengan [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Sebuah token kelanjutan, disertakan jika ini adalah sebuah panggilan kelanjutan.
+ `DataStoreApiVersion` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 256 byte, yang cocok dengan [Custom string pattern #23](aws-glue-api-common.md#regex_23).

  Versi API dari konektor SaaS.

**Respons**
+ `Entities` – Susunan objek [Entitas](#aws-glue-api-catalog-connections-connections-metadata-Entity).

  Daftar objek `Entity`.
+ `NextToken` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 2048 byte, yang cocok dengan [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Token kelanjutan, hadir jika segmen saat ini bukan yang terakhir.

**Kesalahan**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`

## DescribeEntity tindakan (Python: describe\$1entity)
<a name="aws-glue-api-catalog-connections-connections-metadata-DescribeEntity"></a>

Memberikan rincian mengenai entitas yang digunakan dengan jenis koneksi, dengan deskripsi model data untuk setiap bidang dalam entitas yang dipilih.

 Respons mencakup semua bidang yang membentuk entitas.

**Permintaan**
+ `ConnectionName` — *Wajib:* String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama koneksi yang berisi kredenal jenis koneksi.
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID katalog katalog yang berisi koneksi. Ini bisa null, Secara default, ID AWS Akun adalah ID katalog.
+ `EntityName` – *Wajib:* String UTF-8.

  Nama entitas yang ingin Anda gambarkan dari jenis koneksi.
+ `NextToken` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 2048 byte, yang cocok dengan [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Sebuah token kelanjutan, disertakan jika ini adalah sebuah panggilan kelanjutan.
+ `DataStoreApiVersion` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 256 byte, yang cocok dengan [Custom string pattern #23](aws-glue-api-common.md#regex_23).

  Versi API yang digunakan untuk penyimpanan data.

**Respons**
+ `Fields` – Susunan objek [Bidang](#aws-glue-api-catalog-connections-connections-metadata-Field).

  Menjelaskan bidang untuk entitas konektor tersebut. Ini adalah daftar `Field` objek. `Field`sangat mirip dengan kolom dalam database. `Field`Objek memiliki informasi tentang berbagai properti yang terkait dengan bidang di konektor.
+ `NextToken` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 2048 byte, yang cocok dengan [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Token kelanjutan, hadir jika segmen saat ini bukan yang terakhir.

**Kesalahan**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`

## GetEntityRecords tindakan (Python: get\$1entity\$1records)
<a name="aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords"></a>

API ini digunakan untuk menanyakan data pratinjau dari jenis koneksi tertentu atau dari Katalog AWS Glue Data berbasis Amazon S3 asli.

Mengembalikan catatan sebagai array gumpalan JSON. Setiap rekaman diformat menggunakan Jackson JsonNode berdasarkan jenis bidang yang ditentukan oleh `DescribeEntity` API.

Konektor percikan menghasilkan skema sesuai dengan pemetaan tipe data yang sama seperti di API. `DescribeEntity` Konektor percikan mengonversi data ke tipe data yang sesuai yang cocok dengan skema saat mengembalikan baris.

**Permintaan**
+ `ConnectionName` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nama koneksi yang berisi kredenal jenis koneksi.
+ `CatalogId` — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  ID katalog katalog yang berisi koneksi. Ini bisa null, Secara default, ID AWS Akun adalah ID katalog.
+ `EntityName` – *Wajib:* String UTF-8.

  Nama entitas yang ingin kita kueri data pratinjau dari jenis koneksi yang diberikan.
+ `NextToken` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 2048 byte, yang cocok dengan [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Sebuah token kelanjutan, disertakan jika ini adalah sebuah panggilan kelanjutan.
+ `DataStoreApiVersion` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 256 byte, yang cocok dengan [Custom string pattern #23](aws-glue-api-common.md#regex_23).

  Versi API dari konektor SaaS.
+ `ConnectionOptions` — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 100 pasang.

  Setiap kunci adalah string UTF-8, tidak kurang dari 1 atau lebih dari 256 byte panjang, cocok dengan. [Custom string pattern #18](aws-glue-api-common.md#regex_18)

  Setiap nilai adalah string UTF-8, tidak kurang dari 1 atau lebih dari 256 byte panjang, cocok dengan. [Custom string pattern #17](aws-glue-api-common.md#regex_17)

  Opsi konektor yang diperlukan untuk menanyakan data.
+ `FilterPredicate`- String UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 100000 byte.

  Predikat filter yang dapat Anda terapkan dalam permintaan kueri.
+ `Limit`— *Wajib:* Jumlah (panjang), tidak kurang dari 1 atau lebih dari 1000.

  Membatasi jumlah catatan yang diambil dengan permintaan.
+ `SelectedFields`— Array string UTF-8, tidak kurang dari 1 atau lebih dari 1000 string.

   Daftar bidang yang ingin kita ambil sebagai bagian dari data pratinjau.

**Respons**
+ `Records`— Sebuah array dari struktur.

  Daftar objek yang diminta.
+ `NextToken` — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 2048 byte, yang cocok dengan [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Token kelanjutan, hadir jika segmen saat ini bukan yang terakhir.

**Kesalahan**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`