CreateProfile - AWS Transfer Family

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

CreateProfile

Membuat profil lokal atau mitra untuk digunakan untuk transfer AS2.

Sintaksis Permintaan

{ "As2Id": "string", "CertificateIds": [ "string" ], "ProfileType": "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 format JSON.

As2Id

As2IdItu adalah nama AS2, seperti yang didefinisikan dalam RFC 4130. Untuk transfer masuk, ini adalah AS2-From header untuk pesan AS2 yang dikirim dari mitra. Untuk konektor keluar, ini adalah AS2-To header untuk pesan AS2 yang dikirim ke mitra menggunakan operasi StartFileTransfer API. ID ini tidak dapat menyertakan spasi.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: [\p{Print}\s]*

Wajib: Ya

CertificateIds

Array pengidentifikasi untuk sertifikat yang diimpor. Anda menggunakan pengenal ini untuk bekerja dengan profil dan profil mitra.

Tipe: Array string

Kendala Panjang: Panjang tetap 22.

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

Wajib: Tidak

ProfileType

Menentukan jenis profil yang akan dibuat:

  • Tentukan LOCAL untuk membuat profil lokal. Profil lokal mewakili organisasi atau pihak server Transfer Family AS2 yang diaktifkan.

  • Tentukan PARTNER untuk membuat profil mitra. Profil mitra mewakili organisasi jarak jauh, di luar Transfer Family.

Jenis: String

Nilai yang Valid: LOCAL | PARTNER

Wajib: Ya

Tags

Pasangan nilai kunci yang dapat digunakan untuk mengelompokkan dan mencari profil AS2.

Tipe: Array objek Tag

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

Diperlukan: Tidak

Sintaksis Respons

{ "ProfileId": "string" }

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

ProfileId

Pengenal unik untuk profil AS2, ditampilkan setelah panggilan API berhasil.

Jenis: String

Kendala Panjang: Panjang tetap 19.

Pola: p-([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.

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

ResourceNotFoundException

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

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

Kode Status HTTP: 500

ThrottlingException

Permintaan ditolak karena throttling permintaan.

Kode Status HTTP: 400

Contoh

Contoh

Contoh berikut membuat profil, dan mengembalikan ID profil.

ID sertifikat dibuat saat Anda menjalankanimport-certificate, satu untuk sertifikat penandatanganan, dan satu untuk sertifikat enkripsi.

aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk c-987654aaaa321bbbb

Contoh Respons

Panggilan API mengembalikan ID profil untuk profil baru.

{ "ProfileId": "p-11112222333344444" }

Lihat Juga

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