« blib/lib/Paws/DynamoDB/TransactGetItem.pm
↑ Summary
blib/lib/Paws/DynamoDB/TransactGetItemsOutput.pm »
| 1 | |||
| 2 | package Paws::DynamoDB::TransactGetItems; | ||
| 3 | use Moose; | ||
| 4 | has ReturnConsumedCapacity => (is => 'ro', isa => 'Str'); | ||
| 5 | has TransactItems => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::TransactGetItem]', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TransactGetItems'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::TransactGetItemsOutput'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::DynamoDB::TransactGetItems - Arguments for method TransactGetItems on L<Paws::DynamoDB> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method TransactGetItems on the | ||
| 23 | L<Amazon DynamoDB|Paws::DynamoDB> service. Use the attributes of this class | ||
| 24 | as arguments to method TransactGetItems. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TransactGetItems. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $dynamodb = Paws->service('DynamoDB'); | ||
| 31 | my $TransactGetItemsOutput = $dynamodb->TransactGetItems( | ||
| 32 | TransactItems => [ | ||
| 33 | { | ||
| 34 | Get => { | ||
| 35 | Key => { | ||
| 36 | 'MyAttributeName' => { | ||
| 37 | B => 'BlobBinaryAttributeValue', # OPTIONAL | ||
| 38 | BOOL => 1, # OPTIONAL | ||
| 39 | BS => [ | ||
| 40 | 'BlobBinaryAttributeValue', ... # OPTIONAL | ||
| 41 | ], # OPTIONAL | ||
| 42 | L => [ <AttributeValue>, ... ], # OPTIONAL | ||
| 43 | M => { | ||
| 44 | 'MyAttributeName' => <AttributeValue>, # key: max: 65535 | ||
| 45 | }, # OPTIONAL | ||
| 46 | N => 'MyNumberAttributeValue', # OPTIONAL | ||
| 47 | NS => [ | ||
| 48 | 'MyNumberAttributeValue', ... # OPTIONAL | ||
| 49 | ], # OPTIONAL | ||
| 50 | NULL => 1, # OPTIONAL | ||
| 51 | S => 'MyStringAttributeValue', # OPTIONAL | ||
| 52 | SS => [ | ||
| 53 | 'MyStringAttributeValue', ... # OPTIONAL | ||
| 54 | ], # OPTIONAL | ||
| 55 | }, # key: max: 65535 | ||
| 56 | }, | ||
| 57 | TableName => 'MyTableName', # min: 3, max: 255 | ||
| 58 | ExpressionAttributeNames => { | ||
| 59 | 'MyExpressionAttributeNameVariable' => | ||
| 60 | 'MyAttributeName', # , value: max: 65535 | ||
| 61 | }, # OPTIONAL | ||
| 62 | ProjectionExpression => 'MyProjectionExpression', # OPTIONAL | ||
| 63 | }, | ||
| 64 | |||
| 65 | }, | ||
| 66 | ... | ||
| 67 | ], | ||
| 68 | ReturnConsumedCapacity => 'INDEXES', # OPTIONAL | ||
| 69 | ); | ||
| 70 | |||
| 71 | # Results: | ||
| 72 | my $ConsumedCapacity = $TransactGetItemsOutput->ConsumedCapacity; | ||
| 73 | my $Responses = $TransactGetItemsOutput->Responses; | ||
| 74 | |||
| 75 | # Returns a L<Paws::DynamoDB::TransactGetItemsOutput> object. | ||
| 76 | |||
| 77 | 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. | ||
| 78 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dynamodb/TransactGetItems> | ||
| 79 | |||
| 80 | =head1 ATTRIBUTES | ||
| 81 | |||
| 82 | |||
| 83 | =head2 ReturnConsumedCapacity => Str | ||
| 84 | |||
| 85 | A value of C<TOTAL> causes consumed capacity information to be | ||
| 86 | returned, and a value of C<NONE> prevents that information from being | ||
| 87 | returned. No other value is valid. | ||
| 88 | |||
| 89 | Valid values are: C<"INDEXES">, C<"TOTAL">, C<"NONE"> | ||
| 90 | |||
| 91 | =head2 B<REQUIRED> TransactItems => ArrayRef[L<Paws::DynamoDB::TransactGetItem>] | ||
| 92 | |||
| 93 | An ordered array of up to 25 C<TransactGetItem> objects, each of which | ||
| 94 | contains a C<Get> structure. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method TransactGetItems in L<Paws::DynamoDB> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |