View a markdown version of this page

GetItem - AWS AppSync GraphQL

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.

GetItem

La GetItem requête vous permet de demander à la fonction AWS AppSync DynamoDB d'adresser une GetItem requête à DynamoDB et de spécifier :

  • La clé de l'élément dans DynamoDB

  • S'il convient d'utiliser une lecture cohérente ou non

La GetItem demande a la structure suivante :

type DynamoDBGetItem = { operation: 'GetItem'; key: { [key: string]: any }; consistentRead?: ConsistentRead; projection?: { expression: string; expressionNames?: { [key: string]: string }; }; };

Les champs sont définis comme suit :

GetItem champs

operation

L'opération DynamoDB à effectuer. Pour que vous puissiez effectuer l'opération DynamoDB GetItem, ce champ doit être défini sur GetItem. Cette valeur est obligatoire.

key

La clé de l'élément dans DynamoDB. Les éléments DynamoDB peuvent avoir une seule clé de hachage ou une clé de hachage et une clé de tri, selon la structure de la table. Pour plus d'informations sur la façon de spécifier une « valeur typée », voir Système de types (mappage des demandes). Cette valeur est obligatoire.

consistentRead

S'il faut ou non effectuer une lecture très cohérente avec DynamoDB. Ce champ est facultatif et false est la valeur définie par défaut.

projection

Projection utilisée pour spécifier les attributs à renvoyer à partir de l'opération DynamoDB. Pour plus d'informations sur les projections, voir Projections. Ce champ est facultatif.

L'élément renvoyé par DynamoDB est automatiquement converti en types primitifs GraphQL et JSON et est disponible dans le résultat contextuel (). context.result

Pour plus d'informations sur la conversion de type DynamoDB, voir Système de types (mappage des réponses).

Pour plus d'informations sur les JavaScript résolveurs, consultez la section Présentation JavaScript des résolveurs.

Exemple

L'exemple suivant est un gestionnaire de requêtes de fonction pour une requête GraphQL : getThing(foo: String!, bar: String!)

export function request(ctx) { const {foo, bar} = ctx.args return { operation : "GetItem", key : util.dynamodb.toMapValues({foo, bar}), consistentRead : true } }

Pour de plus amples informations sur l'API de DynamoDB GetItem, veuillez consulter la Documentation sur les API de DynamoDB.