aws_erin v0.4.2 AwsErin.DynamoDB View Source

Documentation for DynamoDB.

Link to this section Summary

Link to this section Functions

Link to this function

batch_get_item(request, options \\ [])

View Source
batch_get_item(
  %AwsErin.DynamoDB.BatchGetItem.Request{
    request_items: term(),
    return_consumed_capacity: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.BatchGetItem.Response{
     consumed_capacity: term(),
     responses: term(),
     unprocessed_keys: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

BatchGetItem.

Link to this function

batch_write_item(request, options \\ [])

View Source
batch_write_item(
  %AwsErin.DynamoDB.BatchWriteItem.Request{
    request_items: term(),
    return_consumed_capacity: term(),
    return_item_collection_metrics: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.BatchWriteItem.Response{
     consumed_capacity: term(),
     item_collection_metrics: term(),
     unprocessed_items: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

BatchWriteItem.

Link to this function

delete_item(request, options \\ [])

View Source
delete_item(
  %AwsErin.DynamoDB.DeleteItem.Request{
    condition_expression: term(),
    expression_attribute_names: term(),
    expression_attribute_values: term(),
    key: term(),
    return_consumed_capacity: term(),
    return_item_collection_metrics: term(),
    return_values: term(),
    table_name: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.DeleteItem.Response{
     attributes: term(),
     consumed_capacity: term(),
     item_collection_metrics: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

DeleteItem.

Link to this function

get_item(request, options \\ [])

View Source
get_item(
  %AwsErin.DynamoDB.GetItem.Request{
    consistent_read: term(),
    expression_attribute_names: term(),
    key: term(),
    projection_expression: term(),
    return_consumed_capacity: term(),
    table_name: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.GetItem.Response{consumed_capacity: term(), item: term()}}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

GetItem.

Link to this function

put_item(request, options \\ [])

View Source
put_item(
  %AwsErin.DynamoDB.PutItem.Request{
    condition_expression: term(),
    expression_attribute_names: term(),
    expression_attribute_values: term(),
    item: term(),
    return_consumed_capacity: term(),
    return_item_collection_metrics: term(),
    return_values: term(),
    table_name: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.PutItem.Response{
     attributes: term(),
     consumed_capacity: term(),
     item_collection_metrics: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

PutItem.

Link to this function

query(request, options \\ [])

View Source
query(
  %AwsErin.DynamoDB.Query.Request{
    consistent_read: term(),
    exclusive_start_key: term(),
    expression_attribute_names: term(),
    expression_attribute_values: term(),
    filter_expression: term(),
    index_name: term(),
    key_condition_expression: term(),
    limit: term(),
    projection_expression: term(),
    return_consumed_capacity: term(),
    scan_index_forward: term(),
    select: term(),
    table_name: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.Query.Response{
     consumed_capacity: term(),
     count: term(),
     items: term(),
     last_evaluated_key: term(),
     scanned_count: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

Query.

Link to this function

query_all(request, options \\ [])

View Source
query_all(
  %AwsErin.DynamoDB.Query.Request{
    consistent_read: term(),
    exclusive_start_key: term(),
    expression_attribute_names: term(),
    expression_attribute_values: term(),
    filter_expression: term(),
    index_name: term(),
    key_condition_expression: term(),
    limit: term(),
    projection_expression: term(),
    return_consumed_capacity: term(),
    scan_index_forward: term(),
    select: term(),
    table_name: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.Query.Response{
     consumed_capacity: term(),
     count: term(),
     items: term(),
     last_evaluated_key: term(),
     scanned_count: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

QueryAll.

Link to this function

scan(request, options \\ [])

View Source
scan(
  %AwsErin.DynamoDB.Scan.Request{
    consistent_read: term(),
    exclusive_start_key: term(),
    expression_attribute_names: term(),
    expression_attribute_values: term(),
    filter_expression: term(),
    index_name: term(),
    limit: term(),
    projection_expression: term(),
    return_consumed_capacity: term(),
    segment: term(),
    select: term(),
    table_name: term(),
    total_segments: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.Scan.Response{
     consumed_capacity: term(),
     count: term(),
     items: term(),
     last_evaluated_key: term(),
     scanned_count: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

Scan.

Link to this function

scan_all(request, options \\ [])

View Source
scan_all(
  %AwsErin.DynamoDB.Scan.Request{
    consistent_read: term(),
    exclusive_start_key: term(),
    expression_attribute_names: term(),
    expression_attribute_values: term(),
    filter_expression: term(),
    index_name: term(),
    limit: term(),
    projection_expression: term(),
    return_consumed_capacity: term(),
    segment: term(),
    select: term(),
    table_name: term(),
    total_segments: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.Scan.Response{
     consumed_capacity: term(),
     count: term(),
     items: term(),
     last_evaluated_key: term(),
     scanned_count: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

ScanAll.

Link to this function

update_item(request, options \\ [])

View Source
update_item(
  %AwsErin.DynamoDB.UpdateItem.Request{
    condition_expression: term(),
    expression_attribute_names: term(),
    expression_attribute_values: term(),
    key: term(),
    return_consumed_capacity: term(),
    return_item_collection_metrics: term(),
    return_values: term(),
    table_name: term(),
    update_expression: term()
  },
  keyword()
) ::
  {:ok,
   %AwsErin.DynamoDB.UpdateItem.Response{
     attributes: term(),
     consumed_capacity: term(),
     item_collection_metrics: term()
   }}
  | {:error, %AwsErin.DynamoDB.Error{message: term()}}

UpdateItem.