DescribeExecution - AWS Transfer Family

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

DescribeExecution

Anda dapat menggunakan DescribeExecution untuk memeriksa rincian eksekusi alur kerja yang ditentukan.

catatan

Panggilan API ini hanya menampilkan detail untuk alur kerja yang sedang berlangsung.

Jika Anda memberikan ID untuk eksekusi yang tidak sedang berlangsung, atau jika eksekusi tidak cocok dengan ID alur kerja yang ditentukan, Anda akan menerima ResourceNotFound pengecualian.

Sintaksis Permintaan

{ "ExecutionId": "string", "WorkflowId": "string" }

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam format JSON.

ExecutionId

Pengidentifikasi unik untuk eksekusi alur kerja.

Jenis: String

Batas Panjang: Panjang tetap 36.

Pola: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

Wajib: Ya

WorkflowId

Pengidentifikasi unik untuk alur kerja.

Jenis: String

Kendala Panjang: Panjang tetap 19.

Pola: w-([a-z0-9]{17})

Diperlukan: Ya

Sintaksis Respons

{ "Execution": { "ExecutionId": "string", "ExecutionRole": "string", "InitialFileLocation": { "EfsFileLocation": { "FileSystemId": "string", "Path": "string" }, "S3FileLocation": { "Bucket": "string", "Etag": "string", "Key": "string", "VersionId": "string" } }, "LoggingConfiguration": { "LoggingRole": "string", "LogGroupName": "string" }, "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Results": { "OnExceptionSteps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ], "Steps": [ { "Error": { "Message": "string", "Type": "string" }, "Outputs": "string", "StepType": "string" } ] }, "ServiceMetadata": { "UserDetails": { "ServerId": "string", "SessionId": "string", "UserName": "string" } }, "Status": "string" }, "WorkflowId": "string" }

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Execution

Struktur yang berisi rincian eksekusi alur kerja.

Tipe: Objek DescribedExecution

WorkflowId

Pengidentifikasi unik untuk alur kerja.

Jenis: String

Kendala Panjang: Panjang tetap 19.

Pola: w-([a-z0-9]{17})

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InternalServiceError

Pengecualian ini dilemparkan ketika kesalahan terjadi dalam AWS Transfer Family layanan.

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

ResourceNotFoundException

Pengecualian ini dilemparkan ketika sumber daya tidak ditemukan oleh layanan AWS Transfer Family.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

Kode Status HTTP: 500

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: