package Paws::DynamoDB::Scan; use Moose; has AttributesToGet => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); has ConditionalOperator => (is => 'ro', isa => 'Str'); has ConsistentRead => (is => 'ro', isa => 'Bool'); has ExclusiveStartKey => (is => 'ro', isa => 'Paws::DynamoDB::Key'); has ExpressionAttributeNames => (is => 'ro', isa => 'Paws::DynamoDB::ExpressionAttributeNameMap'); has ExpressionAttributeValues => (is => 'ro', isa => 'Paws::DynamoDB::ExpressionAttributeValueMap'); has FilterExpression => (is => 'ro', isa => 'Str'); has IndexName => (is => 'ro', isa => 'Str'); has Limit => (is => 'ro', isa => 'Int'); has ProjectionExpression => (is => 'ro', isa => 'Str'); has ReturnConsumedCapacity => (is => 'ro', isa => 'Str'); has ScanFilter => (is => 'ro', isa => 'Paws::DynamoDB::FilterConditionMap'); has Segment => (is => 'ro', isa => 'Int'); has Select => (is => 'ro', isa => 'Str'); has TableName => (is => 'ro', isa => 'Str', required => 1); has TotalSegments => (is => 'ro', isa => 'Int'); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'Scan'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::ScanOutput'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::DynamoDB::Scan - Arguments for method Scan on L =head1 DESCRIPTION This class represents the parameters used for calling the method Scan on the L service. Use the attributes of this class as arguments to method Scan. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Scan. =head1 SYNOPSIS my $dynamodb = Paws->service('DynamoDB'); # To scan a table # This example scans the entire Music table, and then narrows the results to # songs by the artist "No One You Know". For each item, only the album title and # song title are returned. my $ScanOutput = $dynamodb->Scan( 'ExpressionAttributeNames' => { '#AT' => 'AlbumTitle', '#ST' => 'SongTitle' }, 'ExpressionAttributeValues' => { ':a' => { 'S' => 'No One You Know' } }, 'FilterExpression' => 'Artist = :a', 'ProjectionExpression' => '#ST, #AT', 'TableName' => 'Music' ); # Results: my $ConsumedCapacity = $ScanOutput->ConsumedCapacity; my $Count = $ScanOutput->Count; my $Items = $ScanOutput->Items; my $ScannedCount = $ScanOutput->ScannedCount; # Returns a L object. Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 AttributesToGet => ArrayRef[Str|Undef] This is a legacy parameter. Use C instead. For more information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) in the I. =head2 ConditionalOperator => Str This is a legacy parameter. Use C instead. For more information, see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the I. Valid values are: C<"AND">, C<"OR"> =head2 ConsistentRead => Bool A Boolean value that determines the read consistency model during the scan: =over =item * If C is C, then the data returned from C might not contain the results from other recently completed write operations (C, C, or C). =item * If C is C, then all of the write operations that completed before the C began are guaranteed to be contained in the C response. =back The default setting for C is C. The C parameter is not supported on global secondary indexes. If you scan a global secondary index with C set to true, you will receive a C. =head2 ExclusiveStartKey => L The primary key of the first item that this operation will evaluate. Use the value that was returned for C in the previous operation. The data type for C must be String, Number or Binary. No set data types are allowed. In a parallel scan, a C request that includes C must specify the same segment whose previous C returned the corresponding value of C. =head2 ExpressionAttributeNames => L One or more substitution tokens for attribute names in an expression. The following are some use cases for using C: =over =item * To access an attribute whose name conflicts with a DynamoDB reserved word. =item * To create a placeholder for repeating occurrences of an attribute name in an expression. =item * To prevent special characters in an attribute name from being misinterpreted in an expression. =back Use the B<#> character in an expression to dereference an attribute name. For example, consider the following attribute name: =over =item * C =back The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the I). To work around this, you could specify the following for C: =over =item * C<{"#P":"Percentile"}> =back You could then use this substitution in an expression, as in this example: =over =item * C<#P = :val> =back Tokens that begin with the B<:> character are I, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the I. =head2 ExpressionAttributeValues => L One or more values that can be substituted in an expression. Use the B<:> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the C attribute was one of the following: C You would first need to specify C as follows: C<{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }> You could then use these values in an expression, such as this: C For more information on expression attribute values, see Condition Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the I. =head2 FilterExpression => Str A string that contains conditions that DynamoDB applies after the C operation, but before the data is returned to you. Items that do not satisfy the C criteria are not returned. A C is applied after the items have already been read; the process of filtering does not consume any additional read capacity units. For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults) in the I. =head2 IndexName => Str The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the C parameter, you must also provide C. =head2 Limit => Int The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in C to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in C to apply in a subsequent operation to continue the operation. For more information, see Working with Queries (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) in the I. =head2 ProjectionExpression => Str A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the I. =head2 ReturnConsumedCapacity => Str Valid values are: C<"INDEXES">, C<"TOTAL">, C<"NONE"> =head2 ScanFilter => L This is a legacy parameter. Use C instead. For more information, see ScanFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html) in the I. =head2 Segment => Int For a parallel C request, C identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a C value of 0, the second thread specifies 1, and so on. The value of C returned from a parallel C request must be used as C with the same segment ID in a subsequent C operation. The value for C must be greater than or equal to 0, and less than the value provided for C. If you provide C, you must also provide C. =head2 Select => Str The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. =over =item * C - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. =item * C - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying C. =item * C - Returns the number of matching items, rather than the matching items themselves. =item * C - Returns only the attributes listed in C. This return value is equivalent to specifying C without specifying any value for C nor C are specified, DynamoDB defaults to C when accessing a table, and C when accessing an index. You cannot use both C is C. (This usage is equivalent to specifying C without any value for C can only be C. Any other value for C