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

UpdateConnector

Memperbarui beberapa parameter untuk konektor yang ada. Berikan konektor ConnectorId yang ingin Anda perbarui, bersama dengan nilai baru untuk parameter yang akan diperbarui.

Sintaksis Permintaan

{
   "AccessRole": "string",
   "As2Config": { 
      "BasicAuthSecretId": "string",
      "Compression": "string",
      "EncryptionAlgorithm": "string",
      "LocalProfileId": "string",
      "MdnResponse": "string",
      "MdnSigningAlgorithm": "string",
      "MessageSubject": "string",
      "PartnerProfileId": "string",
      "SigningAlgorithm": "string"
   },
   "ConnectorId": "string",
   "LoggingRole": "string",
   "SecurityPolicyName": "string",
   "SftpConfig": { 
      "TrustedHostKeys": [ "string" ],
      "UserSecretId": "string"
   },
   "Url": "string"
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam format JSON.

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

As2Config

Struktur yang berisi parameter untuk objek konektor AS2.

Tipe: Objek As2ConnectorConfig

Wajib: Tidak

ConnectorId

Pengidentifikasi unik untuk konektor.

Jenis: String

Kendala Panjang: Panjang tetap 19.

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

Wajib: Ya

LoggingRole

Nama Sumber Daya Amazon (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.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048.

Pola: arn:.*role/\S+

Wajib: Tidak

SecurityPolicyName

Menentukan nama kebijakan keamanan untuk konektor.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 100.

Pola: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+

Wajib: Tidak

SftpConfig

Struktur yang berisi parameter untuk objek konektor SFTP.

Tipe: Objek SftpConnectorConfig

Wajib: Tidak

Url

URL titik akhir AS2 atau SFTP mitra.

Jenis: String

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

Wajib: Tidak

Sintaksis Respons

{
   "ConnectorId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

ConnectorId

Mengembalikan identifier dari objek konektor yang Anda memperbarui.

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

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

ResourceExistsException

Sumber daya yang diminta tidak ada, atau ada di wilayah selain yang ditentukan untuk perintah.

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

Lihat Juga

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