ListPickupLocations - AWS Snowball
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.

ListPickupLocations

Daftar lokasi dari mana pelanggan dapat memilih untuk mengambil perangkat.

Sintaksis 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 maksimum lokasi untuk daftar per halaman.

Tipe: Bilangan Bulat

Rentang Valid: Nilai minimum 0. Nilai maksimum 100.

Diperlukan: Tidak

NextToken

Permintaan HTTP adalah stateless. Untuk mengidentifikasi apa objek "berikutnya" dalam daftar objek ListPickupLocationsRequest, Anda memiliki opsi untuk menentukan NextToken sebagai titik mulai untuk daftar yang Anda hasilkan.

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

Informasi tentang alamat lokasi penjemputan.

Tipe: Array objek Address

NextToken

Permintaan HTTP adalah stateless. Untuk mengidentifikasi apa objek "berikutnya" dalam daftar objek ListPickupLocationsResult, Anda memiliki opsi untuk menentukan NextToken sebagai titik mulai untuk daftar yang Anda hasilkan.

Tipe: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 1024.

Pola: .*

Kesalahan

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

InvalidResourceException

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

Kode Status HTTP: 400

Contoh

Contoh

Contoh ini menggambarkan salah satu penggunaan. ListPickupLocations


{
    "id": "to-get-a-list-of-locations-from-which-the-customer-can-choose-to-pickup-a-device-1482542167627",
    "title": "To get a list of locations from which the customer can choose to pickup a device.",
    "description": "Returns a specified number of Address objects. Each Address is a pickup location address for Snow Family devices.",
    "input": {},
    "output": {
       "Addresses": [
        {
          "City": "Seattle",
          "Name": "My Name",
          "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b",
          "Street1": "123 Main Street",
          "Company": "My Company",
          "PhoneNumber": "425-555-5555",
          "Country": "US",
          "PostalCode": "98101",
          "StateOrProvince": "WA"
        }
      ]
    },
    "comments": {}
}

Lihat Juga

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