DescribedAgreement - AWS Transfer Family

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

DescribedAgreement

Menjelaskan sifat-sifat perjanjian.

Daftar Isi

Arn

Nama Sumber Daya Amazon (ARN) yang unik untuk perjanjian tersebut.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

Pola: arn:\S+

Wajib: Ya

AccessRole

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

Untuk konektor AS2

Dengan AS2, Anda dapat mengirim file dengan memanggil StartFileTransfer dan menentukan jalur file dalam parameter permintaan,. SendFilePaths Kami menggunakan direktori induk file (misalnya, untuk, direktori induk/bucket/dir/) untuk --send-file-paths /bucket/dir/file.txt sementara menyimpan file pesan AS2 yang diproses, menyimpan MDN ketika kami menerimanya dari mitra, dan menulis file JSON 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 konektor AS2 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 konektor SFTP

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.

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

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Wajib: Tidak

BaseDirectory

Direktori pendaratan (folder) untuk file yang ditransfer dengan menggunakan protokol AS2.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 1024.

Pola: (|/.*)

Wajib: Tidak

Description

Nama atau deskripsi singkat yang digunakan untuk mengidentifikasi perjanjian.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 200.

Pola: [\p{Graph}]+

Wajib: Tidak

LocalProfileId

Pengidentifikasi unik untuk profil lokal AS2.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Wajib: Tidak

PartnerProfileId

Pengidentifikasi unik untuk profil mitra yang digunakan dalam perjanjian.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Wajib: Tidak

ServerId

Pengidentifikasi unik yang ditetapkan sistem untuk instans server. Pengidentifikasi ini menunjukkan server spesifik yang digunakan perjanjian.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Wajib: Tidak

Status

Status perjanjian saat ini, baik ACTIVE atauINACTIVE.

Jenis: String

Nilai yang Valid: ACTIVE | INACTIVE

Wajib: Tidak

Tags

Pasangan nilai kunci yang dapat digunakan untuk mengelompokkan dan mencari perjanjian.

Tipe: Array objek Tag

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

Wajib: Tidak

Lihat Juga

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