Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
ListPickupLocations
importante
Aviso de fin de soporte: el 12 de noviembre de 2024, AWS se suspenderán los dispositivos AWS Snowball de la generación anterior y los dos dispositivos Snowcone (HDD y SDD). Seguiremos ofreciendo asistencia a los clientes actuales que utilicen estos end-of-life dispositivos hasta el 12 de noviembre de 2025. Los dispositivos AWS Snowball de última generación están disponibles para todos los clientes. Para obtener más información, visite esta publicación del blog
Una lista de ubicaciones entre las que el cliente puede elegir recoger un dispositivo.
Sintaxis de la solicitud
{
"MaxResults": number
,
"NextToken": "string
"
}
Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
La solicitud acepta los siguientes datos en formato JSON.
- MaxResults
-
El número máximo de ubicaciones que se van a enumerar por página.
Tipo: entero
Rango válido: valor mínimo de 0. Valor máximo de 100.
Obligatorio: no
- NextToken
-
Las solicitudes HTTP no tienen estado. Para identificar qué objeto es el “siguiente” en la lista de objetos
ListPickupLocationsRequest
, tiene la opción de especificarNextToken
como punto de partida de la lista de elementos devueltos.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
.*
Obligatorio: no
Sintaxis de la respuesta
{
"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"
}
Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- Addresses
-
Información sobre la dirección de las ubicaciones de recogida.
Tipo: matriz de objetos Address
- NextToken
-
Las solicitudes HTTP no tienen estado. Para identificar qué objeto es el “siguiente” en la lista de objetos
ListPickupLocationsResult
, tiene la opción de especificarNextToken
como punto de partida de la lista de elementos devueltos.Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
.*
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidResourceException
-
No se ha encontrado el recurso especificado. Compruebe la información que proporcionó en la última solicitud e inténtelo de nuevo.
Código de estado HTTP: 400
Ejemplos
Ejemplo
Este ejemplo ilustra un uso de 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 Snowball Edge 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": {} }
Véase también
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: