Konektor aksi APIs - Amazon Cepat
Apa itu konektor aksi APIs?Metode otentikasiIzin dan kontrol aksesKategori konektor yang didukungManajemen siklus hidup APIPembatasan tarif dan kuotaDukungan lintas akunPenanganan kesalahan dan pemecahan masalahMenggunakan Konektor Aksi APIs dengan AWS CLILangkah selanjutnya

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

Konektor aksi APIs

Konektor tindakan APIs memungkinkan Anda membuat dan mengelola koneksi antara Amazon Quick dan layanan eksternal secara terprogram. Ini APIs mendukung fungsionalitas integrasi tindakan yang memungkinkan pengguna untuk melakukan tindakan dalam aplikasi pihak ketiga langsung dari antarmuka obrolan Cepat Amazon dan alur kerja otomatis.

Apa itu konektor aksi APIs?

Konektor aksi berfungsi sebagai sumber daya dasar yang memungkinkan integrasi dengan aplikasi pihak pertama dan ketiga. Melalui ini APIs, Anda dapat mengautentikasi ke aplikasi, mengelola izin, dan mengontrol tindakan mana yang tersedia bagi pengguna dalam aplikasi Amazon Quick Anda.

Bagaimana konektor aksi APIs mendukung integrasi tindakan

Konektor aksi APIs menyediakan infrastruktur backend untuk integrasi tindakan Cepat Amazon. Saat membuat konektor tindakan melalui API, Anda membuat koneksi aman yang memungkinkan Anda:

  • Jalankan tindakan di layanan eksternal melalui antarmuka obrolan.

  • Lakukan alur kerja otomatis dalam proses latar belakang.

  • Integrasikan layanan pihak ketiga dengan aplikasi Amazon Quick.

  • Kelola otentikasi dan izin untuk akses layanan.

APIs Menangani alur otentikasi kompleks, manajemen kredensi, dan kontrol izin yang diperlukan untuk menghubungkan Amazon Quick secara aman dengan layanan eksternal.

Metode otentikasi

Konektor aksi APIs mendukung beberapa metode otentikasi untuk mengakomodasi berbagai kasus penggunaan dan persyaratan keamanan:

Otentikasi terkelola (3LO)

Three-Legged OAuth menyediakan pengaturan paling sederhana untuk akses pribadi ke layanan pihak ketiga:

  • Tidak diperlukan konfigurasi awal.

  • Otentikasi khusus pengguna melalui login penyedia layanan.

  • Penyegaran token otomatis dengan siklus hidup 90 hari.

  • Penyimpanan kredensi aman yang dikelola oleh Amazon Quick.

Service-to-service otentikasi (2LO)

Untuk integrasi perusahaan yang kompleks:

  • Mendukung aliran OAuth kredensi klien.

  • Memungkinkan system-to-system interaksi.

  • Memerlukan ID klien, rahasia klien, dan konfigurasi URL token.

  • Cocokkan untuk alur kerja otomatis yang membutuhkan keamanan canggih.

  • OAuth - Pendaftaran Klien Dinamis (DCR - hanya berlaku untuk server MCP tertentu).

Otentikasi kunci API

Otentikasi yang disederhanakan untuk alur kerja otomatis:

  • Otentikasi berbasis token tunggal.

  • Izin tingkat layanan.

  • Ideal untuk proses latar belakang dan tindakan terjadwal.

  • Memerlukan kunci API yang valid dari layanan target.

Auth Dasar

Otentikasi dasar menyediakan metode username/password otentikasi sederhana:

  • Menggunakan header HTTP Basic Authentication standar.

  • Kredensialnya dikodekan base64.

  • Cocokkan untuk layanan yang tidak mendukung OAuth atau kunci API.

  • Membutuhkan koneksi HTTPS yang aman.

  • Tidak direkomendasikan untuk layanan publik.

Tidak ada

Tidak diperlukan otentikasi:

  • Digunakan untuk publik APIs dan layanan.

  • Tidak diperlukan kredensi atau token.

  • Terbatas untuk operasi baca-saja atau publik.

  • Biasanya digunakan untuk umpan data publik dan dokumentasi.

  • Seharusnya tidak digunakan untuk operasi sensitif.

Izin dan kontrol akses

Konektor tindakan APIs menerapkan kontrol izin komprehensif melalui Daftar Kontrol Akses (ACLs):

Izin tingkat sumber daya

  • Pemilik - Kontrol penuh termasuk penghapusan dan manajemen izin.

  • Kontributor - Dapat menggunakan dan memodifikasi pengaturan konektor.

  • Penampil - Dapat melihat detail konektor dan menggunakan tindakan yang diaktifkan.

Operasi API untuk manajemen izin

  • DescribeActionConnectorPermissions- Ambil pengaturan izin saat ini.

  • UpdateActionConnectorPermissions- Memberikan atau mencabut izin pengguna.

Kategori konektor yang didukung

Konektor tujuan ganda

Konektor ini mendukung integrasi tindakan dan pembuatan basis pengetahuan:

  • Amazon S3 - Gunakan Konsol Admin untuk membuat Tindakan untuk operasi file, gunakan webapp untuk membuat basis pengetahuan dari konten S3.

  • Microsoft SharePoint - Tindakan manajemen dokumen, pengindeksan konten.

  • OneDrive- Operasi file, kemampuan pencarian dokumen.

  • Confluence - Tindakan pembuatan konten, integrasi basis pengetahuan.

Konektor khusus aksi

Khusus untuk eksekusi tindakan tanpa kemampuan basis pengetahuan:

  • Salesforce - Integrasi CRM perusahaan yang mendukung operasi akun dan kontak, operasi CRUD objek khusus, otomatisasi proses penjualan.

  • JIRA - Pelacakan masalah dan manajemen proyek.

  • Microsoft Outlook - Kirim email, kelola acara kalender, akses kontak.

  • Slack - Alur kerja komunikasi dan pemberitahuan.

  • ServiceNow- Operasi manajemen layanan TI.

  • Zendesk - Buat tiket, perbarui kasus, cari basis pengetahuan.

  • PagerDuty- Buat insiden, kelola eskalasi, perbarui jadwal panggilan.

  • Asana - Buat tindakan, perbarui proyek, kelola alur kerja tim.

  • BambooHR - Akses data karyawan, kelola permintaan waktu istirahat.

  • Smartsheet - Perbarui lembar, kelola data proyek.

  • FactSet- Akses data keuangan, buat laporan.

  • SAP - Akses sistem SAP, jalankan fungsi bisnis, dan kelola data perusahaan.

Konektor khusus basis pengetahuan

Berfokus pada integrasi basis pengetahuan tanpa kemampuan tindakan:

  • Google Drive - Pengindeksan dan pencarian dokumen.

  • Web Crawler - Penemuan dan pengindeksan konten.

Manajemen siklus hidup API

Manajemen kredensial

  • Penanganan token refresh otomatis untuk konektor OAuth aksi.

  • Penyimpanan aman kredensil otentikasi menggunakan. AWS KMS

  • Support untuk rotasi kredenal dan pembaruan.

  • Akses lintas akun untuk konektor Amazon S3.

Pembaruan koneksi

Gunakan UpdateActionConnector API untuk:

  • Memodifikasi kredensi otentikasi.

  • Perbarui parameter konfigurasi layanan.

  • Ubah metadata konektor tindakan.

Pemantauan dan pemecahan masalah

  • Lacak penggunaan API melalui CloudWatch metrik.

  • Pantau kesehatan koneksi dan status otentikasi.

  • Menerapkan penanganan kesalahan untuk skenario kegagalan umum.

  • Gunakan validasi APIs untuk mendiagnosis masalah konfigurasi.

Pembatasan tarif dan kuota

Konektor aksi APIs menerapkan pembatasan laju AWS API standar:

  • Pelambatan AWS API standar berlaku untuk semua operasi.

  • Validasi koneksi mungkin memiliki batasan tambahan.

  • Tingkat eksekusi tindakan tergantung pada kemampuan layanan target.

  • Terapkan backoff eksponensial untuk logika coba lagi.

Dukungan lintas akun

Untuk konektor Amazon S3, APIs dukungan akses lintas akun:

  • Tentukan AWS akun yang berbeda IDs selama pembuatan konektor.

  • Konfigurasikan izin IAM yang sesuai untuk akses lintas akun.

  • Gunakan AWS KMS untuk manajemen kredensi yang aman di seluruh akun.

  • Validasi izin sebelum mengaktifkan koneksi lintas akun.

Penanganan kesalahan dan pemecahan masalah

Konektor aksi APIs mengembalikan respons AWS kesalahan standar:

Jenis kesalahan umum

  • AccessDeniedException- Izin tidak memadai untuk operasi.

  • InvalidParameterValueException- Satu atau lebih nilai parameter tidak valid untuk operasi.

  • Parameter konfigurasi tidak valid - Nilai konfigurasi khusus layanan salah atau hilang.

  • ResourceNotFoundException- Konektor atau sumber daya tidak ditemukan.

  • ThrottlingException- Batas tarif terlampaui.

  • ConflictException- Konflik sumber daya atau nama duplikat.

  • InternalFailureException- Kesalahan layanan internal terjadi selama pemrosesan permintaan.

  • ResourceExistsException- Mencoba membuat sumber daya yang sudah ada.

  • InvalidNextTokenException- Token pagination yang diberikan tidak valid atau kedaluwarsa.

  • AccessTokenNotFoundException- Pengguna perlu mengotorisasi koneksi (yaitu, tombol masuk). Pengecualian ini digunakan oleh UX untuk meminta otorisasi pengguna.

  • TokenResponseException- Pengaturan tindakan tidak valid.

Terapkan penanganan kesalahan yang tepat dalam aplikasi Anda untuk mengelola skenario ini dengan anggun dan memberikan umpan balik yang berarti kepada pengguna.

Menggunakan Konektor Aksi APIs dengan AWS CLI

Anda dapat menggunakan AWS CLI untuk mengelola konektor tindakan secara terprogram. Contoh berikut menunjukkan operasi umum menggunakan nilai placeholder generik.

Membuat konektor tindakan

Gunakan create-action-connector perintah untuk membuat konektor tindakan baru untuk diintegrasikan dengan layanan eksternal.


aws quicksight create-action-connector \
  --aws-account-id "123456789012" \
  --name "MyS3Connector" \
  --action-connector-id "my-s3-connector-id" \
  --type "AMAZON_S3" \
  --authentication-config '{
    "AuthenticationType": "IAM",
    "AuthenticationMetadata": {
      "IamConnectionMetadata": {
        "RoleArn": "arn:aws:iam::123456789012:role/MyConnectorRole"
      }
    }
  }' \
  --enabled-actions "CreateBucket" "ListBuckets" \
  --description "S3 connector for automation workflows" \
  --region "us-east-1"

Daftar konektor tindakan

Gunakan list-action-connectors perintah untuk mengambil semua konektor tindakan di akun Anda.


aws quicksight list-action-connectors \
  --aws-account-id "123456789012" \
  --max-results 10 \
  --region "us-east-1"

Menjelaskan konektor tindakan

Gunakan describe-action-connector perintah untuk mendapatkan informasi rinci tentang konektor tindakan tertentu.


aws quicksight describe-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"

Memperbarui konektor tindakan

Gunakan update-action-connector perintah untuk memodifikasi konfigurasi konektor tindakan yang ada.


aws quicksight update-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --name "UpdatedS3Connector" \
  --authentication-config '{
    "AuthenticationType": "IAM",
    "AuthenticationMetadata": {
      "IamConnectionMetadata": {
        "RoleArn": "arn:aws:iam::123456789012:role/UpdatedConnectorRole"
      }
    }
  }' \
  --enabled-actions "CreateBucket" "ListBuckets" "DeleteBucket" \
  --region "us-east-1"

Mencari konektor tindakan

Gunakan search-action-connectors perintah untuk menemukan konektor tindakan berdasarkan kriteria tertentu.


aws quicksight search-action-connectors \
  --aws-account-id "123456789012" \
  --max-results 5 \
  --filters '[{
    "Name": "ACTION_CONNECTOR_NAME",
    "Operator": "StringLike",
    "Value": "S3"
  }]' \
  --region "us-east-1"

Mengelola izin konektor tindakan

Gunakan update-action-connector-permissions perintah untuk memberikan atau mencabut izin untuk konektor tindakan.


aws quicksight update-action-connector-permissions \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --grant-permissions '[{
    "Actions": [
      "quicksight:DescribeActionConnector",
      "quicksight:UpdateActionConnector",
      "quicksight:DeleteActionConnector"
    ],
    "Principal": "arn:aws:quicksight:us-east-1:123456789012:user/default/myuser"
  }]' \
  --region "us-east-1"

Melihat izin konektor tindakan

Gunakan describe-action-connector-permissions perintah untuk melihat izin saat ini untuk konektor tindakan.


aws quicksight describe-action-connector-permissions \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"

Menghapus konektor tindakan

Gunakan delete-action-connector perintah untuk menghapus konektor tindakan dari akun Anda.


aws quicksight delete-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"

Langkah selanjutnya

Setelah memahami konektor tindakan APIs, Anda dapat:

  • Tinjau dokumentasi referensi API lengkap untuk spesifikasi parameter terperinci.

  • Jelajahi panduan pengaturan konektor khusus untuk layanan target Anda.

  • Terapkan alur otentikasi yang sesuai untuk kasus penggunaan Anda.

  • Siapkan pemantauan dan penanganan kesalahan untuk penerapan produksi.

  • Konfigurasikan izin dan kontrol akses untuk organisasi Anda.