API Koneksi - AWS Glue
 —  tipe data  —KoneksiConnectionInputPhysicalConnectionPersyaratanGetConnectionsFilter —  operasi  —CreateConnection (create_connection)DeleteConnection (delete_connection)GetConnection (get_connection)GetConnections (get_connections)UpdateConnection (update_connection)BatchDeleteConnection (batch_delete_connection) - konfigurasi otentikasi -AuthenticationConfigurationAuthenticationConfigurationMasukanOAuth2propertiOAuth2 PropertiesInputOAuth2 ClientApplicationAuthorizationCodeProperti

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

API Koneksi

Connection API menjelaskan tipe 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 — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-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 – String UTF-8 (nilai yang valid: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE).

    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 | 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 | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | 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 |ROLE_ARN).

    Masing-masing kunci adalah sebuah string Nilai, dengan panjang tidak lebih dari 1024 byte.

    Pasangan nilai-kunci ini menentukan parameter untuk koneksi:

    • 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 - Sebuah string Boolean (BETUL, SALAH) yang menentukan apakah Lapisan Soket Aman (SSL) dengan pencocokan hostname ditegakkan 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, inifalse. AWS Glue memvalidasi algoritma Signature dan Subject Public Key Algorithm 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- 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: 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 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 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 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. Krb5.conf menyimpan informasi konfigurasi Kerberos, seperti lokasi server KDC. Untuk informasi lebih lanjut, lihat Dokumentasi MIT Kerberos: krb5.conf.

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

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

  • PhysicalConnectionRequirements — Sebuah objek PhysicalConnectionPersyaratan.

    Persyaratan koneksi fisik, seperti virtual private cloud (VPC) danSecurityGroup, 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.

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

  • Status – String UTF-8 (nilai yang valid: READY | IN_PROGRESS | FAILED).

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

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

    Properti otentikasi koneksi.

ConnectionInput struktur

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.

    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 valid: JDBC | SFTP | | MONGODB | KAFKA | NETWORK MARKETPLACE CUSTOM |SALESFORCE).

    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 di. KAFKA

      • 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 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 otentikasi SASL/GSSAPI dengan. KAFKA

    • MONGODB - Menunjuk koneksi ke database dokumen MongoDB.

      MONGODBKoneksi menggunakan yang berikut ini ConnectionParameters.

      • Diperlukan:CONNECTION_URL.

      • Diperlukan: Semua (USERNAME,PASSWORD) atauSECRET_ID.

    • SALESFORCE- Menentukan koneksi ke Salesforce menggunakan authencation OAuth.

      • Membutuhkan AuthenticationConfiguration anggota untuk dikonfigurasi.

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

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

      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.

    SFTP tidak didukung.

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

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

  • 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 | 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 | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | 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 |ROLE_ARN).

    Masing-masing kunci adalah sebuah string Nilai, dengan panjang tidak lebih dari 1024 byte.

    Pasangan nilai-kunci ini menentukan parameter untuk koneksi.

  • PhysicalConnectionRequirements — Sebuah objek PhysicalConnectionPersyaratan.

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

  • AuthenticationConfiguration — Sebuah objek AuthenticationConfigurationMasukan.

    Properti otentikasi koneksi. Digunakan untuk koneksi Salesforce.

  • ValidateCredentials – Boolean.

    Bendera untuk memvalidasi kredensyal selama membuat koneksi. Digunakan untuk koneksi Salesforce. Default benar.

PhysicalConnectionRequirements struktur

Aplikasi klien OAuth sebagai tanggapan GetConnection .

Bidang

  • SubnetId — String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-line string pattern.

    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.

    Availability Zone koneksi.

GetConnectionsFilter struktur

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 – String UTF-8 (nilai yang valid: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE).

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

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.

  • ConnectionInput — Wajib: Sebuah objek 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 | 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 — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-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 — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-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.

Respons

  • Connection — Sebuah objek Koneksi.

    Definisi koneksi yang diminta.

Kesalahan

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

GetConnections tindakan (Python: get_connections)

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

    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_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 — Wajib: String UTF-8, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-line string pattern.

    Nama definisi koneksi yang akan diperbarui.

  • ConnectionInput — Wajib: Sebuah objek ConnectionInput.

    Sebuah objek ConnectionInput yang mengubah koneksi yang dimaksud.

Respons

  • Tidak ada parameter Respons.

Kesalahan

  • InvalidInputException

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

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

    Setiap nilai adalah sebuah objek ErrorDetail.

    Peta nama koneksi yang tidak berhasil dihapus ke detail kesalahan.

Kesalahan

  • InternalServiceException

  • OperationTimeoutException

Konfigurasi otentikasi

AuthenticationConfiguration struktur

Struktur yang berisi konfigurasi otentikasi.

Bidang

  • AuthenticationType – String UTF-8 (nilai yang valid: BASIC | OAUTH2 | CUSTOM).

    Struktur yang berisi konfigurasi otentikasi.

  • SecretArn — String UTF-8, yang cocok dengan Custom string pattern #11.

    Manajer rahasia ARN untuk menyimpan kredensyal.

  • OAuth2Properties — Sebuah objek OAuth2properti.

    Properti untuk otentikasi OAuth2.

AuthenticationConfigurationInput struktur

Struktur yang berisi konfigurasi otentikasi dalam CreateConnection permintaan.

Bidang

  • AuthenticationType – String UTF-8 (nilai yang valid: BASIC | OAUTH2 | CUSTOM).

    Struktur yang berisi konfigurasi otentikasi dalam CreateConnection permintaan.

  • SecretArn — String UTF-8, yang cocok dengan Custom string pattern #11.

    Manajer rahasia ARN untuk menyimpan kredensyal dalam permintaan. CreateConnection

  • OAuth2Properties — Sebuah objek OAuth2 PropertiesInput.

    Properti untuk otentikasi OAuth2 dalam permintaan. CreateConnection

struktur OAuth2properties

Struktur yang berisi properti untuk otentikasi OAuth2.

Bidang

  • OAuth2GrantType – String UTF-8 (nilai yang valid: AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER).

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

  • OAuth2ClientApplication — Sebuah objek OAuth2 ClientApplication.

    Jenis aplikasi klien. Misalnya, AWS_MANAGED atau USER_MANAGED.

  • TokenUrl— String UTF-8, panjangnya tidak lebih dari 256 byte, cocok dengan file. Custom string pattern #12

    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.

Struktur OAuth2 PropertiesInput

Struktur yang berisi properti untuk OAuth2 dalam permintaan. CreateConnection

Bidang

  • OAuth2GrantType – String UTF-8 (nilai yang 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 OAuth2 ClientApplication.

    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 #12

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

    Kumpulan properti yang diperlukan untuk jenis AUTHORIZATION_CODE hibah OAuth2.

Struktur OAuth2 ClientApplication

Aplikasi klien OAuth2 yang digunakan untuk koneksi.

Bidang

  • UserManagedClientApplicationClientId — String UTF-8, sepanjang tidak lebih dari 2048, yang cocok dengan Custom string pattern #13.

    Aplikasi klien ClientID jika ada. ClientAppType USER_MANAGED

  • AWSManagedClientApplicationReference — String UTF-8, sepanjang tidak lebih dari 2048, yang cocok dengan Custom string pattern #13.

    Referensi ke aplikasi klien sisi SaaS yang dikelola AWS .

AuthorizationCodeProperties struktur

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

Bidang

  • AuthorizationCode— String UTF-8, panjangnya tidak kurang dari 1 atau lebih dari 4096 byte, cocok dengan file. Custom string pattern #13

    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 #14

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