X4 Produktdokumentation

Operation: BatchGetMultipleItems

Withh the BatchGetMultipleItems operation of the Amazon S3 DynamoDB Connector, you call multiplple elements dependinng on thhe values alues of partitionKey specifiedd in an XML file.

All elements ars are rettrieved withh all element attributes.

For more information on other operations of the Amazon S3 DynamoDB Connector, , see Amazon S3 DynamoDB Connector.

Parameterss

keyID

Access k key ID for requests to Amazon Web Services (AWS (AWS)

Note:

The credentials are sentt to the adapter vivia parameters.s. There are variouious configuration optionss. For more information, s, see Setting Up Credentialstials.

Possible valuess:

Any string withh the access k key ID, e.g. AKIAIOSFODNN7EXAMPLE

secretKey

Secret access k key for requests to AWS

Note:

The credentialstials are sentt to the adapter vivia parameters. There are various configuration optionss. For more information, s, see Setting Up Cg Up Credentialstials.

Possible valuess:

Any string with the seccret access k key, e.g. wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

region

Region of the domains

Note:

Buckets createdated in a spa speccific region cannot be invoked fd fromom another region.. For more information, see Regions and Endpoints.

Possible valuess:

Any string with the name of the region, e.g. us-east-2

tableName

✳️

This parameter is rrequiquired for this operation.

Table name

Possible valuess:

String withh the table name according to tcording to thee followingg name rules:

  • All names must be UTF-8 encoded

  • Table names are case-e-sensitivive

  • Table names and index names must be between 3 and 255 charactaracters lors longg and mumust contain only the followingg characters:

    • a-z

    • A-Z

    • 0-9

    • _ (Underscore)

    • - (Hyphen)

    • . (period)

  • Attribute e names must bt be between 1 and 255 charactaracters long.

partitionKey, partitionType,, and partitionKeyValue

✳️

These parameters arare required for this operation and must matchch the elements to be retrrieved.

Elements of the primary table key

Possible valuess:

  • PartitionKey: Name of the partition key

  • PartitionType: Partition typee

    • S: The attributee is a string

    • N: The attributee is a numbumber

    • B: The attributee is of the Binary typey type

  • PartitionKeyValue: Value of thehe element

sortKey, sortType,, and sortKeyValue

✳️

These parameterss are required for sortable kkeys.

Elements of the primary table key

Possible valuess:

  • SortKey: Name of the sort key

  • SortType: Sort typee

    • S: The attributee is a string

    • N: The attributee is a numbumber

    • B: The attributee is of the Binary typey type

  • SortKeyValue: Value of the element

readCapacityUnits, writeCapacitiyUnits

Read/Write capacity units

Possible valuess:

  • Integer capacity units

consistentRead

DynamoDB uses eventually consistent reads unlesunless otherwise specified. Read ad operations such as GetItem and Query provide a ConsistentRead parameter. If this parameter is set to true, DynamoDB uses strongly consistent reads during operation during operation.

Status values

1

The adapterr operation was executed succesccessfully

0

The operation was not completed, but no error occurred.

-1

The operation fafailed due too a technical error.

Input

The adapter expecctss a preedefined XML structuree as input.

Note:

Primary keys can be specified fod for different objects. If the object matches a table in whwhich oonly partitionKey is is defined, only partitionKey ccan be specified. Otherwise,e, partitionKey and SortKey can be specified can be specified.

<?xml version="1.0" encoding="UTF-8" ?>
<PrimaryKeyValues>
	<PrimaryKey partitionKey="2" SortKey="Carlos" />
	<PrimaryKey partitionKey="5" SortKey="Luis" />
</PrimaryKeyValues>

Output

The adapter retrievesrieves the specific element from the desired table and outputss data in an XML structure.

An Item element including fields for the primary key and the associateassociated v values is creaeated for each element. Within the Item element, therehere is a list of the respectespective attributess.

<?xml version="1.0" encoding="UTF-8" ?>
<Result>
	<Item partitionKey="ID" partitionKeyValue="5" SortKey="Name" SortKeyValue="Luis">
	<Attribute type="MAP" name="Cars">
			<Attribute type="N" name="Phone" value="637559681" />
			<Attribute type="BOOL" name="Bonus" value="true" />
			<Attribute type="B" name="DocumentCode" value="qwrqfgdas1223455sdfffr" />
	<Attribute type="S" name="Profession" value="Programmer" />
	</Attribute>
		<Attribute type="N" name="Phone" value="34666777888" />
	<Attribute type="LIST" name="Colours">
			<Attribute type="S" value="Red" />
			<Attribute type="S" value="Green" />
	<Attribute type="S" value="Blue" />
			<Attribute type="MAP" name="Colours">
				<Attribute type="N" name="Phone" value="637559681" />
				<Attribute type="BOOL" name="Bonus" value="true" />
				<Attribute type="B" name="DocumentCode" value="qwrqfgdas1223455sdfffr" />
				<Attribute type="S" name="Profession" value="Programmer" />
	</Attribute>
	</Attribute>
		<Attribute type="BOOL" name="Bonus" value="true" />
	</Item>
	<Item partitionKey="ID" partitionKeyValue="2" SortKey="Name" SortKeyValue="Carlos">
		<Attribute type="S" name="Address" value="Pirandello" />
		<Attribute type="N" name="Phone" value="637559681" />
		<Attribute type="BOOL" name="Bonus" value="true" />
	<Attribute type="B" name="DocumentCode" value="qwrqfgdas1223455sdfffr" />
		<Attribute type="S" name="Surname" value="Delgado" />
		<Attribute type="S" name="Profession" value="Programmer" />
	</Item>
</Result>