Skip to content

/AWS1/CL_DYNBATCHGETITEMOUTPUT

Represents the output of a BatchGetItem operation.

CONSTRUCTOR

IMPORTING

Optional arguments:

it_responses TYPE /AWS1/CL_DYNATTRIBUTEVALUE=>TT_BATCHGETRESPONSEMAP TT_BATCHGETRESPONSEMAP

A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

it_unprocessedkeys TYPE /AWS1/CL_DYNKEYSANDATTRIBUTES=>TT_BATCHGETREQUESTMAP TT_BATCHGETREQUESTMAP

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

  • Keys - An array of primary key attribute values that define specific items in the table.

  • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

  • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

it_consumedcapacity TYPE /AWS1/CL_DYNCONSUMEDCAPACITY=>TT_CONSUMEDCAPACITYMULTIPLE TT_CONSUMEDCAPACITYMULTIPLE

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.

Queryable Attributes

Responses

A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

Accessible with the following methods

Method Description
GET_RESPONSES() Getter for RESPONSES, with configurable default
ASK_RESPONSES() Getter for RESPONSES w/ exceptions if field has no value
HAS_RESPONSES() Determine if RESPONSES has a value

UnprocessedKeys

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

  • Keys - An array of primary key attribute values that define specific items in the table.

  • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

  • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

Accessible with the following methods

Method Description
GET_UNPROCESSEDKEYS() Getter for UNPROCESSEDKEYS, with configurable default
ASK_UNPROCESSEDKEYS() Getter for UNPROCESSEDKEYS w/ exceptions if field has no val
HAS_UNPROCESSEDKEYS() Determine if UNPROCESSEDKEYS has a value

ConsumedCapacity

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.

Accessible with the following methods

Method Description
GET_CONSUMEDCAPACITY() Getter for CONSUMEDCAPACITY, with configurable default
ASK_CONSUMEDCAPACITY() Getter for CONSUMEDCAPACITY w/ exceptions if field has no va
HAS_CONSUMEDCAPACITY() Determine if CONSUMEDCAPACITY has a value