Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Paws::DynamoDB::BatchGUsereContributed Perl DocPaws::DynamoDB::BatchGetItem(3)

NAME
       Paws::DynamoDB::BatchGetItem - Arguments	for method BatchGetItem	on
       Paws::DynamoDB

DESCRIPTION
       This class represents the parameters used for calling the method
       BatchGetItem on the Amazon DynamoDB service. Use	the attributes of this
       class as	arguments to method BatchGetItem.

       You shouln't make instances of this class. Each attribute should	be
       used as a named argument	in the call to BatchGetItem.

       As an example:

	 $service_obj->BatchGetItem(Att1 => $value1, Att2 => $value2, ...);

       Values for attributes that are native types (Int, String, Float,	etc)
       can passed as-is	(scalar	values). Values	for complex Types (objects)
       can be passed as	a HashRef. The keys and	values of the hashref will be
       used to instance	the underlying object.

ATTRIBUTES
   REQUIRED RequestItems => Paws::DynamoDB::BatchGetRequestMap
       A map of	one or more table names	and, for each table, a map that
       describes one or	more items to retrieve from that table.	Each table
       name can	be used	only once per BatchGetItem request.

       Each element in the map of items	to retrieve consists of	the following:

       o   ConsistentRead - If "true", a strongly consistent read is used; if
	   "false" (the	default), an eventually	consistent read	is used.

       o   ExpressionAttributeNames - One or more substitution tokens for
	   attribute names in the ProjectionExpression parameter. The
	   following are some use cases	for using ExpressionAttributeNames:

	   o   To access an attribute whose name conflicts with	a DynamoDB
	       reserved	word.

	   o   To create a placeholder for repeating occurrences of an
	       attribute name in an expression.

	   o   To prevent special characters in	an attribute name from being
	       misinterpreted in an expression.

	   Use the name. For example, consider the following attribute name:

	   o   "Percentile"

	   The name of this attribute conflicts	with a reserved	word, so it
	   cannot be used directly in an expression. (For the complete list of
	   reserved words, see Reserved	Words in the Amazon DynamoDB Developer
	   Guide).  To work around this, you could specify the following for
	   ExpressionAttributeNames:

	   o   "{""

	   You could then use this substitution	in an expression, as in	this
	   example:

	   o   ""

	   Tokens that begin with the :	character are expression attribute
	   values, which are placeholders for the actual value at runtime.

	   For more information	on expression attribute	names, see Accessing
	   Item	Attributes in the Amazon DynamoDB Developer Guide.

       o   Keys	- An array of primary key attribute values that	define
	   specific items in the table.	For each primary key, you must provide
	   all of the key attributes. For example, with	a hash type primary
	   key,	you only need to provide the hash attribute. For a hash-and-
	   range type primary key, you must provide both the hash attribute
	   and the range attribute.

       o   ProjectionExpression	- A string that	identifies one or more
	   attributes to retrieve from the table. These	attributes can include
	   scalars, sets, or elements of a JSON	document. The attributes in
	   the expression must be separated by commas.

	   If no attribute names are specified,	then all attributes will be
	   returned. If	any of the requested attributes	are not	found, they
	   will	not appear in the result.

	   For more information, see Accessing Item Attributes in the Amazon
	   DynamoDB Developer Guide.

       o   AttributesToGet -

	   This	is a legacy parameter, for backward compatibility. New
	   applications	should use ProjectionExpression	instead. Do not
	   combine legacy parameters and expression parameters in a single API
	   call; otherwise, DynamoDB will return a ValidationException
	   exception.

	   This	parameter allows you to	retrieve attributes of type List or
	   Map;	however, it cannot retrieve individual elements	within a List
	   or a	Map.

	   The names of	one or more attributes to retrieve. If no attribute
	   names are provided, then all	attributes will	be returned. If	any of
	   the requested attributes are	not found, they	will not appear	in the
	   result.

	   Note	that AttributesToGet has no effect on provisioned throughput
	   consumption.	DynamoDB determines capacity units consumed based on
	   item	size, not on the amount	of data	that is	returned to an
	   application.

   ReturnConsumedCapacity => Str
SEE ALSO
       This class forms	part of	Paws, documenting arguments for	method
       BatchGetItem in Paws::DynamoDB

BUGS and CONTRIBUTIONS
       The source code is located here:	https://github.com/pplu/aws-sdk-perl

       Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

POD ERRORS
       Hey! The	above document had some	coding errors, which are explained
       below:

       Around line 79:
	   Unterminated	B<...> sequence

       Around line 98:
	   Unterminated	C<...> sequence

       Around line 109:
	   Unterminated	C<...> sequence

perl v5.24.1			  2015-08-06   Paws::DynamoDB::BatchGetItem(3)

NAME | DESCRIPTION | ATTRIBUTES | SEE ALSO | BUGS and CONTRIBUTIONS | POD ERRORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Paws::DynamoDB::BatchGetItem&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help