このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Return one or more items and item attributes by accessing every item in a table. To have DynamoDB return fewer items, you can provide a filterExpression input.

Inputs

フィールド

種類

説明

region [required]

enum

default: us-east-1

tableName [required]

string

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

filterExpression

string

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned. Read more about Filter expressions here.

expressionAttributeNames

object

One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name.

expressionAttributeValues

object

One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value.

attributes

string

A string that identifies one or more attributes to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, all attributes are returned.

limit

number

The maximum number of items to evaluate (not necessarily the number of matching items).

consistentRead

boolean

A Boolean value that determines the read consistency model during the scan.

Outputs

Expand All

フィールド

種類

説明

Items

[object]

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

Count

number

The number of items in the response. If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied. If you did not use a filter in the request, then Count is the same as ScannedCount.

ScannedCount

number

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide. If you did not use a filter in the request, then ScannedCount is the same as Count.

LastEvaluatedKey

object

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

ConsumedCapacity

object

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

TableName

string

The name of the table that was affected by the operation.

CapacityUnits

number

The total number of capacity units consumed by the operation.

ReadCapacityUnits

number

The total number of read capacity units consumed by the operation.

WriteCapacityUnits

number

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Table

object

The amount of throughput consumed on the table affected by the operation.

ReadCapacityUnits

number

The total number of read capacity units consumed on a table or an index.

WriteCapacityUnits

number

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

CapacityUnits

number

The total number of capacity units consumed on a table or an index.

LocalSecondaryIndexes

object

The amount of throughput consumed on each local index affected by the operation.

GlobalSecondaryIndexes

object

The amount of throughput consumed on each global index affected by the operation.

amzRequestId [required]

string