DescribeAddresses - AWS Snowball
Sintaks 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.

DescribeAddresses

Mengembalikan sejumlah tertentu objek ADDRESS. Memanggil API ini di salah satu wilayah AS akan mengembalikan alamat dari daftar semua alamat yang terkait dengan akun ini di semua wilayah AS.

Sintaks Permintaan

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

Parameter Permintaan

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

Permintaan menerima data berikut dalam format JSON.

MaxResults

Jumlah objek ADDRESS untuk dihasilkan.

Tipe: Integer

Rentang Valid: Nilai minimum 0. Nilai maksimum 100.

Wajib: Tidak

NextToken

Permintaan HTTP adalah stateless. Untuk mengidentifikasi apa objek "berikutnya" dalam daftar objek ADDRESS, Anda memiliki opsi untuk menentukan nilai bagi NextToken sebagai titik mulai untuk daftar alamat yang dikembalikan.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: .*

Diperlukan: Tidak

Sintaksis Respons

{
   "Addresses": [ 
      { 
         "AddressId": "string",
         "City": "string",
         "Company": "string",
         "Country": "string",
         "IsRestricted": boolean,
         "Landmark": "string",
         "Name": "string",
         "PhoneNumber": "string",
         "PostalCode": "string",
         "PrefectureOrDistrict": "string",
         "StateOrProvince": "string",
         "Street1": "string",
         "Street2": "string",
         "Street3": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Addresses

Alamat pengiriman perangkat Snow yang dibuat untuk account ini.

Tipe: Susunan objek Address

NextToken

Permintaan HTTP adalah stateless. Jika Anda menggunakan nilai NextToken yang dihasilkan secara otomatis pada panggilan DescribeAddresses Anda berikutnya, daftar alamat yang dikembalikan akan mulai dari titik ini di dalam susunan.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: .*

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InvalidNextTokenException

String NextToken diubah tiba-tiba, dan operasi telah berhenti. Jalankan operasi tanpa mengubah string NextToken, dan coba lagi.

Kode Status HTTP: 400

InvalidResourceException

Sumber daya yang ditentukan tidak dapat ditemukan. Periksa informasi yang Anda berikan dalam permintaan terakhir Anda, dan coba lagi.

Kode Status HTTP: 400

Lihat Juga

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