View a markdown version of this page

API Koneksi - AWS Lem

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

API Koneksi

API Koneksi menjelaskan jenis data AWS Glue koneksi, dan API untuk membuat, menghapus, memperbarui, dan mencantumkan koneksi.

Jenis Data

Struktur koneksi

Mendefinisikan sebuah koneksi ke sumber data.

Bidang
  • Name— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Nama definisi koneksi.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Deskripsi koneksi.

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

    Jenis koneksi. Saat ini, SFTP tidak didukung.

  • MatchCriteria— Sebuah array UTF-8 string, 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 UTF-8 string (nilai yang valid: HOST PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | KAFKA_SASL_MECHANISM KAFKA_SASL_PLAIN_USERNAME | KAFKA_SASL_PLAIN_PASSWORD | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | KAFKA_SASL_SCRAM_USERNAME | KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_SCRAM_SECRETS_ARN | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB | KAFKA_SASL_GSSAPI_KRB5_CONF| KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | ENDPOINT | ENDPOINT_TYPE | ROLE_ARN | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE).

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

    Pasangan kunci-nilai ini menentukan parameter untuk koneksi saat menggunakan skema koneksi versi 1:

    • HOST - URI host: baik fully qualified domain name (FQDN) atau alamat IPv4 dari basis data host.

    • 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 yang tidak peka huruf besar/kecil (true, false) yang menentukan apakah Secure Sockets Layer (SSL) dengan pencocokan nama host diterapkan 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 X.509 sertifikat. Sertifikat yang diberikan harus DER-encoded dan disediakan dalam format PEM pengkodean Base64.

    • SKIP_CUSTOM_JDBC_CERT_VALIDATION- Secara default, ini adalahfalse. AWS Glue memvalidasi algoritma Tanda tangan dan Algoritma Kunci Publik Subjek untuk sertifikat pelanggan. Algoritme yang diizinkan untuk Algoritme Tanda Tangan adalah SHA256withRSA, SHA384withRSA or SHA512withRSA. 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 - Sebuah string sertifikat JDBC kustom yang digunakan untuk pencocokan domain atau pencocokan nama 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: SHA256withRSA, SHA384withRSA dan SHA512withRSA. 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 penyimpanan kunci klien Kafka (jika pengguna memiliki pengaturan kata sandi en AWS Glue kripsi yang dipilih).

    • ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD- Versi terenkripsi dari kata sandi kunci klien Kafka (jika pengguna memiliki pengaturan kata sandi en AWS Glue kripsi yang dipilih).

    • KAFKA_SASL_MECHANISM-"SCRAM-SHA-512","GSSAPI","AWS_MSK_IAM", atau"PLAIN". Ini adalah Mekanisme https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml SASL yang didukung.

    • KAFKA_SASL_PLAIN_USERNAME- Nama pengguna plaintext yang digunakan untuk mengotentikasi dengan mekanisme “PLAIN”.

    • KAFKA_SASL_PLAIN_PASSWORD- Kata sandi plaintext yang digunakan untuk mengotentikasi dengan mekanisme “PLAIN”.

    • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD- Versi terenkripsi dari kata sandi Kafka SASL PLAIN (jika pengguna memiliki pengaturan kata sandi en AWS Glue kripsi yang dipilih).

    • KAFKA_SASL_SCRAM_USERNAME- Nama pengguna plaintext yang digunakan untuk mengotentikasi dengan mekanisme SCRAM-SHA-512 "”.

    • KAFKA_SASL_SCRAM_PASSWORD- Kata sandi plaintext yang digunakan untuk mengotentikasi dengan mekanisme SCRAM-SHA-512 "”.

    • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD- Versi terenkripsi dari kata sandi SCRAM Kafka SASL (jika pengguna memiliki pengaturan kata sandi en AWS Glue kripsi yang dipilih).

    • KAFKA_SASL_SCRAM_SECRETS_ARN- Nama Sumber Daya Amazon dari rahasia di Manajer AWS Rahasia.

    • KAFKA_SASL_GSSAPI_KEYTAB- Lokasi S3 dari file Kerberoskeytab. Keytab menyimpan kunci jangka panjang untuk satu atau lebih prinsipal. Untuk informasi selengkapnya, lihat Dokumentasi MIT Kerberos: Keytab.

    • KAFKA_SASL_GSSAPI_KRB5_CONF- Lokasi S3 dari file Kerberoskrb5.conf. Sebuah krb5.conf menyimpan informasi konfigurasi Kerberos, seperti lokasi server KDC. Untuk informasi selengkapnya, lihat Dokumentasi MIT Kerberos: krb5.conf.

    • KAFKA_SASL_GSSAPI_SERVICE- Nama layanan Kerberos, seperti yang ditetapkan sasl.kerberos.service.name dalam Konfigurasi Kafka Anda.

    • KAFKA_SASL_GSSAPI_PRINCIPAL- Nama princial Kerberos yang digunakan oleh. AWS Glue Untuk informasi selengkapnya, lihat Dokumentasi Kafka: Mengkonfigurasi Broker Kafka.

    • ROLE_ARN- Peran yang akan digunakan untuk menjalankan query.

    • REGION- Wil AWS ayah tempat query akan dijalankan.

    • WORKGROUP_NAME- Nama grup kerja tanpa server Amazon Redshift atau kelompok kerja Amazon Athena tempat kueri akan dijalankan.

    • CLUSTER_IDENTIFIER- Pengidentifikasi cluster dari cluster Amazon Redshift tempat kueri akan dijalankan.

    • DATABASE- Database Amazon Redshift yang Anda sambungkan.

  • SparkProperties – Susunan peta pasangan nilai kunci.

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

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

    Properti koneksi khusus untuk lingkungan komputasi Spark.

  • AthenaProperties – Susunan peta pasangan nilai kunci.

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

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

    Properti koneksi khusus untuk lingkungan komputasi Athena.

  • PythonProperties – Susunan peta pasangan nilai kunci.

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

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

    Properti koneksi khusus untuk lingkungan komputasi Python.

  • PhysicalConnectionRequirements — Sebuah objek PhysicalConnectionRequirements.

    Persyaratan koneksi fisik, seperti virtual private cloud (VPC) danSecurityGroup, yang diperlukan untuk membuat koneksi ini berhasil.

  • CreationTime — Stempel waktu.

    Stempel waktu saat definisi koneksi ini dibuat.

  • LastUpdatedTime — Stempel waktu.

    Stempel waktu terakhir kali definisi koneksi diperbarui.

  • LastUpdatedBy— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Pengguna, grup, atau peran yang terakhir memperbarui definisi koneksi ini.

  • Status— UTF-8 string (nilai valid: READY | IN_PROGRESS |FAILED).

    Status koneksi. Bisa salah satu dari:READY,IN_PROGRESS, atauFAILED.

  • StatusReason— UTF-8 string, tidak kurang dari 1 atau lebih dari 16384 byte panjangnya.

    Alasan untuk status koneksi.

  • LastConnectionValidationTime — Stempel waktu.

    Stempel waktu saat koneksi ini terakhir divalidasi.

  • AuthenticationConfiguration — Sebuah objek AuthenticationConfiguration.

    Properti otentikasi koneksi.

  • ConnectionSchemaVersion— Angka (integer), tidak kurang dari 1 atau lebih dari 2.

    Versi skema koneksi untuk koneksi ini. Versi 2 mendukung properti untuk lingkungan komputasi tertentu.

  • CompatibleComputeEnvironments— Sebuah array UTF-8 string.

    Daftar lingkungan komputasi yang kompatibel dengan koneksi.

ConnectionInput struktur

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

Bidang
  • Name- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Nama koneksi.

  • Description — String deskripsi, dengan panjang tidak lebih dari 2048 byte, yang cocok dengan URI address multi-line string pattern.

    Deskripsi koneksi.

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

    Jenis koneksi. Saat ini, jenis-jenis berikut ini didukung:

    • JDBC - Menunjuk koneksi ke database melalui Java Database Connectivity (JDBC).

      JDBCKoneksi menggunakan yang berikut ini ConnectionParameters.

      • Diperlukan: Semua (HOST,PORT,JDBC_ENGINE) atauJDBC_CONNECTION_URL.

      • Diperlukan: Semua (USERNAME,PASSWORD) atauSECRET_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.

      KAFKAKoneksi 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 denganKAFKA.

      • 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 diKAFKA.

      • Opsional:KAFKA_SASL_MECHANISM. Dapat ditentukan sebagaiSCRAM-SHA-512,GSSAPI, atauAWS_MSK_IAM.

      • Opsional:KAFKA_SASL_SCRAM_USERNAME,KAFKA_SASL_SCRAM_PASSWORD,ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. Parameter ini digunakan untuk mengkonfigurasi SASL/SCRAM-SHA-512 otentikasi denganKAFKA.

      • 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 denganKAFKA.

    • MONGODB - Menunjuk koneksi ke database dokumen MongoDB.

      MONGODBKoneksi menggunakan yang berikut ini ConnectionParameters.

      • Diperlukan:CONNECTION_URL.

      • Diperlukan: Semua (USERNAME,PASSWORD) atauSECRET_ID.

    • VIEW_VALIDATION_REDSHIFT- Menunjuk koneksi yang digunakan untuk validasi tampilan oleh Amazon Redshift.

    • VIEW_VALIDATION_ATHENA- Menunjuk koneksi yang digunakan untuk validasi tampilan oleh Amazon Athena.

    • NETWORK - Menunjuk koneksi jaringan ke sumber data dalam lingkungan Amazon Virtual Private Cloud (Amazon VPC).

      NETWORKKoneksi tidak diperlukan ConnectionParameters. Sebagai gantinya, berikan a PhysicalConnectionRequirements.

    • MARKETPLACE- Menggunakan pengaturan konfigurasi yang terkandung dalam konektor yang dibeli AWS Marketplace untuk membaca dan menulis ke penyimpanan data yang tidak didukung secara asli oleh AWS Glue.

      MARKETPLACEKoneksi menggunakan yang berikut ini ConnectionParameters.

      • Diperlukan:CONNECTOR_TYPE,CONNECTOR_URL,CONNECTOR_CLASS_NAME,CONNECTION_URL.

      • Diperlukan untuk JDBC CONNECTOR_TYPE koneksi: Semua (USERNAME,PASSWORD) atauSECRET_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 Men AWS Glue ambahkan koneksi di Panduan AWS Glue Pengguna.

    SFTP tidak didukung.

    Untuk informasi selengkapnya tentang cara opsional ConnectionProperties digunakan untuk mengkonfigurasi fitur di AWS Glue, lihat AWS Glue properti koneksi.

    Untuk informasi selengkapnya tentang cara opsional ConnectionProperties digunakan untuk mengkonfigurasi fitur di AWS Glue Studio, baca Menggunakan konektor dan koneksi.

  • MatchCriteria— Sebuah array UTF-8 string, tidak lebih dari 10 string.

    Daftar kriteria yang dapat digunakan dalam memilih koneksi ini.

  • ConnectionPropertiesWajib: Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 100 pasang.

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

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

    Pasangan nilai-kunci ini menentukan parameter untuk koneksi.

  • SparkProperties – Susunan peta pasangan nilai kunci.

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

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

    Properti koneksi khusus untuk lingkungan komputasi Spark.

  • AthenaProperties – Susunan peta pasangan nilai kunci.

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

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

    Properti koneksi khusus untuk lingkungan komputasi Athena.

  • PythonProperties – Susunan peta pasangan nilai kunci.

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

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

    Properti koneksi khusus untuk lingkungan komputasi Python.

  • PhysicalConnectionRequirements — Sebuah objek PhysicalConnectionRequirements.

    Persyaratan koneksi fisik, seperti virtual private cloud (VPC) danSecurityGroup, yang diperlukan untuk berhasil membuat koneksi ini.

  • AuthenticationConfiguration — Sebuah objek AuthenticationConfigurationInput.

    Properti otentikasi koneksi.

  • ValidateCredentials – Boolean.

    Bendera untuk memvalidasi kredenSIAL selama membuat koneksi. Defaultnya benar.

  • ValidateForComputeEnvironments— Sebuah array UTF-8 string.

    Lingkungan komputasi yang divalidasi oleh properti koneksi yang ditentukan.

TestConnectionInput struktur

Struktur yang digunakan untuk menentukan pengujian koneksi ke layanan.

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

    Jenis koneksi yang akan diuji. Operasi ini hanya tersedia untuk jenis SALESFORCE koneksi JDBC atau.

  • ConnectionPropertiesWajib: Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 100 pasang.

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

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

    Pasangan kunci-nilai yang menentukan parameter untuk koneksi.

    Koneksi JDBC menggunakan properti koneksi berikut:

    • Diperlukan: Semua (HOST,PORT,JDBC_ENGINE) atauJDBC_CONNECTION_URL.

    • Diperlukan: Semua (USERNAME,PASSWORD) atauSECRET_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 menghar AuthenticationConfiguration uskan anggota dikonfigurasi.

  • AuthenticationConfiguration — Sebuah objek AuthenticationConfigurationInput.

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

PhysicalConnectionRequirements struktur

Aplikasi klien OAuth sebagai tanggapan GetConnection .

Bidang
  • SubnetId— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    ID subnet yang digunakan oleh koneksi.

  • SecurityGroupIdList— Sebuah array UTF-8 string, tidak lebih dari 50 string.

    Daftar ID grup keamanan yang digunakan oleh koneksi.

  • AvailabilityZone— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Availability Zone koneksi.

GetConnectionsFilter struktur

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

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

    Jenis koneksi yang akan dikembalikan. Saat ini, SFTP tidak didukung.

  • ConnectionSchemaVersion— Angka (integer), tidak kurang dari 1 atau lebih dari 2.

    Menunjukkan jika koneksi dibuat dengan skema versi 1 atau 2.

AuthenticationConfiguration struktur

Struktur yang berisi konfigurasi otentikasi.

Bidang
  • AuthenticationType— UTF-8 string (nilai valid: BASIC | OAUTH2 | CUSTOM |IAM).

    Struktur yang berisi konfigurasi otentikasi.

  • SecretArn— UTF-8 string, cocok denganCustom string pattern #32.

    Manajer rahasia ARN untuk menyimpan kredenSIAL.

  • KmsKeyArn— UTF-8 string, cocok denganCustom string pattern #39.

    Nama Sumber Daya Amazon (ARN) dari kunci KMS yang digunakan untuk mengenkripsi informasi otentikasi sensitif. Kunci ini digunakan untuk melindungi kredenSIAL dan data sensitif lainnya yang disimpan dalam konfigurasi otentikasi.

  • OAuth2Properties — Sebuah objek OAuth2Properties.

    Properti untuk otentikasi OAuth2.

AuthenticationConfigurationInput struktur

Struktur yang berisi konfigurasi otentikasi dalam CreateConnection permintaan.

Bidang
  • AuthenticationType— UTF-8 string (nilai valid: BASIC | OAUTH2 | CUSTOM |IAM).

    Struktur yang berisi konfigurasi otentikasi dalam CreateConnection permintaan.

  • OAuth2Properties — Sebuah objek OAuth2PropertiesInput.

    Properti untuk otentikasi OAuth2 dalam permintaan. CreateConnection

  • SecretArn— UTF-8 string, cocok denganCustom string pattern #32.

    Manajer rahasia ARN untuk menyimpan kredenSIAL dalam CreateConnection permintaan.

  • KmsKeyArn— UTF-8 string, cocok denganCustom string pattern #39.

    ARN dari kunci KMS digunakan untuk mengenkripsi koneksi. Hanya diambil sebagai masukan dalam permintaan dan disimpan di Manajer Rahasia.

  • BasicAuthenticationCredentials — Sebuah objek BasicAuthenticationCredentials.

    KredenSIAL yang digunakan ketika jenis otentikasi adalah otentikasi dasar.

  • CustomAuthenticationCredentials – Susunan peta pasangan nilai kunci.

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

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

    KredenSIAL yang digunakan saat jenis otentikasi adalah otentikasi kustom.

OAuth2Properties struktur

Struktur yang berisi properti untuk otentikasi OAuth2.

Bidang
  • OAuth2GrantType— UTF-8 string (nilai valid: AUTHORIZATION_CODE | CLIENT_CREDENTIALS |JWT_BEARER).

    Jenis hibah OAuth2. Sebagai contoh, AUTHORIZATION_CODE, JWT_BEARER, atau CLIENT_CREDENTIALS.

  • OAuth2ClientApplication — Sebuah objek OAuth2ClientApplication.

    Jenis aplikasi klien. Misalnya, AWS_MANAGED atau USER_MANAGED.

  • TokenUrl— UTF-8 string, panjangnya tidak lebih dari 256 byte, cocok denganCustom string pattern #37.

    URL server otentikasi penyedia, untuk menukar kode otorisasi dengan token akses.

  • TokenUrlParametersMap – Susunan peta pasangan nilai kunci.

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

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

    Peta parameter yang ditambahkan ke GET permintaan token.

OAuth2PropertiesInput struktur

Struktur yang berisi properti untuk OAuth2 dalam permintaan. CreateConnection

Bidang
  • OAuth2GrantType— UTF-8 string (nilai valid: AUTHORIZATION_CODE | CLIENT_CREDENTIALS |JWT_BEARER).

    Jenis hibah OAuth2 dalam permintaan. CreateConnection Sebagai contoh, AUTHORIZATION_CODE, JWT_BEARER, atau CLIENT_CREDENTIALS.

  • OAuth2ClientApplication — Sebuah objek OAuth2ClientApplication.

    Jenis aplikasi klien dalam CreateConnection permintaan. Misalnya, AWS_MANAGED atau USER_MANAGED.

  • TokenUrl— UTF-8 string, panjangnya tidak lebih dari 256 byte, cocok denganCustom string pattern #37.

    URL server otentikasi penyedia, untuk menukar kode otorisasi dengan token akses.

  • TokenUrlParametersMap – Susunan peta pasangan nilai kunci.

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

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

    Peta parameter yang ditambahkan ke GET permintaan token.

  • AuthorizationCodeProperties — Sebuah objek AuthorizationCodeProperties.

    Kumpulan properti yang diperlukan untuk jenis AUTHORIZATION_CODE hibah OAuth2.

  • OAuth2Credentials — Sebuah objek OAuth2Credentials.

    KredenSIAL yang digunakan saat jenis otentikasi adalah otentikasi OAuth2.

OAuth2ClientApplication struktur

Aplikasi klien OAuth2 digunakan untuk koneksi.

Bidang
  • UserManagedClientApplicationClientId— UTF-8 string, panjangnya tidak lebih dari 2048 byte, cocok denganCustom string pattern #33.

    Aplikasi klien clientID jika ada. ClientAppType USER_MANAGED

  • AWSManagedClientApplicationReference— UTF-8 string, panjangnya tidak lebih dari 2048 byte, cocok denganCustom string pattern #33.

    Referensi ke aplikasi SaaS-side klien yang AWS dikelola.

AuthorizationCodeProperties struktur

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

Bidang
  • AuthorizationCode— UTF-8 string, tidak kurang dari 1 atau lebih dari 4096 byte panjang, cocok dengan. Custom string pattern #33

    Kode otorisasi yang akan digunakan di leg 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— UTF-8 string, panjangnya tidak lebih dari 512 byte, cocok denganCustom string pattern #38.

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

BasicAuthenticationCredentials struktur

Untuk menyediakan kredenSIAL autentikasi dasar saat tidak memberikan SecretArn nilai.

Bidang
  • Username— UTF-8 string, panjangnya tidak lebih dari 512 byte, cocok denganCustom string pattern #33.

    Nama pengguna untuk terhubung ke sumber data.

  • Password— UTF-8 string, panjangnya tidak lebih dari 512 byte, cocok denganCustom string pattern #34.

    Kata sandi untuk terhubung ke sumber data.

OAuth2Credentials struktur

KredenSIAL yang digunakan saat jenis otentikasi adalah otentikasi OAuth2.

Bidang
  • UserManagedClientApplicationClientSecret— UTF-8 string, panjangnya tidak lebih dari 512 byte, cocok denganCustom string pattern #35.

    Rahasia klien aplikasi klien jika aplikasi klien dikelola pengguna.

  • AccessToken— UTF-8 string, panjangnya tidak lebih dari 4096 byte, cocok dengan. Custom string pattern #35

    Token akses yang digunakan saat jenis otentikasi adalah OAuth2.

  • RefreshToken— UTF-8 string, panjangnya tidak lebih dari 4096 byte, cocok dengan. Custom string pattern #35

    Token refresh yang digunakan saat jenis otentikasi adalah OAuth2.

  • JwtToken— UTF-8 string, panjangnya tidak lebih dari 8000 byte, cocok denganCustom string pattern #36.

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

Operasi

CreateConnection tindakan (Python: create_connection)

Menciptakan sebuah definisi koneksi baru dalam Katalog Data.

Koneksi yang digunakan untuk membuat sumber daya federasi memerlukan izin IAMglue:PassConnection.

Permintaan
  • CatalogId — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-line string pattern.

    ID Katalog Data tempat koneksi akan dibuat. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.

  • ConnectionInputWajib: Sebuah objek ConnectionInput.

    Sebuah objek ConnectionInput yang mendefinisikan koneksi yang akan dibuat.

  • Tags — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 50 pasang.

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

    Setiap nilai adalah UTF-8 string, panjangnya tidak lebih dari 256 byte.

    Tag yang Anda tetapkan ke koneksi.

Respons
  • CreateConnectionStatus— UTF-8 string (nilai valid: READY | IN_PROGRESS |FAILED).

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

Kesalahan
  • AlreadyExistsException

  • InvalidInputException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • GlueEncryptionException

DeleteConnection tindakan (Python: delete_connection)

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.

    ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.

  • ConnectionName- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Nama koneksi yang akan dihapus.

Respons
  • Tidak ada parameter Respons.

Kesalahan
  • EntityNotFoundException

  • OperationTimeoutException

GetConnection tindakan (Python: get_connection)

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.

    ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.

  • Name- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    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— UTF-8 string (nilai valid: SPARK | ATHENA |PYTHON).

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

Respons
  • Connection — Sebuah objek Koneksi.

    Definisi koneksi yang diminta.

Kesalahan
  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

GetConnections tindakan (Python: get_connection)

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.

    ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.

  • Filter — Sebuah objek 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— UTF-8 tali.

    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.

    Daftar definisi koneksi yang diminta.

  • NextToken— UTF-8 tali.

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

Kesalahan
  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

UpdateConnection tindakan (Python: update_connection)

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.

    ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.

  • Name- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Nama definisi koneksi yang akan diperbarui.

  • ConnectionInputWajib: Sebuah objek ConnectionInput.

    Sebuah objek ConnectionInput yang mengubah koneksi yang dimaksud.

Respons
  • Tidak ada parameter Respons.

Kesalahan
  • InvalidInputException

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

TestConnection tindakan (Python: test_connection)

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

Anda dapat memberikan nama koneksi yang ada atau TestConnectionInput untuk menguji input koneksi yang tidak ada. Menyediakan keduanya secara bersamaan akan menyebabkan kesalahan.

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Permintaan
  • ConnectionName— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    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.

    ID katalog tempat koneksi berada.

  • TestConnectionInput — Sebuah objek 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_delete_connection)

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.

    ID Katalog Data tempat koneksi berada. Jika tidak ada yang disediakan, ID AWS akun digunakan secara default.

  • ConnectionNameList- Diperlukan: Sebuah array UTF-8 string, tidak lebih dari 25 string.

    Daftar nama koneksi yang akan dihapus.

Respons
  • Succeeded— Sebuah array UTF-8 string.

    Daftar nama definisi koneksi yang sudah berhasil dihapus.

  • Errors – Susunan peta pasangan nilai kunci.

    Setiap kunci adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Setiap nilai adalah sebuah objek ErrorDetail.

    Peta nama koneksi yang tidak berhasil dihapus ke detail kesalahan.

Kesalahan
  • InternalServiceException

  • OperationTimeoutException