Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
CreateAgreement
Membuat perjanjian. Perjanjian adalah perjanjian mitra dagang bilateral, atau kemitraan, antara AWS Transfer Family server dan AS2 proses. Perjanjian mendefinisikan hubungan transfer file dan pesan antara server dan AS2 proses. Untuk menentukan perjanjian, Transfer Family menggabungkan server, profil lokal, profil mitra, sertifikat, dan atribut lainnya.
Mitra diidentifikasi denganPartnerProfileId, dan AS2 prosesnya diidentifikasi denganLocalProfileId.
Sintaksis Permintaan
{
"AccessRole": "string",
"BaseDirectory": "string",
"Description": "string",
"LocalProfileId": "string",
"PartnerProfileId": "string",
"ServerId": "string",
"Status": "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.
- 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
StartFileTransferdan 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,AccessRolekebutuhan untuk menyediakan akses baca dan tulis ke direktori induk dari lokasi file yang digunakan dalamStartFileTransferpermintaan. 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:GetSecretValueizin untuk rahasia tersebut. Jika rahasia dienkripsi menggunakan kunci yang dikelola pelanggan alih-alih kunci terkelola di AWS Secrets Manager, maka peran tersebut juga memerlukankms:Decryptizin untuk kunci tersebut.Untuk SFTP konektor
Pastikan bahwa peran akses menyediakan akses baca dan tulis ke direktori induk dari lokasi file yang digunakan dalam
StartFileTransferpermintaan. Selain itu, pastikan bahwa peran tersebut memberikansecretsmanager:GetSecretValueizin untuk AWS Secrets Manager.Tipe: String
Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.
Pola:
arn:.*role/\S+Wajib: Ya
- BaseDirectory
-
Direktori pendaratan (folder) untuk file yang ditransfer dengan menggunakan AS2 protokol.
Contoh
BaseDirectoryadalah/DOC-EXAMPLE-BUCKET/home/mydirectory.Tipe: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 1024.
Pola:
(|/.*)Wajib: Ya
- Description
-
Nama atau deskripsi singkat untuk mengidentifikasi perjanjian.
Tipe: String
Panjang Batasan: Panjang minimum 1. Panjang maksimum 200.
Pola:
[\p{Graph}]+Wajib: Tidak
- LocalProfileId
-
Pengenal unik untuk profil AS2 lokal.
Tipe: String
Kendala Panjang: Panjang tetap 19.
Pola:
p-([0-9a-f]{17})Wajib: Ya
- PartnerProfileId
-
Pengenal unik untuk profil mitra yang digunakan dalam perjanjian.
Tipe: String
Kendala Panjang: Panjang tetap 19.
Pola:
p-([0-9a-f]{17})Wajib: Ya
- 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
-
Status perjanjian. Kesepakatan itu bisa berupa
ACTIVEatauINACTIVE.Tipe: String
Nilai yang Valid:
ACTIVE | INACTIVEWajib: 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.
Diperlukan: 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. Gunakan ID ini untuk menghapus, atau memperbarui perjanjian, serta dalam API panggilan lain yang mengharuskan Anda menentukan ID 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
Contoh
Contoh
Contoh berikut membuat perjanjian, dan mengembalikan ID perjanjian.
aws transfer create-agreement --server-id s-021345abcdef6789 --local-profile-id p-1234567890abcdef0 --partner-profile-id p-abcdef01234567890 --base-folder /DOC-EXAMPLE-BUCKET/AS2-files --access-role arn:aws:iam::111122223333:role/AS2-role
Contoh Respons
APIPanggilan mengembalikan ID perjanjian untuk perjanjian baru.
{ "AgreementId": "a-11112222333344444" }
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
