X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Operation: GetItem

With the GetItem operation of the Amazon S3 DynamoDB Connector, you get a specific element from a table.

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

Parameters

keyID

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

Note:

The credentials are sent to the adapter via parameters. There are various configuration options. For more information, see Setting Up Credentials.

Possible values:

Any string with the access key ID, e.g. AKIAIOSFODNN7EXAMPLE

secretKey

Secret access key for requests to AWS

Note:

The credentials are sent to the adapter via parameters. There are various configuration options. For more information, see Setting Up Credentials.

Possible values:

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

region

Region of the domains

Note:

Buckets created in a specific region cannot be invoked from another region. For more information, see Regions and Endpoints.

Possible values:

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

tableName
✳️

This parameter is required for this operation.

Table name

Possible values:

String with the table name according to the following name rules:

  • All names must be UTF-8 encoded

  • Table names are case-sensitive

  • Table names and index names must be between 3 and 255 characters long and must contain only the following characters:

    • a-z

    • A-Z

    • 0-9

    • _ (Underscore)

    • - (Hyphen)

    • . (period)

  • Attribute names must be between 1 and 255 characters long.

partitionKey, partitionType, and partitionKeyValue
✳️

These parameters are required for this operation and must match the element to be retrieved.

Elements of the primary table key

Possible values:

  • PartitionKey: Name of the partition key

  • PartitionType: Partition type

    • S: The attribute is a string

    • N: The attribute is a number

    • B: The attribute is of the Binary type

  • PartitionKeyValue: Value of the element

sortKey, sortType, and sortKeyValue
✳️

These parameters are required for sortable keys.

Possible values:

  • SortKey: Name of the sort key

  • SortType: Sort type

    • S: The attribute is a string

    • N: The attribute is a number

    • B: The attribute is of the Binary type

  • SortKeyValue: Value of the element

readCapacityUnits, writeCapacitiyUnits

Read/Write capacity units

Possible values:

  • Integer capacity units

consistentRead

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

Status values

1

The adapter operation was executed successfully

0

The operation was not completed, but no error occurred.

-1

The operation failed due to a technical error.

Output

The adapter retrieves the specific element from the desired table and outputs data in an XML structure.

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