CreateConnector - AWS Transfer Family
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanContohLihat Juga

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

CreateConnector

Membuat konektor, yang menangkap parameter untuk koneksi untuk SFTP protokol AS2 atau. UntukAS2, konektor diperlukan untuk mengirim file ke server yang dihosting AS2 secara eksternal. UntukSFTP, konektor diperlukan saat mengirim file ke SFTP server atau menerima file dari SFTP server. Untuk detail selengkapnya tentang konektor, lihat Mengkonfigurasi AS2 konektor dan Membuat SFTP konektor.

catatan

Anda harus menentukan dengan tepat satu objek konfigurasi: baik untuk AS2 (As2Config) atau SFTP (SftpConfig).

Sintaksis Permintaan

{
   "AccessRole": "string",
   "As2Config": { 
      "BasicAuthSecretId": "string",
      "Compression": "string",
      "EncryptionAlgorithm": "string",
      "LocalProfileId": "string",
      "MdnResponse": "string",
      "MdnSigningAlgorithm": "string",
      "MessageSubject": "string",
      "PartnerProfileId": "string",
      "SigningAlgorithm": "string"
   },
   "LoggingRole": "string",
   "SftpConfig": { 
      "TrustedHostKeys": [ "string" ],
      "UserSecretId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Url": "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 terkelola 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: Ya

As2Config

Struktur yang berisi parameter untuk objek AS2 konektor.

Tipe: Objek As2ConnectorConfig

Wajib: Tidak

LoggingRole

Amazon Resource Name (ARN) dari peran AWS Identity and Access Management (IAM) yang memungkinkan konektor mengaktifkan CloudWatch logging untuk peristiwa Amazon S3. Saat disetel, Anda dapat melihat aktivitas konektor di CloudWatch log Anda.

Tipe: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.

Pola: arn:.*role/\S+

Wajib: Tidak

SftpConfig

Struktur yang berisi parameter untuk objek SFTP konektor.

Tipe: Objek SftpConnectorConfig

Wajib: Tidak

Tags

Pasangan nilai kunci yang dapat digunakan untuk mengelompokkan dan mencari konektor. Tag adalah metadata yang terpasang pada konektor untuk tujuan apa pun.

Tipe: Array objek Tag

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

Wajib: Tidak

Url

URLDari pasangan AS2 atau SFTP titik akhir.

Tipe: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum sebesar 255.

Wajib: Ya

Sintaksis Respons

{
   "ConnectorId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam JSON format oleh layanan.

ConnectorId

Pengenal unik untuk konektor, dikembalikan setelah API panggilan berhasil.

Tipe: String

Kendala Panjang: Panjang tetap 19.

Pola: c-([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 AS2 konektor. Dalam perintah, ganti item sebagai berikut:

  • url: menyediakan URL untuk AS2 server mitra dagang.

  • your-IAM-role-for-bucket-access: IAM peran yang memiliki akses ke bucket Amazon S3 yang Anda gunakan untuk menyimpan file Anda.

  • Gunakan peran ARN untuk pencatatan Anda, yang menyertakan Akun AWS ID Anda.

  • Berikan jalur ke file yang berisi parameter konfigurasi AS2 konektor. Objek konfigurasi AS2 konektor dijelaskan dalam As2 ConnectorConfig.

// Listing for testAs2Config.json
{
  "LocalProfileId": "your-profile-id",
  "PartnerProfileId": "partner-profile-id",
  "MdnResponse": "SYNC",
  "Compression": "ZLIB",
  "EncryptionAlgorithm": "AES256_CBC",
  "SigningAlgorithm": "SHA256",
  "MdnSigningAlgorithm": "DEFAULT",
  "MessageSubject": "Your Message Subject"
}
        
aws transfer create-connector --url "http://partner-as2-server-url" \
          --access-role your-IAM-role-for-bucket-access \
          --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \
          --as2-config file://path/to/testAS2Config.json

Contoh

Contoh berikut membuat SFTP konektor. Dalam perintah, ganti item sebagai berikut:

  • sftp-server-url: menyediakan URL untuk SFTP server tempat Anda bertukar file.

  • your-IAM-role-for-bucket-access: IAM peran yang memiliki akses ke bucket Amazon S3 yang Anda gunakan untuk menyimpan file Anda.

  • Gunakan peran ARN untuk pencatatan Anda, yang menyertakan Akun AWS ID Anda.

  • Berikan jalur ke file yang berisi parameter konfigurasi SFTP konektor. Objek konfigurasi SFTP konektor dijelaskan dalam SftpConnectorConfig.

// Listing for testSFTPConfig.json
{   
   "UserSecretId": "arn:aws:secretsmanager:us-east-2:123456789012:secret:aws/transfer/example-username-key",
   "TrustedHostKeys": [
      "sftp.example.com ssh-rsa AAAAbbbb...EEEE="
   ]
}
aws transfer create-connector --url "sftp://sftp-server-url" \
--access-role your-IAM-role-for-bucket-access \
--logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \
--sftp-config file://path/to/testSFTPConfig.json

Contoh

APIPanggilan mengembalikan ID konektor untuk konektor baru.

Contoh Respons

{
    "ConnectorId": "a-11112222333344444"
}

Lihat Juga

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