Class: Aws::DynamoDB::Types::ConsumedCapacity

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

The capacity units consumed by an 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 request asked for it. For more information, see [Provisioned Throughput] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_units ⇒ Float

The total number of capacity units consumed by the operation.

Returns:

  • (Float) 


1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1471

class ConsumedCapacity < Struct.new(
  :table_name,
  :capacity_units,
  :read_capacity_units,
  :write_capacity_units,
  :table,
  :local_secondary_indexes,
  :global_secondary_indexes)
  include Aws::Structure
end

#global_secondary_indexes ⇒ Hash<String,Types::Capacity>

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

Returns:



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1471

class ConsumedCapacity < Struct.new(
  :table_name,
  :capacity_units,
  :read_capacity_units,
  :write_capacity_units,
  :table,
  :local_secondary_indexes,
  :global_secondary_indexes)
  include Aws::Structure
end

#local_secondary_indexes ⇒ Hash<String,Types::Capacity>

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

Returns:



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1471

class ConsumedCapacity < Struct.new(
  :table_name,
  :capacity_units,
  :read_capacity_units,
  :write_capacity_units,
  :table,
  :local_secondary_indexes,
  :global_secondary_indexes)
  include Aws::Structure
end

#read_capacity_units ⇒ Float

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

Returns:

  • (Float) 


1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1471

class ConsumedCapacity < Struct.new(
  :table_name,
  :capacity_units,
  :read_capacity_units,
  :write_capacity_units,
  :table,
  :local_secondary_indexes,
  :global_secondary_indexes)
  include Aws::Structure
end

#table ⇒ Types::Capacity

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

Returns:



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1471

class ConsumedCapacity < Struct.new(
  :table_name,
  :capacity_units,
  :read_capacity_units,
  :write_capacity_units,
  :table,
  :local_secondary_indexes,
  :global_secondary_indexes)
  include Aws::Structure
end

#table_name ⇒ String

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

Returns:

  • (String) 


1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1471

class ConsumedCapacity < Struct.new(
  :table_name,
  :capacity_units,
  :read_capacity_units,
  :write_capacity_units,
  :table,
  :local_secondary_indexes,
  :global_secondary_indexes)
  include Aws::Structure
end

#write_capacity_units ⇒ Float

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

Returns:

  • (Float) 


1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1471

class ConsumedCapacity < Struct.new(
  :table_name,
  :capacity_units,
  :read_capacity_units,
  :write_capacity_units,
  :table,
  :local_secondary_indexes,
  :global_secondary_indexes)
  include Aws::Structure
end