Prasyarat Menyebarkan otomatisasi Menyiapkan pemicu Jalankan otomatisasi dengan pemicu API menggunakan input dan output Menyebarkan dan menjalankan otomatisasi dengan input dan output

Menyebarkan otomatisasi

Setelah Anda membuat dan menguji otomatisasi Anda di Amazon Quick Automate, langkah selanjutnya adalah menerapkannya sehingga dapat berjalan secara teratur pada pemicu. Deployment membuat otomatisasi operasional dan siap untuk eksekusi. Anda dapat menambahkan pemicu ke otomatisasi yang diterapkan untuk menjalankannya pada jadwal yang telah ditentukan. Deployment melibatkan konfigurasi pengaturan runtime, menetapkan pengguna untuk tugas-tugas manusia-in-the-loop, memverifikasi kredensi dan integrasi.

Bagian ini menjelaskan setiap langkah proses penerapan dan cara mengonfigurasi otomatisasi Anda untuk keandalan, keamanan, dan kinerja optimal.

Prasyarat

Sebelum menerapkan otomatisasi Anda, pastikan bahwa langkah-langkah berikut telah selesai:

Otomatisasi diuji secara menyeluruh - Validasi otomatisasi Anda melalui pengujian ujung ke ujung untuk mengonfirmasi bahwa semua logika, tindakan, dan interaksi agen berfungsi seperti yang diharapkan.
Versi yang berkomitmen untuk penerapan - Hanya versi otomatisasi yang berkomitmen yang dapat digunakan. Tinjau perubahan Anda, selesaikan versi, dan komit sebelum melanjutkan.
Integrasi dikonfigurasi - Jika otomatisasi Anda berinteraksi dengan aplikasi eksternal seperti Salesforce atau Jira melalui API, pastikan semua integrasi yang diperlukan dikonfigurasi.
- Arahkan ke Koneksi → Integrasi di panel kiri untuk membuat integrasi baru.
- Saat ini, hanya integrasi yang tersedia di bawah tab Tindakan yang didukung di Amazon Quick Automate.
- Setelah tindakan integrasi dibuat, kaitkan dengan Grup Otomasi di mana ia akan digunakan.
- Tindakan terkait kemudian akan muncul di kanvas. Selama penyebaran, Anda dapat memilih koneksi yang sesuai untuk digunakan oleh otomatisasi yang diterapkan.
Kredenal dikonfigurasi - Verifikasi bahwa semua kredensional yang diperlukan oleh otomatisasi Anda telah diatur dengan benar.

Menyebarkan otomatisasi

Anda dapat menerapkan otomatisasi langsung dari Canvas dengan mengklik Deploy, atau dengan menavigasi ke tab Deployment di halaman landing otomatisasi. Setelah Anda memulai penerapan, sistem memandu Anda melalui serangkaian langkah untuk menyelesaikan proses konfigurasi dan rilis.

Detail rilis

Pada halaman Detail Rilis, pilih versi otomatisasi yang ingin Anda terapkan. Hanya versi komit yang tersedia untuk penerapan dan akan muncul di daftar dropdown.

Pengaturan tambahan

Pengaturan tambahan meliputi:

Konfigurasi runtime
Tugas (untuk tugas HITL)
Akses

Konfigurasi runtime

Konfigurasi runtime adalah parameter yang mungkin berbeda antara lingkungan seperti pengembangan, pengujian, dan produksi.

Misalnya, langkah otomatisasi yang mengirim email dapat menggunakan alamat email pribadi Anda selama pengujian tetapi harus beralih ke alamat tim bersama dalam produksi. Nilai yang bergantung pada lingkungan tersebut dapat didefinisikan sebagai konfigurasi runtime saat membuat otomatisasi.

Pada waktu penerapan, Anda dapat meninjau dan mengganti konfigurasi ini untuk memastikan otomatisasi berjalan dengan benar di lingkungan yang dimaksud. Parameter runtime dapat mencakup:

Alamat email atau penerima notifikasi
Jalur file atau URL khusus untuk lingkungan

Fleksibilitas ini membantu mempertahankan definisi otomatisasi tunggal di seluruh lingkungan sambil mengadaptasi parameter kunci sesuai kebutuhan.

Tugas

Pilih pengguna resolver atau grup pengguna untuk setiap tugas yang memerlukan manusia-in-the-loop.

Akses (Kredensyal dan Koneksi)

Otomatisasi sering perlu terhubung ke sistem eksternal, database, atau layanan. Amazon Quick Automate menyediakan metode aman untuk mengelola kredensil dan koneksi tanpa menyematkan informasi sensitif dalam logika otomatisasi Anda.

Data koneksi dan kredensi disimpan dan dienkripsi dengan aman, dan tersedia untuk alur kerja saat runtime tanpa memaparkannya ke penulis atau pengguna akhir. Desain ini memastikan pemisahan rahasia yang kuat dari definisi otomatisasi, meningkatkan keamanan dan pemeliharaan.

Anda dapat menyimpan dan menggunakan dua jenis kredensi utama:

Kredensi situs web - Digunakan untuk langkah-langkah otomatisasi UI yang memerlukan login situs web (nama pengguna dan kata sandi).
Kredensial tindakan (Integrasi) - Digunakan untuk menghubungkan AWS layanan (misalnya S3) atau sistem eksternal melalui integrasi yang dikonfigurasi (misalnya, Salesforce, Jira).

Saat penerapan, pastikan bahwa kredensil dan koneksi yang benar dipilih sehingga otomatisasi dapat mengakses semua sistem yang diperlukan dengan aman dan berhasil.

Menyiapkan pemicu

Pemicu menentukan kapan dan bagaimana otomatisasi Anda berjalan. Anda dapat mengonfigurasi otomatisasi untuk memulai berdasarkan jadwal yang telah ditentukan atau memanggilnya secara terprogram melalui Amazon API. QuickSight

Jadwal

Anda dapat mengonfigurasi otomatisasi untuk memulai berdasarkan jadwal yang telah ditentukan. Untuk mengatur pemicu:

Pada halaman Deployment, klik “Create Trigger” dan konfigurasikan aturan.
Pilih frekuensinya
Pilih tanggal dan waktu mulai (Perhatikan bahwa eksekusi aktual akan dimulai dalam waktu 15 menit dari waktu mulai yang dipilih)
Pilih tanggal dan waktu berakhir
Pilih zona waktu
Amazon Quick Automate menyediakan skalabilitas bawaan. Pilih jumlah eksekusi paralel otomatisasi (Anda dapat memilih maksimum 10 eksekusi paralel per pemicu dan 50 di semua otomatisasi dalam akun. Silakan hubungi AWS)
Untuk kebutuhan penjadwalan yang kompleks, Anda dapat menggunakan ekspresi cron untuk menentukan pola berjalan yang tepat. Misalnya, untuk menjalankan otomatisasi pada pukul 02:30 setiap hari Senin, Rabu, dan Jumat, Anda akan menggunakan ekspresi cron:. 30 2 * * 1,3,5

Pemicu API

Automation Job API memungkinkan Anda memulai dan memantau pekerjaan otomatisasi secara terprogram dari aplikasi eksternal. Anda dapat menggunakan API ini untuk menjalankan otomatisasi yang diterapkan dengan muatan input khusus dan mengambil hasil eksekusi melalui SDK dan. AWS AWS CLI

Automation Job API mencakup dua operasi:

StartAutomationJob— Memulai pekerjaan baru untuk otomatisasi yang diterapkan dengan muatan input opsional.
DescribeAutomationJob— Mengambil status, stempel waktu, dan muatan input dan output opsional untuk pekerjaan tertentu.

API ini adalah bagian dari namespace QuickSight layanan Amazon. Anda mengaksesnya melalui quicksight namespace di AWS SDK dan. AWS CLI

Untuk informasi selengkapnya tentang AWS SDK dan toolkit, lihat Pusat Sumber Daya AWS Memulai.

Prasyarat

Sebelum Anda memanggil Automation Job API, selesaikan langkah-langkah penyiapan berikut.

Temukan pengidentifikasi otomatisasi Anda

Untuk memanggil Automation Job API, Anda memerlukan pengidentifikasi berikut:

AWS ID akun — ID AWS akun 12 digit Anda.
ID grup otomatisasi — ID unik grup otomatisasi yang berisi otomatisasi Anda.
ID Otomasi — ID unik dari otomatisasi yang ingin Anda panggil.

Anda dapat menemukan ID grup otomatisasi dan ID otomatisasi di bagian Deployment saat Anda membuka otomatisasi apa pun dan memiliki versi yang diterapkan.

Untuk menemukan pengenal Anda

Masuk ke Amazon Quick Automate.
Di panel navigasi kiri, pilih Otomasi.
Pilih grup otomatisasi yang berisi otomatisasi Anda.
Pilih nama otomatisasi untuk membuka editor otomatisasi.
Pilih tab Deployment.
Pilih Actions () dan View deployment details untuk mendapatkan Automation ID dan Group ID di bagian atas tepat di bawah judul Deployment Details.

Mengonfigurasi izin IAM

Automation Job API memerlukan izin IAM yang dilampirkan ke identitas IAM Anda (pengguna, peran, atau grup). Setiap operasi memerlukan izin terpisah.

Izin untuk StartAutomationJob

Lampirkan kebijakan yang memberikan quicksight:StartAutomationJob tindakan. Cakupan ARN sumber daya ke otomatisasi spesifik yang ingin Anda izinkan.


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AllowStartAutomationJob",
            "Effect": "Allow",
            "Action": [
                "quicksight:StartAutomationJob"
            ],
            "Resource": [
                "arn:aws:quicksight:us-west-2:111122223333:automation-group/EXAMPLE-GROUP-ID/automation/EXAMPLE-AUTOMATION-ID"
            ]
        }
    ]
}

Izin untuk DescribeAutomationJob

Lampirkan kebijakan yang memberikan quicksight:DescribeAutomationJob tindakan. ARN sumber daya untuk operasi ini mencakup segmen ID pekerjaan. Untuk memungkinkan mendeskripsikan pekerjaan apa pun di bawah otomatisasi, gunakan wildcard (*) untuk segmen pekerjaan.


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AllowDescribeAutomationJob",
            "Effect": "Allow",
            "Action": [
                "quicksight:DescribeAutomationJob"
            ],
            "Resource": [
                "arn:aws:quicksight:us-west-2:111122223333:automation-group/EXAMPLE-GROUP-ID/automation/EXAMPLE-AUTOMATION-ID"
            ]
        }
    ]
}

AWS merekomendasikan pelingkupan setiap izin ke sumber daya yang paling spesifik ARN mungkin untuk mengikuti prinsip hak istimewa paling sedikit. Untuk informasi selengkapnya, lihat berikut ini:

Terapkan otomatisasi Anda

StartAutomationJob API hanya menargetkan otomatisasi yang diterapkan. Anda harus melakukan dan menerapkan otomatisasi Anda di konsol Amazon Quick Automate sebelum Anda dapat memanggilnya melalui API.

StartAutomationJob

Memulai pekerjaan baru untuk otomatisasi yang diterapkan. Operasi ini asinkron — Amazon Quick Automate menerima permintaan, mengantri pekerjaan, dan segera mengembalikan. JobId Otomatisasi berjalan di latar belakang. Jika otomatisasi memiliki skema input yang ditentukan, Amazon Quick Automate memvalidasi InputPayloadterhadap skema sebelum menerima pekerjaan. Muatan yang tidak valid menghasilkan file. InvalidParameterValueException

Sintaksis Permintaan


POST /accounts/AwsAccountId/automation-groups/AutomationGroupId/automations/AutomationId/jobs HTTP/1.1
Content-type: application/json

{
    "InputPayload": "string"
}

Permintaan parameter

AwsAccountId(String, wajib) - ID AWS akun Anda (12 digit).
AutomationGroupId(String, wajib) — ID grup otomatisasi (UUID).
AutomationId(String, diperlukan) - ID otomatisasi untuk dijalankan (UUID).
InputPayload(String, opsional) - Masukan untuk pekerjaan sebagai string JSON.

Elemen jawaban

Arn (String) — ARN dari pekerjaan otomatisasi.
JobId(String) — ID dari pekerjaan yang dimulai. Gunakan ini DescribeAutomationJob untuk melacak status.
Status (Integer) - kode status HTTP dari respons.
RequestId(String) — AWS permintaan ID.

Kesalahan

AccessDeniedException— Izin tidak memadai atau kredensi yang tidak valid.
InvalidParameterValueException— Satu atau lebih parameter memiliki nilai yang tidak valid.
ResourceNotFoundException— Grup otomatisasi atau otomatisasi tidak ditemukan.
LimitExceededException— Batas terlampaui.
ThrottlingException— Permintaan dibatasi.
InternalFailureException— Kesalahan layanan internal.

Untuk detail selengkapnya, lihat panduan referensi API untuk StartAutomationJob.

DescribeAutomationJob

Mengambil status dan detail pekerjaan otomatisasi tertentu, termasuk stempel waktu eksekusi dan muatan input dan output opsional. Gunakan operasi ini untuk melakukan polling untuk penyelesaian pekerjaan setelah menelepon StartAutomationJob.

Respons tidak termasuk muatan input dan output secara default. Atur parameter IncludeInputPayloaddan IncludeOutputPayloadkueri true untuk memintanya. Amazon Quick Automate mengembalikan payload output hanya jika semua kondisi berikut terpenuhi:

IncludeOutputPayload adalah true.
JobStatus adalah SUCCEEDED.
Otomatisasi menghasilkan nilai output.

Sintaksis Permintaan


GET /accounts/AwsAccountId/automation-groups/AutomationGroupId/automations/AutomationId/jobs/JobId?IncludeInputPayload=boolean&IncludeOutputPayload=boolean HTTP/1.1

Permintaan parameter

AwsAccountId(String, wajib) - ID AWS akun Anda (12 digit).
AutomationGroupId(String, wajib) — ID grup otomatisasi (UUID).
AutomationId(String, wajib) — ID otomatisasi (UUID).
JobId(String, required) - ID pekerjaan yang dikembalikan oleh StartAutomationJob (UUID).
IncludeInputPayload(Boolean, opsional) - Sertakan muatan input dalam respons. Default: false.
IncludeOutputPayload(Boolean, opsional) - Sertakan payload output dalam respons. Default: false.

Bidang respons

Arn (String) — ARN dari pekerjaan otomatisasi.
CreatedAt(Timestamp) — Saat pekerjaan dibuat (epoch seconds).
StartedAt(Timestamp) — Saat pekerjaan mulai berjalan (epoch seconds).
EndedAt(Timestamp) — Saat pekerjaan selesai (epoch seconds).
JobStatus(String) —QUEUED,RUNNING,SUCCEEDED,FAILED, atauSTOPPED.
InputPayload(String) — Muatan masukan. Dihilangkan dari respon kecuali adaIncludeInputPayload. true
OutputPayload(String) — Muatan keluaran. Dihilangkan dari respon kecuali adaIncludeOutputPayload. true
RequestId(String) — AWS permintaan ID.

Kesalahan

AccessDeniedException— Izin tidak memadai atau kredensi yang tidak valid.
InvalidParameterValueException— Satu atau lebih parameter memiliki nilai yang tidak valid.
ResourceNotFoundException— Grup pekerjaan, otomatisasi, atau otomatisasi tidak ditemukan.
ThrottlingException— Permintaan dibatasi.
InternalFailureException— Kesalahan layanan internal.

Untuk detail selengkapnya, lihat panduan referensi API untuk DescribeAutomationJob.

Jalankan otomatisasi dengan pemicu API menggunakan input dan output

Anda dapat menyertakan nilai input sebagai payload JSON saat memulai pekerjaan otomatisasi melalui API. Amazon Quick Automate memvalidasi payload terhadap skema input otomatisasi sebelum eksekusi dimulai, dan mengembalikan nilai keluaran terstruktur saat pekerjaan selesai.

Prasyarat

Sebelum Anda menjalankan otomatisasi dengan pemicu API, pastikan hal-hal berikut sudah ada:

Otomatisasi dikerahkan.
Otomatisasi memiliki skema input yang didefinisikan dalam simpul Mulai.
Anda memiliki ID grup otomatisasi dan ID otomatisasi.

Mengirim nilai input melalui API

Untuk menyertakan nilai input, berikan payload JSON dalam StartAutomationJobpermintaan menggunakan parameter. InputPayload


Sample Request

POST /accounts/123456789012/automation-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automations/11111111-2222-3333-4444-555555555555/jobs
{
    "InputPayload": "{\"customer_id\":\"C-98765\",\"threshold\":100,\"region\":\"us-east-1\"}"
}

Sample Response

{
    "Arn": "arn:aws:quicksight:us-west-2:123456789012:automation-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automation/11111111-2222-3333-4444-555555555555/job/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "JobId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "Status": 200,
    "RequestId": "req-12345678-abcd-efgh-ijkl-123456789012"
}

catatan

InputPayloadNilai harus berupa JSON-serialized string yang berisi nilai bidang input yang cocok dengan skema masukan otomatisasi Anda.

Mengambil nilai output melalui API

Anda dapat mengambil nilai output dengan memanggil DescribeAutomationJobAPI. Untuk menyertakan muatan input dan output dalam respons, setel parameter OutputPayload kueri sertakan InputPayload dan sertakan ketrue.

Respons mencakup OutputPayloadbidang hanya ketika otomatisasi selesai dengan sukses.


Sample Request

GET /accounts/123456789012/automation-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automations/11111111-2222-3333-4444-555555555555/jobs/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee?includeInputPayload=true&includeOutputPayload=true

Sample Response

{
    "Arn": "arn:aws:quicksight:us-west-2:123456789012:automation-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automation/11111111-2222-3333-4444-555555555555/job/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "JobStatus": "SUCCEEDED",
    "CreatedAt": "2026-03-11T09:59:50Z",
    "StartedAt": "2026-03-11T10:00:00Z",
    "EndedAt": "2026-03-11T10:05:00Z",
    "InputPayload": "{\"customer_id\":\"C-98765\",\"threshold\":100,\"region\":\"us-east-1\"}",
    "OutputPayload": "{\"result\":\"success\",\"records_processed\":42,\"summary\":{\"passed\":40,\"failed\":2}}",
    "RequestId": "req-12345678-abcd-efgh-ijkl-123456789012"
}

catatan

OutputPayloadBidang hanya tersedia setelah otomatisasi selesai dengan sukses (kapan JobStatusSUCCEEDED). Jika otomatisasi gagal atau masih berjalan, respons tidak termasuk OutputPayloadbidang.

Menyebarkan dan menjalankan otomatisasi dengan input dan output

Bagian ini menjelaskan cara menerapkan otomatisasi yang menggunakan skema input dan output, menjalankannya secara manual atau sesuai jadwal, dan melihat hasil yang dijalankan.

Lihat informasi skema sebelum penerapan

Sebelum menerapkan otomatisasi, Anda harus berkomitmen untuk membuat versi. Untuk informasi selengkapnya, lihat mempertahankan versi otomatisasi.

Setelah Anda melakukan otomatisasi dengan skema input atau output, Anda dapat melihat detail skema di bagian Model data pada halaman detail versi. Bagian ini menampilkan definisi bidang lengkap untuk input dan output.

Menyebarkan otomatisasi dengan skema input dan output

Saat Anda menerapkan otomatisasi yang memiliki skema input atau output yang ditentukan, kotak dialog penerapan menampilkan informasi skema di bagian Model data, termasuk:

Definisi bidang input dan output (nama, tipe data, deskripsi, status wajib atau opsional, dan nilai default).
Skema JSON yang dapat disalin untuk input dan output yang dapat digunakan pemanggil API untuk integrasi.

penting

Skema dibekukan pada waktu penerapan bersama dengan kode otomatisasi. Jika Anda memperbarui skema setelah penerapan, Anda harus menerapkan ulang otomatisasi agar perubahan diterapkan.

Untuk menyelesaikan penerapan, tinjau informasi skema dan pilih Deploy.

Jalankan otomatisasi yang diterapkan secara manual

Untuk memulai otomatisasi yang diterapkan dengan input, selesaikan langkah-langkah berikut:

Pada halaman deployment, pilih menu Actions ().
Pilih Jalankan sekarang.
Dalam kotak dialog Berikan nilai masukan, masukkan nilai untuk setiap bidang input.
Pilih Mulai untuk memulai proses otomatisasi.

Formulir input identik dengan yang Anda gunakan saat Anda menguji di Studio.

Jalankan otomatisasi dengan pemicu terjadwal

Untuk pemicu terjadwal, Anda memberikan nilai masukan saat membuat atau mengedit pemicu. Nilai yang disimpan diteruskan ke otomatisasi setiap kali pemicu menyala.

Anda dapat melakukan tindakan berikut:

Buat beberapa pemicu dengan nilai input berbeda untuk otomatisasi yang sama
Edit nilai input untuk pemicu tanpa menerapkan ulang otomatisasi

Untuk mengonfigurasi input untuk pemicu terjadwal, selesaikan langkah-langkah berikut:

Arahkan ke halaman penerapan untuk otomatisasi Anda.
Pilih Buat Pemicu.
Pada Langkah 1: Atur Pemicu, konfigurasikan jadwal.
Pada Langkah 2: Tentukan Jalankan, masukkan nilai untuk setiap bidang input dalam formulir yang dibuat secara otomatis.
Pilih Berikutnya, tinjau konfigurasi Anda, dan pilih Buat Pemicu.

catatan

Jika Anda membuat pemicu dengan versi skema tertentu dan kemudian menerapkan otomatisasi dengan skema yang diperbarui, Anda harus memodifikasi pemicunya. Pemicu menjadi tidak kompatibel ketika versi skema berubah dan otomatisasi berjalan akan gagal.

Melihat input dan output untuk proses yang diterapkan

Setelah proses otomatisasi selesai (baik dimulai secara manual atau dengan pemicu terjadwal), nilai input dan output tersedia sebagai artefak terstruktur di panel log pada halaman Runs.

Artefak muncul sebagai kartu khusus:

Input artefak - Menampilkan di bagian atas panel log
Artefak keluaran - Menampilkan di bagian bawah panel log (hanya tersedia jika otomatisasi berhasil diselesaikan)

Kedua kartu diciutkan secara default. Saat Anda mengembangkannya, Anda dapat:

Lihat skema lengkap dan nilai aktual
Unduh objek file apa pun yang termasuk dalam input atau output
Salin data terstruktur sebagai JSON
Unduh payload lengkap sebagai file JSON

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Menguji otomatisasi

Ekspor dan impor otomatisasi