Official |[Amazon DynamoDB] Get Item (Query)

Operation name

Get Item (Query)

Function overview

Gets items stored in an Amazon DynamoDB table.

= Remarks =

This operation uses Query API. For more details on API specifications, refer to the following page:

"Query" (http://docs.aws.amazon.com/en_us/amazondynamodb/latest/APIReference/API_Query.html)

Data model

The data model of this component is table model type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Table name	Required	Available	Select or enter a table name to be read.
Index name	Required	Available	Select or enter an index name to be read.
Attribute list	Required	-	Specify attribute list of the index specified in Index name. Added rows will be the target columns to read. Each target column can be operated with the following buttons: Up Move the selected target column upwards by one row. Down Move the selected target column downwards by one row. Add Add a target column. Delete Delete the target column.
Attribute list/Hash key	Optional	Not available	Displays whether it's a hash key attribute of the index specified in Index name or the table specified in Table name, or not.
Attribute list/Range key	Optional	Not available	Displays whether it's a range key attribute of the index specified in Index name or the table specified in Table name, or not.
Attribute list/Attribute name	Required	Available	Enter an attribute name of the table specified in Table name or the index specified in Index name.	The specified attribute name is displayed in Mapper schema.
Attribute list/Type	Required	Not available	Select the type of Attribute name.	It's displayed in "<DynamoDB data type> (<Internal data type>)" format. DynamoDB data type Data type supported by Amazon DynamoDB. Internal data type Data type used internally. For details, refer to Internal data types.
Hash key value	Required	Available	Enter the attribute value of the hash key to be specified as query.

Property actions

Item name	Description	Remarks
Update table name list	Get table names in the specified destination and set them in Table name.
Update index name list	Get indexes in the specified table and set them in Index name.
Update attribute list	Update attribute list of the index specified in Index name.	Enabled when Index name is specified. Attribute names and data types are extracted from the items gotten by executing a scan for the table specified in Table name or the index specified in Index name. When there's an attribute of unsupported DynamoDB data type in the items gotten by scanning, that attribute isn't added to the attribute list. = Remarks = For more details on the supported types, refer to Limitations of AMAZONDYNAMODB category. When there's no item in the table specified in Table name, only the primary key attribute will be set. Irrespective of the actual attribute type, String (String) will be set for the data type.

Range key settings

Item name	Required/Optional	Use of variables	Description	Remarks
Range key condition	Required	Not available	Specify the condition of the range key attribute to be specified as query. EQUAL TO (Default) Extract items where the range key is equal to the value specified in Range key value. LESS THAN Extract items where the range key is less than the value specified in Range key value. LESS THAN OR EQUAL TO Extract items where the range key is less than or equal to the value specified in Range key value. GREATER THAN Extract items where the range key is greater than the value specified in Range key value. GREATER THAN OR EQUAL TO Extract items where the range key is greater than or equal to the value specified in Range key value. BEGINS WITH Extract items where the range key of String or Binary type begins with the value specified in Range key value. BETWEEN Extract items where the range key is between Range key start value and Range key end value.
Range key value	Optional	Available	Specify the attribute value of the range key to be specified as query.
Range key start value	Optional	Available	Specify the starting value of the range key attribute to be specified as query.	Displayed when BETWEEN is selected in Range key condition.
Range key end value	Optional	Available	Specify the ending value of the range key attribute to be specified as query.	Displayed when BETWEEN is selected in Range key condition.

Read settings

Item name	Required/Optional	Use of variables	Description	Remarks
Strongly consistent read	Required	Not available	Select whether or not to perform strongly consistent read.
Skip rows where actual type and attribute list type are different	Required	Not available	Select whether to skip an item where the attribute type specified in Attribute list/Type differs from the actual type, or to treat it as an error.	The details of skipped items will be output in the script execution log.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

The number of columns varies depending on the Attribute list settings.

= Remarks =

For schema structure, refer to Table model type .

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Parallel Stream Processing

PSP is supported.

= Remarks =

For details on PSP, refer to Parallel Stream Processing.

Available component variables

Component variable name	Description	Remarks
count	The number of gotten items is stored.	The default value is null.
skip_count	The number of items skipped when the type specified in the attribute list differs from the actual type is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Amazon DynamoDB connector

Notes

When a request to Amazon DynamoDB fails due to a reason such as a connection timeout, the request will be retried 10 times.