ListLocations - AWS DataSync

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 ceux renvoyés dans une réponse (c'est-à-dire que la réponse renvoie uniquement 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 suivante d'emplacements.

Syntaxe de la demande

{ "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, voirParamètres courants.

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

Filters

Vous pouvez utiliser des filtres d'API pour affiner la liste des ressources renvoyées parListLocations. Par exemple, pour extraire toutes les tâches sur un emplacement source spécifique, vous pouvez utiliserListLocationsavec nom de filtreLocationType S3etOperator Equals.

Type : Un tableau deLocationFilterobjets

Obligatoire Non

MaxResults

Nombre maximum d'emplacements à renvoyer.

Type : Integer

Plage valide : La valeur minimale est 0. Valeur maximale fixée à 100.

Obligatoire Non

NextToken

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

Type : Chaîne

Contraintes de longueur : Longueur maximale 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

Un tableau qui contient une liste des emplacements.

Type : Un tableau deLocationListEntryobjets

NextToken

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

Type : Chaîne

Contraintes de longueur : Longueur maximale de 65535.

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

Erreurs

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

InternalException

Cette exception est renvoyée lorsqu'une erreur se produit dans leAWS DataSyncservice.

HTTP Status Code : 500

InvalidRequestException

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

HTTP Status Code : 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 :