UpdateAgreement - 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.

UpdateAgreement

Memperbarui beberapa parameter untuk perjanjian yang ada. Berikan AgreementId dan ServerId untuk perjanjian yang ingin Anda perbarui, bersama dengan nilai baru untuk parameter yang akan diperbarui.

Sintaksis Permintaan

{
   "AccessRole": "string",
   "AgreementId": "string",
   "BaseDirectory": "string",
   "Description": "string",
   "LocalProfileId": "string",
   "PartnerProfileId": "string",
   "ServerId": "string",
   "Status": "string"
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam JSON format.

AccessRole

Konektor digunakan untuk mengirim file menggunakan SFTP protokol AS2 atau. Untuk peran akses, berikan Amazon Resource Name (ARN) AWS Identity and Access Management peran yang akan digunakan.

Untuk AS2 konektor

DenganAS2, Anda dapat mengirim file dengan memanggil StartFileTransfer dan menentukan jalur file dalam parameter permintaan,SendFilePaths. Kami menggunakan direktori induk file (misalnya, untuk--send-file-paths /bucket/dir/file.txt, direktori induk/bucket/dir/) untuk sementara menyimpan file AS2 pesan yang diproses, menyimpan MDN ketika kami menerimanya dari mitra, dan menulis JSON file akhir yang berisi metadata transmisi yang relevan. Jadi, AccessRole kebutuhan untuk menyediakan akses baca dan tulis ke direktori induk dari lokasi file yang digunakan dalam StartFileTransfer permintaan. Selain itu, Anda perlu menyediakan akses baca dan tulis ke direktori induk dari file yang ingin Anda kirimStartFileTransfer.

Jika Anda menggunakan otentikasi Dasar untuk AS2 konektor Anda, peran akses memerlukan secretsmanager:GetSecretValue izin untuk rahasia tersebut. Jika rahasia dienkripsi menggunakan kunci yang dikelola pelanggan alih-alih kunci yang dikelola di AWS Secrets Manager, maka peran tersebut juga memerlukan kms:Decrypt izin untuk kunci tersebut.

Untuk SFTP konektor

Pastikan bahwa peran akses menyediakan akses baca dan tulis ke direktori induk dari lokasi file yang digunakan dalam StartFileTransfer permintaan. Selain itu, pastikan bahwa peran tersebut memberikan secretsmanager:GetSecretValue izin untuk AWS Secrets Manager.

Tipe: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.

Pola: arn:.*role/\S+

Wajib: Tidak

AgreementId

Pengidentifikasi unik untuk perjanjian. Pengenal ini dikembalikan saat Anda membuat perjanjian.

Tipe: String

Kendala Panjang: Panjang tetap 19.

Pola: a-([0-9a-f]{17})

Wajib: Ya

BaseDirectory

Untuk mengubah direktori pendaratan (folder) untuk file yang ditransfer, berikan folder bucket yang ingin Anda gunakan; misalnya,/DOC-EXAMPLE-BUCKET/home/mydirectory .

Tipe: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 1024.

Pola: (|/.*)

Wajib: Tidak

Description

Untuk mengganti deskripsi yang ada, berikan deskripsi singkat untuk perjanjian tersebut.

Tipe: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 200.

Pola: [\p{Graph}]+

Wajib: Tidak

LocalProfileId

Pengenal unik untuk profil AS2 lokal.

Untuk mengubah pengenal profil lokal, berikan nilai baru di sini.

Tipe: String

Kendala Panjang: Panjang tetap 19.

Pola: p-([0-9a-f]{17})

Wajib: Tidak

PartnerProfileId

Pengenal unik untuk profil mitra. Untuk mengubah pengenal profil mitra, berikan nilai baru di sini.

Tipe: String

Kendala Panjang: Panjang tetap 19.

Pola: p-([0-9a-f]{17})

Wajib: Tidak

ServerId

Pengidentifikasi unik yang ditetapkan sistem untuk instans server. Ini adalah server khusus yang digunakan perjanjian.

Tipe: String

Kendala Panjang: Panjang tetap 19.

Pola: s-([0-9a-f]{17})

Wajib: Ya

Status

Anda dapat memperbarui status perjanjian, baik mengaktifkan perjanjian yang tidak aktif atau sebaliknya.

Tipe: String

Nilai yang Valid: ACTIVE | INACTIVE

Wajib: Tidak

Sintaksis Respons

{
   "AgreementId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam JSON format oleh layanan.

AgreementId

Pengidentifikasi unik untuk perjanjian. Pengenal ini dikembalikan saat Anda membuat perjanjian.

Tipe: String

Kendala Panjang: Panjang tetap 19.

Pola: a-([0-9a-f]{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.

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

ResourceNotFoundException

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

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

Lihat Juga

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