Container for the parameters to the Scan operation.

Retrieves one or more items and its attributes by performing a full scan of a table.

Provide a ScanFilter to get more specific results.

Namespace: Amazon.DynamoDB.Model
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class ScanRequest : AmazonWebServiceRequest
Public Class ScanRequest _
	Inherits AmazonWebServiceRequest
public ref class ScanRequest : public AmazonWebServiceRequest

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
ScanRequest()()()()
Initializes a new instance of the ScanRequest class
AttributesToGet
List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result.

Constraints:

Length
1 -

Count
If set to true, Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon DynamoDB returns a validation error.
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExclusiveStartKey
Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the Limit parameter. The LastEvaluatedKey can be passed back in a new scan request to continue the operation from that point.
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
Limit
The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the scan.

Constraints:

Range
1 -

ScanFilter
Evaluates the scan results and returns only the desired values.
TableName
The name of the table in which you want to scan. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Constraints:

Length
3 - 255
Pattern
[a-zA-Z0-9_.-]+

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
WithAttributesToGet(IEnumerable<(Of <<'(String>)>>))
Adds elements to the AttributesToGet collection
WithAttributesToGet(array<String>[]()[][])
Adds elements to the AttributesToGet collection
WithCount(Boolean)
Sets the Count property
WithExclusiveStartKey(Key)
Sets the ExclusiveStartKey property
WithLimit(Int32)
Sets the Limit property
WithScanFilter(array<KeyValuePair<(Of <<'(String, Condition>)>>)>[]()[][])
Adds the KeyValuePairs to the ScanFilter dictionary.
WithTableName(String)
Sets the TableName property

Inheritance Hierarchy

System..::..Object
  Amazon.Runtime..::..AmazonWebServiceRequest
    Amazon.DynamoDB.Model..::..ScanRequest

See Also