CreateWorkflow - AWS Transfer Family
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanContohLihat Juga

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

CreateWorkflow

Memungkinkan Anda membuat alur kerja dengan langkah-langkah tertentu dan detail langkah yang dipanggil alur kerja setelah transfer file selesai. Setelah membuat alur kerja, Anda dapat mengaitkan alur kerja yang dibuat dengan server transfer apa pun dengan menentukan workflow-details bidang CreateServer dan operasi. UpdateServer

Sintaksis Permintaan

{
   "Description": "string",
   "OnExceptionSteps": [ 
      { 
         "CopyStepDetails": { 
            "DestinationFileLocation": { 
               "EfsFileLocation": { 
                  "FileSystemId": "string",
                  "Path": "string"
               },
               "S3FileLocation": { 
                  "Bucket": "string",
                  "Key": "string"
               }
            },
            "Name": "string",
            "OverwriteExisting": "string",
            "SourceFileLocation": "string"
         },
         "CustomStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string",
            "Target": "string",
            "TimeoutSeconds": number
         },
         "DecryptStepDetails": { 
            "DestinationFileLocation": { 
               "EfsFileLocation": { 
                  "FileSystemId": "string",
                  "Path": "string"
               },
               "S3FileLocation": { 
                  "Bucket": "string",
                  "Key": "string"
               }
            },
            "Name": "string",
            "OverwriteExisting": "string",
            "SourceFileLocation": "string",
            "Type": "string"
         },
         "DeleteStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string"
         },
         "TagStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string",
            "Tags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ]
         },
         "Type": "string"
      }
   ],
   "Steps": [ 
      { 
         "CopyStepDetails": { 
            "DestinationFileLocation": { 
               "EfsFileLocation": { 
                  "FileSystemId": "string",
                  "Path": "string"
               },
               "S3FileLocation": { 
                  "Bucket": "string",
                  "Key": "string"
               }
            },
            "Name": "string",
            "OverwriteExisting": "string",
            "SourceFileLocation": "string"
         },
         "CustomStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string",
            "Target": "string",
            "TimeoutSeconds": number
         },
         "DecryptStepDetails": { 
            "DestinationFileLocation": { 
               "EfsFileLocation": { 
                  "FileSystemId": "string",
                  "Path": "string"
               },
               "S3FileLocation": { 
                  "Bucket": "string",
                  "Key": "string"
               }
            },
            "Name": "string",
            "OverwriteExisting": "string",
            "SourceFileLocation": "string",
            "Type": "string"
         },
         "DeleteStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string"
         },
         "TagStepDetails": { 
            "Name": "string",
            "SourceFileLocation": "string",
            "Tags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ]
         },
         "Type": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam JSON format.

Description

Deskripsi tekstual untuk alur kerja.

Tipe: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 256.

Pola: [\w- ]*

Wajib: Tidak

OnExceptionSteps

Menentukan langkah-langkah (tindakan) untuk mengambil jika kesalahan ditemui selama pelaksanaan alur kerja.

catatan

Untuk langkah-langkah khusus, fungsi Lambda perlu mengirim FAILURE ke panggilan kembali API untuk memulai langkah pengecualian. Selain itu, jika Lambda tidak mengirim SUCCESS sebelum waktu habis, langkah-langkah pengecualian dijalankan.

Tipe: Array objek WorkflowStep

Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 8 item.

Wajib: Tidak

Steps

Menentukan rincian untuk langkah-langkah yang ada dalam alur kerja yang ditentukan.

TYPEMenentukan mana dari tindakan berikut yang sedang diambil untuk langkah ini.

  • COPY- Salin file ke lokasi lain.

  • CUSTOM- Lakukan langkah kustom dengan target AWS Lambda fungsi.

  • DECRYPT- Dekripsi file yang dienkripsi sebelum diunggah.

  • DELETE- Hapus file.

  • TAG- Tambahkan tag ke file.

catatan

Saat ini, penyalinan dan penandaan hanya didukung pada S3.

Untuk lokasi file, Anda menentukan bucket dan kunci Amazon S3, atau ID dan jalur sistem EFS file Amazon.

Tipe: Array objek WorkflowStep

Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 8 item.

Wajib: Ya

Tags

Pasangan nilai kunci yang dapat digunakan untuk mengelompokkan dan mencari alur kerja. Tag adalah metadata yang dilampirkan ke alur kerja untuk tujuan apa pun.

Tipe: Array objek Tag

Anggota Array: Jumlah minimum 1 item. Jumlah maksimum 50 item.

Diperlukan: Tidak

Sintaksis Respons

{
   "WorkflowId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam JSON format oleh layanan.

WorkflowId

Pengidentifikasi unik untuk alur kerja.

Tipe: 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.

AccessDeniedException

Anda tidak memiliki akses yang memadai untuk melakukan tindakan ini.

HTTPKode Status: 400

InternalServiceError

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

HTTPKode Status: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

HTTPKode Status: 400

ResourceExistsException

Sumber daya yang diminta tidak ada, atau ada di wilayah selain yang ditentukan untuk perintah.

HTTPKode Status: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

HTTPKode Status: 500

ThrottlingException

Permintaan ditolak karena throttling permintaan.

HTTPKode Status: 400

Contoh

Contoh

Anda dapat menyimpan informasi langkah alur kerja ke dalam file teks, dan kemudian menggunakan file itu untuk membuat alur kerja, seperti pada contoh berikut. Contoh berikut mengasumsikan Anda telah menyimpan langkah-langkah alur kerja Anda ke example-file.json (dalam folder yang sama dari tempat Anda menjalankan perintah), dan bahwa Anda ingin membuat alur kerja di wilayah Virginia N. (us-east-1). 

aws transfer create-workflow --description "example workflow from a file" --steps file://example-file.json --region us-east-1
// Example file containing workflow steps
[
   {
     "Type": "TAG",
     "TagStepDetails": {
        "Name": "TagStep",
        "Tags": [
          {
            "Key": "name",
            "Value": "testTag"
          }
        ]
     }
   },
   {
     "Type": "COPY",
     "CopyStepDetails": {
        "Name": "CopyStep",
        "DestinationFileLocation": {
        "S3FileLocation": {
           "Bucket": "DOC-EXAMPLE-BUCKET",
           "Key": "DOC-EXAMPLE-KEY/"
                  }
        },
        "OverwriteExisting": "TRUE",
        "SourceFileLocation": "${original.file}"
     }
   },
   {
     "Type": "DELETE",
     "DeleteStepDetails":{
     "Name":"DeleteStep",
     "SourceFileLocation": "${original.file}"
     }
   }
]

Contoh

CreateWorkflowPanggilan mengembalikan ID alur kerja untuk alur kerja baru.

Contoh Respons

{
    "WorkflowId": "w-1234abcd5678efghi"
}

Lihat Juga

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