ListLocations - AWS DataSync
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursVoir aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ListLocations

Renvoie une liste des emplacements source et de destination.

Si vous avez plus d'emplacements que ce qui est renvoyé dans une réponse (c'est-à-dire que la réponse ne renvoie qu'une liste tronquée de vos agents), la réponse contient un jeton que vous pouvez spécifier dans votre prochaine demande pour récupérer la page d'emplacements suivante.

Syntaxe de la requête

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

Paramètres de demande

Pour plus d'informations sur les paramètres communs à toutes les actions, consultez la section Paramètres communs.

Cette demande accepte les données suivantes au format JSON.

Filters

Vous pouvez utiliser des filtres d'API pour affiner la liste des ressources qui s'affichentListLocations. Par exemple, pour récupérer toutes les tâches sur un emplacement source spécifique, vous pouvez utiliserListLocations le nom du filtreLocationType S3 etOperator Equals.

Type : tableau d’objets LocationFilter

Obligatoire : non

MaxResults

Nombre maximum d'emplacements à renvoyer.

Type : entier

Plage valide : Valeur minimum de 0. Valeur maximale fixée à 100.

Obligatoire : non

NextToken

Chaîne opaque qui indique la position à laquelle commencer la liste d'emplacements suivante.

Type : String

Contraintes de longueur : Longueur maximum de 65535.

Modèle : [a-zA-Z0-9=_-]+

Obligatoire : non

Syntaxe de la réponse

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

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

Locations

Tableau contenant une liste d'emplacements.

Type : tableau d’objets LocationListEntry

NextToken

Chaîne opaque qui indique la position à laquelle commencer à renvoyer la liste d'emplacements suivante.

Type : String

Contraintes de longueur : Longueur maximum de 65535.

Modèle : [a-zA-Z0-9=_-]+

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

InternalException

Cette exception est déclenchée lorsqu'une erreur se produit dans leAWS DataSync service.

Code d'état HTTP : 500

InvalidRequestException

Cette exception est déclenchée lorsque le client soumet une demande mal formée.

Code d'état HTTP : 400

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :