StartTaskExecution - AWS DataSync
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanContoh-contohLihat Juga

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

StartTaskExecution

Memulai tugas AWS DataSync transfer. Untuk setiap tugas, Anda hanya dapat menjalankan satu eksekusi tugas pada satu waktu.

Ada beberapa fase untuk pelaksanaan tugas. Untuk informasi selengkapnya, lihat Status eksekusi tugas.

penting

Jika Anda berencana untuk mentransfer data ke atau dari lokasi Amazon S3, tinjau bagaimana DataSync dapat memengaruhi biaya permintaan S3 Anda dan halaman DataSync harga sebelum memulai.

Sintaksis Permintaan

{
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "string"
         }
      }
   },
   "OverrideOptions": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TaskArn": "string",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "string"
   }
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam format JSON.

Excludes

Menentukan daftar aturan filter yang menentukan file mana yang akan dikecualikan dari tugas. Daftar ini berisi string filter tunggal yang terdiri dari pola untuk dikecualikan. Pola dibatasi oleh "|" (yaitu, pipa), misalnya, "/folder1|/folder2".

Tipe: Array objek FilterRule

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

Diperlukan: Tidak

Includes

Menentukan daftar aturan filter yang menentukan file mana yang akan disertakan saat menjalankan tugas. Pola harus berisi string filter tunggal yang terdiri dari pola yang akan disertakan. Pola dibatasi oleh "|" (yaitu, pipa), misalnya, "/folder1|/folder2".

Tipe: Array objek FilterRule

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

Diperlukan: Tidak

ManifestConfig

Mengkonfigurasi manifes, yang merupakan daftar file atau objek yang DataSync ingin Anda transfer. Untuk informasi selengkapnya dan contoh konfigurasi, lihat Menentukan DataSync transfer apa yang menggunakan manifes.

Saat menggunakan parameter ini, identitas penelepon Anda (peran yang Anda gunakan DataSync ) harus memiliki iam:PassRole izin. AWSDataSyncFullAccessKebijakan tersebut mencakup izin ini.

Untuk menghapus konfigurasi manifes, tentukan parameter ini dengan nilai kosong.

Tipe: Objek ManifestConfig

Diperlukan: Tidak

OverrideOptions

Menunjukkan bagaimana tugas transfer Anda dikonfigurasi. Opsi ini mencakup cara DataSync menangani file, objek, dan metadata terkait selama transfer Anda. Anda juga dapat menentukan cara memverifikasi integritas data, menetapkan batas bandwidth untuk tugas Anda, di antara opsi lainnya.

Setiap opsi memiliki nilai default. Kecuali Anda perlu, Anda tidak perlu mengonfigurasi salah satu opsi ini sebelum memulai tugas Anda.

Tipe: Objek Options

Diperlukan: Tidak

Tags

Menentukan tag yang ingin Anda terapkan ke Amazon Resource Name (ARN) yang mewakili eksekusi tugas.

Tag adalah pasangan nilai kunci yang membantu Anda mengelola, memfilter, dan mencari sumber daya Anda DataSync .

Tipe: Array objek TagListEntry

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

Diperlukan: Tidak

TaskArn

Menentukan Nama Sumber Daya Amazon (ARN) dari tugas yang ingin Anda mulai.

Jenis: String

Batasan Panjang: Panjang maksimum 128.

Pola: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$

Diperlukan: Ya

TaskReportConfig

Menentukan bagaimana Anda ingin mengkonfigurasi laporan tugas, yang memberikan informasi rinci tentang DataSync transfer Anda. Untuk informasi selengkapnya, lihat Memantau DataSync transfer Anda dengan laporan tugas.

Saat menggunakan parameter ini, identitas penelepon Anda (peran yang Anda gunakan DataSync ) harus memiliki iam:PassRole izin. AWSDataSyncFullAccessKebijakan tersebut mencakup izin ini.

Untuk menghapus konfigurasi laporan tugas, tentukan parameter ini sebagai kosong.

Tipe: Objek TaskReportConfig

Wajib: Tidak

Sintaksis Respons

{
   "TaskExecutionArn": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

TaskExecutionArn

ARN dari eksekusi tugas yang sedang berjalan.

Jenis: String

Batasan Panjang: Panjang maksimum 128.

Pola: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$

Kesalahan

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

InternalException

Pengecualian ini dilontarkan ketika terjadi kesalahan dalam layanan AWS DataSync .

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

Contoh-contoh

Permintaan Sampel

Contoh berikut memulai eksekusi tugas menggunakan opsi default untuk tugas yang ditentukan.

{
    "OverrideOptions": {
        "Atime": "BEST_EFFORT",
        "BytesPerSecond": 1000,
        "Gid": "NONE",
        "Mtime": "PRESERVE",
        "PosixPermissions": "PRESERVE",
        "PreserveDevices": "NONE",
        "PreserveDeletedFiles": "PRESERVE",
        "Uid": "NONE",
        "VerifyMode": "POINT_IN_TIME_CONSISTENT"
    },
    "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026"
}

Contoh Respons

Contoh ini menggambarkan salah satu penggunaan. StartTaskExecution

{
  "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}

Lihat Juga

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