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

ListProfiles

Mengembalikan daftar profil untuk sistem Anda. Jika Anda ingin membatasi hasil ke angka tertentu, berikan nilai untuk MaxResults parameter tersebut. Jika Anda menjalankan perintah sebelumnya dan menerima nilai untukNextToken, Anda dapat memberikan nilai itu untuk melanjutkan daftar profil dari tempat Anda tinggalkan.

Sintaksis Permintaan

{
   "MaxResults": number,
   "NextToken": "string",
   "ProfileType": "string"
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam format JSON.

MaxResults

Jumlah maksimum profil untuk kembali.

Jenis: Integer

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 1000.

Wajib: Tidak

NextToken

Ketika ada hasil tambahan yang tidak dikembalikan, NextToken parameter dikembalikan. Anda dapat menggunakan nilai tersebut untuk panggilan berikutnya ListProfiles untuk melanjutkan hasil daftar.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

Wajib: Tidak

ProfileType

Menunjukkan apakah hanya akan mencantumkan profil LOCAL tipe atau hanya PARTNER mengetik profil. Jika tidak disediakan dalam permintaan, perintah mencantumkan semua jenis profil.

Jenis: String

Nilai yang Valid: LOCAL | PARTNER

Wajib: Tidak

Sintaksis Respons

{
   "NextToken": "string",
   "Profiles": [ 
      { 
         "Arn": "string",
         "As2Id": "string",
         "ProfileId": "string",
         "ProfileType": "string"
      }
   ]
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

NextToken

Mengembalikan token yang dapat Anda gunakan untuk menelepon ListProfiles lagi dan menerima hasil tambahan, jika ada.

Jenis: String

Panjang Batasan: Panjang minimum 1. Panjang maksimum 6144.

Profiles

Mengembalikan array, di mana setiap item berisi rincian profil.

Tipe: Array objek ListedProfile

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

InvalidNextTokenException

NextTokenParameter yang dilewatkan tidak valid.

Kode Status HTTP: 400

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

Lihat Juga

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