ListLocations - AWS DataSync
Sintaxe da solicitaçãoParâmetros de solicitaçãoSintaxe da respostaElementos de respostaErrosConsulte 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á.

ListLocations

Retorna uma lista de pontos de origem e de destino.

Se você tiver mais locais do que os retornados em uma resposta (ou seja, a resposta retornará somente uma lista truncada de seus agentes), a resposta conterá um token que você pode especificar em sua próxima solicitação para buscar a próxima página de locais.

Sintaxe da solicitação

{
   "Filters": [ 
      { 
         "Name": "string",
         "Operator": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

Parâmetros de solicitação

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

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

Filters

Você pode usar filtros de API para refinar a lista de recursos retornados porListLocations. Por exemplo, para recuperar todas as tarefas em um local de origem específico, você pode usarListLocations com o nome do filtroLocationType S3Operator Equals e.

Tipo: matriz de objetos LocationFilter

Obrigatório: não

MaxResults

O número máximo de pontos a serem retornados.

Tipo: inteiro

Faixa válida: valor mínimo de 0. Valor máximo de 100.

Obrigatório: não

NextToken

Uma sequência de caracteres opaca que indica a posição na qual começar a próxima lista de locais.

Tipo: String

Restrições de comprimento: comprimento máximo de 65535.

Padrão: [a-zA-Z0-9=_-]+

Obrigatório: não

Sintaxe da resposta

{
   "Locations": [ 
      { 
         "LocationArn": "string",
         "LocationUri": "string"
      }
   ],
   "NextToken": "string"
}

Elementos de resposta

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

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

Locations

Uma matriz que contém uma lista de locais.

Tipo: matriz de objetos LocationListEntry

NextToken

Uma sequência de caracteres opaca que indica a posição na qual começar a retornar a próxima lista de locais.

Tipo: String

Restrições de comprimento: comprimento máximo de 65535.

Padrão: [a-zA-Z0-9=_-]+

Erros

Para obter informações sobre os erros comuns a todas as ações, consulteErros comuns.

InternalException

Essa exceção é lançada quando ocorre um erro noAWS DataSync serviço.

Código de status HTTP: 500

InvalidRequestException

Essa exceção é gerada quando o cliente envia uma solicitação mal formada.

Código de status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: