DescribeAddresses - AWS Snowball
Syntaxe de la demandeParamè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.

DescribeAddresses

Renvoie un nombre spécifié d'ADDRESSobjets. L'appel de cette API dans l'une des régions américaines renvoie les adresses de la liste de toutes les adresses associées à ce compte dans toutes les régions américaines.

Syntaxe de la demande

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

MaxResults

Le nombre d'ADDRESSobjets à renvoyer.

Type : Entier

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

Obligatoire Non

NextToken

Les requêtes HTTP sont sans état. Identifier quel objet vient « suivant » dans la liste desADDRESS, vous pouvez spécifier une valeur pourNextTokencomme point de départ pour votre liste d'adresses renvoyées.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 1024.

Modèle : .*

Obligatoire Non

Syntaxe de la réponse

{
   "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"
      }
   ],
   "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.

Addresses

Les adresses d'expédition de l'appareil Snow créées pour ce compte.

Type : Tableau d'Addressobjets

NextToken

Les requêtes HTTP sont sans état. Si vous utilisez le module généré automatiquementNextTokenvaleur dans votre prochainDescribeAddressesappel, la liste des adresses renvoyées commencera à partir de ce point de la baie.

Type : Chaîne

Contraintes de longueur : Longueur minimale de 1. Longueur maximum de 1024.

Modèle : .*

Erreurs

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

InvalidNextTokenException

LeNextTokenchaîne a été modifiée de façon inattendue et l'opération s'est arrêtée. Exécutez l'opération sans modifier leNextTokenString et réessayez.

Code d'état HTTP : 400

InvalidResourceException

La ressource spécifiée n'est pas trouvée. Vérifiez les informations que vous avez fournies dans votre dernière demande et réessayez.

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 :