ListPickupLocations - AWS Snowball Edge
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosExemplosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

ListPickupLocations

Importante

Aviso de fim do suporte: em 12 de novembro de 2024, AWS descontinuaremos os dispositivos Snowball da geração anterior e os dois dispositivos AWS Snowcone (HDD e SDD). Continuaremos oferecendo suporte aos clientes existentes que usam esses end-of-life dispositivos até 12 de novembro de 2025. Os dispositivos AWS Snowball de última geração estão disponíveis para todos os clientes. Veja esta postagem em blog para obter mais informações.

Uma lista de locais nos quais o cliente pode escolher retirar um dispositivo.

Sintaxe da Solicitação

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

Parâmetros da solicitação

Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

MaxResults

O número máximo de locais a serem listados por página.

Tipo: inteiro

Intervalo válido: valor mínimo de 0. Valor máximo de 100.

Obrigatório: Não

NextToken

Solicitações HTTP são sem estado. Para identificar qual objeto vem “a seguir” na lista de objetos ListPickupLocationsRequest, você tem a opção de especificar NextToken como ponto de partida para sua lista retornada.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.

Padrão: .*

Obrigatório: Não

Sintaxe da Resposta

{
   "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 Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

Addresses

Informações sobre o endereço dos locais de coleta.

Tipo: matriz de objetos Address

NextToken

Solicitações HTTP são sem estado. Para identificar qual objeto vem “a seguir” na lista de objetos ListPickupLocationsResult, você tem a opção de especificar NextToken como ponto de partida para sua lista retornada.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.

Padrão: .*

Erros

Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.

InvalidResourceException

Não foi possível encontrar o recurso especificado. Confira as informações fornecidas na última solicitação e tente novamente.

Código de status HTTP: 400

Exemplos

Exemplo

Este exemplo ilustra um uso do. 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": {}
}

Consulte também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: