ListExecutions - AWS Transfer Family
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

ListExecutions

Daftar semua eksekusi yang sedang berlangsung untuk alur kerja yang ditentukan.

catatan

Jika ID alur kerja yang ditentukan tidak dapat ditemukan, ListExecutions mengembalikan ResourceNotFound pengecualian.

Sintaksis Permintaan

{
   "MaxResults": number,
   "NextToken": "string",
   "WorkflowId": "string"
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam format JSON.

MaxResults

Menentukan jumlah maksimum eksekusi untuk kembali.

Jenis: Integer

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 1000.

Wajib: Tidak

NextToken

ListExecutionsmengembalikan NextToken parameter dalam output. Anda kemudian dapat meneruskan NextToken parameter dalam perintah berikutnya untuk melanjutkan daftar eksekusi tambahan.

Ini berguna untuk pagination, misalnya. Jika Anda memiliki 100 eksekusi untuk alur kerja, Anda mungkin hanya ingin daftar pertama 10. Jika demikian, panggil API dengan menentukan: max-results

aws transfer list-executions --max-results 10

Ini mengembalikan rincian untuk 10 eksekusi pertama, serta pointer (NextToken) ke eksekusi kesebelas. Sekarang Anda dapat memanggil API lagi, memberikan NextToken nilai yang Anda terima:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

Panggilan ini mengembalikan 10 eksekusi berikutnya, yang ke-11 hingga ke-20. Anda kemudian dapat mengulangi panggilan sampai rincian untuk semua 100 eksekusi telah dikembalikan.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

Wajib: Tidak

WorkflowId

Pengidentifikasi unik untuk alur kerja.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Diperlukan: Ya

Sintaksis Respons

{
   "Executions": [ 
      { 
         "ExecutionId": "string",
         "InitialFileLocation": { 
            "EfsFileLocation": { 
               "FileSystemId": "string",
               "Path": "string"
            },
            "S3FileLocation": { 
               "Bucket": "string",
               "Etag": "string",
               "Key": "string",
               "VersionId": "string"
            }
         },
         "ServiceMetadata": { 
            "UserDetails": { 
               "ServerId": "string",
               "SessionId": "string",
               "UserName": "string"
            }
         },
         "Status": "string"
      }
   ],
   "NextToken": "string",
   "WorkflowId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Executions

Mengembalikan rincian untuk setiap eksekusi, dalam ListedExecution array.

Tipe: Array objek ListedExecution

NextToken

ListExecutionsmengembalikan NextToken parameter dalam output. Anda kemudian dapat meneruskan NextToken parameter dalam perintah berikutnya untuk melanjutkan daftar eksekusi tambahan.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

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

InvalidNextTokenException

NextTokenParameter yang dilewatkan tidak valid.

Kode Status HTTP: 400

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: