# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.DynamoDB do
@moduledoc """
Amazon DynamoDB
Amazon DynamoDB is a fully managed NoSQL database service that provides fast
and predictable performance with seamless scalability.
DynamoDB lets you
offload the administrative burdens of operating and scaling a distributed
database, so
that you don't have to worry about hardware provisioning, setup and
configuration,
replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve
any amount of data, and serve any level of request traffic. You can scale up or
scale
down your tables' throughput capacity without downtime or performance
degradation, and
use the Amazon Web Services Management Console to monitor resource utilization
and performance
metrics.
DynamoDB automatically spreads the data and traffic for your tables over
a sufficient number of servers to handle your throughput and storage
requirements, while
maintaining consistent and fast performance. All of your data is stored on solid
state
disks (SSDs) and automatically replicated across multiple Availability Zones in
an
Amazon Web Services Region, providing built-in high availability and data
durability.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
auto_scaling_settings_update() :: %{
"AutoScalingDisabled" => boolean(),
"AutoScalingRoleArn" => String.t() | atom(),
"MaximumUnits" => float(),
"MinimumUnits" => float(),
"ScalingPolicyUpdate" => auto_scaling_policy_update()
}
"""
@type auto_scaling_settings_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_table_output() :: %{
"TableDescription" => table_description()
}
"""
@type delete_table_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
item_response() :: %{
"Item" => map()
}
"""
@type item_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replicated_write_conflict_exception() :: %{
"message" => String.t() | atom()
}
"""
@type replicated_write_conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_limits_output() :: %{
"AccountMaxReadCapacityUnits" => float(),
"AccountMaxWriteCapacityUnits" => float(),
"TableMaxReadCapacityUnits" => float(),
"TableMaxWriteCapacityUnits" => float()
}
"""
@type describe_limits_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
source_table_feature_details() :: %{
"GlobalSecondaryIndexes" => list(global_secondary_index_info()),
"LocalSecondaryIndexes" => list(local_secondary_index_info()),
"SSEDescription" => sse_description(),
"StreamDescription" => stream_specification(),
"TimeToLiveDescription" => time_to_live_description()
}
"""
@type source_table_feature_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sse_description() :: %{
"InaccessibleEncryptionDateTime" => non_neg_integer(),
"KMSMasterKeyArn" => String.t() | atom(),
"SSEType" => list(any()),
"Status" => list(any())
}
"""
@type sse_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_global_tables_input() :: %{
optional("ExclusiveStartGlobalTableName") => String.t() | atom(),
optional("Limit") => integer(),
optional("RegionName") => String.t() | atom()
}
"""
@type list_global_tables_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_global_table_witness_group_member_action() :: %{
"RegionName" => String.t() | atom()
}
"""
@type create_global_table_witness_group_member_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
auto_scaling_policy_update() :: %{
"PolicyName" => String.t() | atom(),
"TargetTrackingScalingPolicyConfiguration" => auto_scaling_target_tracking_scaling_policy_configuration_update()
}
"""
@type auto_scaling_policy_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_table_input() :: %{
required("TableName") => String.t() | atom()
}
"""
@type describe_table_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_global_secondary_index_action() :: %{
"IndexName" => String.t() | atom(),
"OnDemandThroughput" => on_demand_throughput(),
"ProvisionedThroughput" => provisioned_throughput(),
"WarmThroughput" => warm_throughput()
}
"""
@type update_global_secondary_index_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
auto_scaling_target_tracking_scaling_policy_configuration_update() :: %{
"DisableScaleIn" => boolean(),
"ScaleInCooldown" => integer(),
"ScaleOutCooldown" => integer(),
"TargetValue" => float()
}
"""
@type auto_scaling_target_tracking_scaling_policy_configuration_update() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
update_table_output() :: %{
"TableDescription" => table_description()
}
"""
@type update_table_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
consumed_capacity() :: %{
"CapacityUnits" => float(),
"GlobalSecondaryIndexes" => map(),
"LocalSecondaryIndexes" => map(),
"ReadCapacityUnits" => float(),
"Table" => capacity(),
"TableName" => String.t() | atom(),
"WriteCapacityUnits" => float()
}
"""
@type consumed_capacity() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_global_table_output() :: %{
"GlobalTableDescription" => global_table_description()
}
"""
@type update_global_table_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_item_input() :: %{
optional("ReturnConsumedCapacity") => list(any()),
required("RequestItems") => map()
}
"""
@type batch_get_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_of_resource_input() :: %{
optional("NextToken") => String.t() | atom(),
required("ResourceArn") => String.t() | atom()
}
"""
@type list_tags_of_resource_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_global_secondary_index_settings_update() :: %{
"IndexName" => String.t() | atom(),
"ProvisionedReadCapacityAutoScalingSettingsUpdate" => auto_scaling_settings_update(),
"ProvisionedReadCapacityUnits" => float()
}
"""
@type replica_global_secondary_index_settings_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transact_get_items_output() :: %{
"ConsumedCapacity" => list(consumed_capacity()),
"Responses" => list(item_response())
}
"""
@type transact_get_items_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_global_secondary_index_action() :: %{
"IndexName" => String.t() | atom()
}
"""
@type delete_global_secondary_index_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transaction_conflict_exception() :: %{
"message" => String.t() | atom()
}
"""
@type transaction_conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_global_table_output() :: %{
"GlobalTableDescription" => global_table_description()
}
"""
@type describe_global_table_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
execute_statement_output() :: %{
"ConsumedCapacity" => consumed_capacity(),
"Items" => list(map()),
"LastEvaluatedKey" => map(),
"NextToken" => String.t() | atom()
}
"""
@type execute_statement_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_table_to_point_in_time_input() :: %{
optional("ClientToken") => String.t() | atom(),
optional("ExportFormat") => list(any()),
optional("ExportTime") => non_neg_integer(),
optional("ExportType") => list(any()),
optional("IncrementalExportSpecification") => incremental_export_specification(),
optional("S3BucketOwner") => String.t() | atom(),
optional("S3Prefix") => String.t() | atom(),
optional("S3SseAlgorithm") => list(any()),
optional("S3SseKmsKeyId") => String.t() | atom(),
required("S3Bucket") => String.t() | atom(),
required("TableArn") => String.t() | atom()
}
"""
@type export_table_to_point_in_time_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_secondary_index_description() :: %{
"Backfilling" => boolean(),
"IndexArn" => String.t() | atom(),
"IndexName" => String.t() | atom(),
"IndexSizeBytes" => float(),
"IndexStatus" => list(any()),
"ItemCount" => float(),
"KeySchema" => list(key_schema_element()),
"OnDemandThroughput" => on_demand_throughput(),
"Projection" => projection(),
"ProvisionedThroughput" => provisioned_throughput_description(),
"WarmThroughput" => global_secondary_index_warm_throughput_description()
}
"""
@type global_secondary_index_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replication_group_update() :: %{
"Create" => create_replication_group_member_action(),
"Delete" => delete_replication_group_member_action(),
"Update" => update_replication_group_member_action()
}
"""
@type replication_group_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_get_item_output() :: %{
"ConsumedCapacity" => list(consumed_capacity()),
"Responses" => map(),
"UnprocessedKeys" => map()
}
"""
@type batch_get_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_item_output() :: %{
"Attributes" => map(),
"ConsumedCapacity" => consumed_capacity(),
"ItemCollectionMetrics" => item_collection_metrics()
}
"""
@type put_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
index_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type index_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provisioned_throughput_description() :: %{
"LastDecreaseDateTime" => non_neg_integer(),
"LastIncreaseDateTime" => non_neg_integer(),
"NumberOfDecreasesToday" => float(),
"ReadCapacityUnits" => float(),
"WriteCapacityUnits" => float()
}
"""
@type provisioned_throughput_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
contributor_insights_summary() :: %{
"ContributorInsightsMode" => list(any()),
"ContributorInsightsStatus" => list(any()),
"IndexName" => String.t() | atom(),
"TableName" => String.t() | atom()
}
"""
@type contributor_insights_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => String.t() | atom(),
"throttlingReasons" => list(throttling_reason())
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
scan_output() :: %{
"ConsumedCapacity" => consumed_capacity(),
"Count" => integer(),
"Items" => list(map()),
"LastEvaluatedKey" => map(),
"ScannedCount" => integer()
}
"""
@type scan_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
backup_description() :: %{
"BackupDetails" => backup_details(),
"SourceTableDetails" => source_table_details(),
"SourceTableFeatureDetails" => source_table_feature_details()
}
"""
@type backup_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_global_table_settings_input() :: %{
required("GlobalTableName") => String.t() | atom()
}
"""
@type describe_global_table_settings_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
endpoint() :: %{
"Address" => String.t() | atom(),
"CachePeriodInMinutes" => float()
}
"""
@type endpoint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_table_input() :: %{
optional("AttributeDefinitions") => list(attribute_definition()),
optional("BillingMode") => list(any()),
optional("DeletionProtectionEnabled") => boolean(),
optional("GlobalSecondaryIndexes") => list(global_secondary_index()),
optional("GlobalTableSettingsReplicationMode") => list(any()),
optional("GlobalTableSourceArn") => String.t() | atom(),
optional("KeySchema") => list(key_schema_element()),
optional("LocalSecondaryIndexes") => list(local_secondary_index()),
optional("OnDemandThroughput") => on_demand_throughput(),
optional("ProvisionedThroughput") => provisioned_throughput(),
optional("ResourcePolicy") => String.t() | atom(),
optional("SSESpecification") => sse_specification(),
optional("StreamSpecification") => stream_specification(),
optional("TableClass") => list(any()),
optional("Tags") => list(tag()),
optional("WarmThroughput") => warm_throughput(),
required("TableName") => String.t() | atom()
}
"""
@type create_table_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_conflict_exception() :: %{
"message" => String.t() | atom()
}
"""
@type import_conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_contributor_insights_input() :: %{
optional("ContributorInsightsMode") => list(any()),
optional("IndexName") => String.t() | atom(),
required("ContributorInsightsAction") => list(any()),
required("TableName") => String.t() | atom()
}
"""
@type update_contributor_insights_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_time_to_live_output() :: %{
"TimeToLiveSpecification" => time_to_live_specification()
}
"""
@type update_time_to_live_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
restore_table_from_backup_input() :: %{
optional("BillingModeOverride") => list(any()),
optional("GlobalSecondaryIndexOverride") => list(global_secondary_index()),
optional("LocalSecondaryIndexOverride") => list(local_secondary_index()),
optional("OnDemandThroughputOverride") => on_demand_throughput(),
optional("ProvisionedThroughputOverride") => provisioned_throughput(),
optional("SSESpecificationOverride") => sse_specification(),
required("BackupArn") => String.t() | atom(),
required("TargetTableName") => String.t() | atom()
}
"""
@type restore_table_from_backup_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_endpoint_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type invalid_endpoint_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"Key" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_kinesis_streaming_destination_input() :: %{
required("TableName") => String.t() | atom()
}
"""
@type describe_kinesis_streaming_destination_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contributor_insights_output() :: %{
"ContributorInsightsSummaries" => list(contributor_insights_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_contributor_insights_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sse_specification() :: %{
"Enabled" => boolean(),
"KMSMasterKeyId" => String.t() | atom(),
"SSEType" => list(any())
}
"""
@type sse_specification() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_contributor_insights_output() :: %{
"ContributorInsightsMode" => list(any()),
"ContributorInsightsStatus" => list(any()),
"IndexName" => String.t() | atom(),
"TableName" => String.t() | atom()
}
"""
@type update_contributor_insights_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
restore_table_to_point_in_time_output() :: %{
"TableDescription" => table_description()
}
"""
@type restore_table_to_point_in_time_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
limit_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_continuous_backups_input() :: %{
required("TableName") => String.t() | atom()
}
"""
@type describe_continuous_backups_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_table_output() :: %{
"ImportTableDescription" => import_table_description()
}
"""
@type import_table_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_secondary_index() :: %{
"IndexName" => String.t() | atom(),
"KeySchema" => list(key_schema_element()),
"OnDemandThroughput" => on_demand_throughput(),
"Projection" => projection(),
"ProvisionedThroughput" => provisioned_throughput(),
"WarmThroughput" => warm_throughput()
}
"""
@type global_secondary_index() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_global_secondary_index_description() :: %{
"IndexName" => String.t() | atom(),
"OnDemandThroughputOverride" => on_demand_throughput_override(),
"ProvisionedThroughputOverride" => provisioned_throughput_override(),
"WarmThroughput" => global_secondary_index_warm_throughput_description()
}
"""
@type replica_global_secondary_index_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_import_input() :: %{
required("ImportArn") => String.t() | atom()
}
"""
@type describe_import_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_exports_input() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
optional("TableArn") => String.t() | atom()
}
"""
@type list_exports_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_continuous_backups_output() :: %{
"ContinuousBackupsDescription" => continuous_backups_description()
}
"""
@type describe_continuous_backups_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
idempotent_parameter_mismatch_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type idempotent_parameter_mismatch_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
table_description() :: %{
"ArchivalSummary" => archival_summary(),
"AttributeDefinitions" => list(attribute_definition()),
"BillingModeSummary" => billing_mode_summary(),
"CreationDateTime" => non_neg_integer(),
"DeletionProtectionEnabled" => boolean(),
"GlobalSecondaryIndexes" => list(global_secondary_index_description()),
"GlobalTableSettingsReplicationMode" => list(any()),
"GlobalTableVersion" => String.t() | atom(),
"GlobalTableWitnesses" => list(global_table_witness_description()),
"ItemCount" => float(),
"KeySchema" => list(key_schema_element()),
"LatestStreamArn" => String.t() | atom(),
"LatestStreamLabel" => String.t() | atom(),
"LocalSecondaryIndexes" => list(local_secondary_index_description()),
"MultiRegionConsistency" => list(any()),
"OnDemandThroughput" => on_demand_throughput(),
"ProvisionedThroughput" => provisioned_throughput_description(),
"Replicas" => list(replica_description()),
"RestoreSummary" => restore_summary(),
"SSEDescription" => sse_description(),
"StreamSpecification" => stream_specification(),
"TableArn" => String.t() | atom(),
"TableClassSummary" => table_class_summary(),
"TableId" => String.t() | atom(),
"TableName" => String.t() | atom(),
"TableSizeBytes" => float(),
"TableStatus" => list(any()),
"WarmThroughput" => table_warm_throughput_description()
}
"""
@type table_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_table_description() :: %{
"CreationDateTime" => non_neg_integer(),
"GlobalTableArn" => String.t() | atom(),
"GlobalTableName" => String.t() | atom(),
"GlobalTableStatus" => list(any()),
"ReplicationGroup" => list(replica_description())
}
"""
@type global_table_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_global_secondary_index_auto_scaling_description() :: %{
"IndexName" => String.t() | atom(),
"IndexStatus" => list(any()),
"ProvisionedReadCapacityAutoScalingSettings" => auto_scaling_settings_description(),
"ProvisionedWriteCapacityAutoScalingSettings" => auto_scaling_settings_description()
}
"""
@type replica_global_secondary_index_auto_scaling_description() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
export_table_to_point_in_time_output() :: %{
"ExportDescription" => export_description()
}
"""
@type export_table_to_point_in_time_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_time_to_live_input() :: %{
required("TableName") => String.t() | atom(),
required("TimeToLiveSpecification") => time_to_live_specification()
}
"""
@type update_time_to_live_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_table_input() :: %{
optional("ClientToken") => String.t() | atom(),
optional("InputCompressionType") => list(any()),
optional("InputFormatOptions") => input_format_options(),
required("InputFormat") => list(any()),
required("S3BucketSource") => s3_bucket_source(),
required("TableCreationParameters") => table_creation_parameters()
}
"""
@type import_table_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_continuous_backups_output() :: %{
"ContinuousBackupsDescription" => continuous_backups_description()
}
"""
@type update_continuous_backups_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_error() :: %{
"message" => String.t() | atom()
}
"""
@type internal_server_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_table_witness_description() :: %{
"RegionName" => String.t() | atom(),
"WitnessStatus" => list(any())
}
"""
@type global_table_witness_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_replication_group_member_action() :: %{
"RegionName" => String.t() | atom()
}
"""
@type delete_replication_group_member_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete() :: %{
"ConditionExpression" => String.t() | atom(),
"ExpressionAttributeNames" => map(),
"ExpressionAttributeValues" => map(),
"Key" => map(),
"ReturnValuesOnConditionCheckFailure" => list(any()),
"TableName" => String.t() | atom()
}
"""
@type delete() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_kinesis_streaming_destination_input() :: %{
optional("UpdateKinesisStreamingConfiguration") => update_kinesis_streaming_configuration(),
required("StreamArn") => String.t() | atom(),
required("TableName") => String.t() | atom()
}
"""
@type update_kinesis_streaming_destination_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_contributor_insights_output() :: %{
"ContributorInsightsMode" => list(any()),
"ContributorInsightsRuleList" => list(String.t() | atom()),
"ContributorInsightsStatus" => list(any()),
"FailureException" => failure_exception(),
"IndexName" => String.t() | atom(),
"LastUpdateDateTime" => non_neg_integer(),
"TableName" => String.t() | atom()
}
"""
@type describe_contributor_insights_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_backup_input() :: %{
required("BackupArn") => String.t() | atom()
}
"""
@type delete_backup_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
local_secondary_index_info() :: %{
"IndexName" => String.t() | atom(),
"KeySchema" => list(key_schema_element()),
"Projection" => projection()
}
"""
@type local_secondary_index_info() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_resource_policy_input() :: %{
optional("ExpectedRevisionId") => String.t() | atom(),
required("ResourceArn") => String.t() | atom()
}
"""
@type delete_resource_policy_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
backup_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type backup_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_contributor_insights_input() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t() | atom(),
optional("TableName") => String.t() | atom()
}
"""
@type list_contributor_insights_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
item_collection_size_limit_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type item_collection_size_limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cancellation_reason() :: %{
"Code" => String.t() | atom(),
"Item" => map(),
"Message" => String.t() | atom()
}
"""
@type cancellation_reason() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
execute_statement_input() :: %{
optional("ConsistentRead") => boolean(),
optional("Limit") => integer(),
optional("NextToken") => String.t() | atom(),
optional("Parameters") => list(list()),
optional("ReturnConsumedCapacity") => list(any()),
optional("ReturnValuesOnConditionCheckFailure") => list(any()),
required("Statement") => String.t() | atom()
}
"""
@type execute_statement_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put() :: %{
"ConditionExpression" => String.t() | atom(),
"ExpressionAttributeNames" => map(),
"ExpressionAttributeValues" => map(),
"Item" => map(),
"ReturnValuesOnConditionCheckFailure" => list(any()),
"TableName" => String.t() | atom()
}
"""
@type put() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
csv_options() :: %{
"Delimiter" => String.t() | atom(),
"HeaderList" => list(String.t() | atom())
}
"""
@type csv_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_input() :: %{
required("ResourceArn") => String.t() | atom(),
required("Tags") => list(tag())
}
"""
@type tag_resource_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
restore_summary() :: %{
"RestoreDateTime" => non_neg_integer(),
"RestoreInProgress" => boolean(),
"SourceBackupArn" => String.t() | atom(),
"SourceTableArn" => String.t() | atom()
}
"""
@type restore_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
time_to_live_description() :: %{
"AttributeName" => String.t() | atom(),
"TimeToLiveStatus" => list(any())
}
"""
@type time_to_live_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_contributor_insights_input() :: %{
optional("IndexName") => String.t() | atom(),
required("TableName") => String.t() | atom()
}
"""
@type describe_contributor_insights_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_global_table_settings_output() :: %{
"GlobalTableName" => String.t() | atom(),
"ReplicaSettings" => list(replica_settings_description())
}
"""
@type describe_global_table_settings_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transact_get_item() :: %{
"Get" => get()
}
"""
@type transact_get_item() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_table_input() :: %{
required("TableName") => String.t() | atom()
}
"""
@type delete_table_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_global_table_witness_group_member_action() :: %{
"RegionName" => String.t() | atom()
}
"""
@type delete_global_table_witness_group_member_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_backup_input() :: %{
required("BackupName") => String.t() | atom(),
required("TableName") => String.t() | atom()
}
"""
@type create_backup_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_global_secondary_index_settings_description() :: %{
"IndexName" => String.t() | atom(),
"IndexStatus" => list(any()),
"ProvisionedReadCapacityAutoScalingSettings" => auto_scaling_settings_description(),
"ProvisionedReadCapacityUnits" => float(),
"ProvisionedWriteCapacityAutoScalingSettings" => auto_scaling_settings_description(),
"ProvisionedWriteCapacityUnits" => float()
}
"""
@type replica_global_secondary_index_settings_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get() :: %{
"ExpressionAttributeNames" => map(),
"Key" => map(),
"ProjectionExpression" => String.t() | atom(),
"TableName" => String.t() | atom()
}
"""
@type get() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provisioned_throughput() :: %{
"ReadCapacityUnits" => float(),
"WriteCapacityUnits" => float()
}
"""
@type provisioned_throughput() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_secondary_index_warm_throughput_description() :: %{
"ReadUnitsPerSecond" => float(),
"Status" => list(any()),
"WriteUnitsPerSecond" => float()
}
"""
@type global_secondary_index_warm_throughput_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
table_in_use_exception() :: %{
"message" => String.t() | atom()
}
"""
@type table_in_use_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_export_output() :: %{
"ExportDescription" => export_description()
}
"""
@type describe_export_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_backups_input() :: %{
optional("BackupType") => list(any()),
optional("ExclusiveStartBackupArn") => String.t() | atom(),
optional("Limit") => integer(),
optional("TableName") => String.t() | atom(),
optional("TimeRangeLowerBound") => non_neg_integer(),
optional("TimeRangeUpperBound") => non_neg_integer()
}
"""
@type list_backups_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
local_secondary_index() :: %{
"IndexName" => String.t() | atom(),
"KeySchema" => list(key_schema_element()),
"Projection" => projection()
}
"""
@type local_secondary_index() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_summary() :: %{
"ExportArn" => String.t() | atom(),
"ExportStatus" => list(any()),
"ExportType" => list(any())
}
"""
@type export_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_time_to_live_output() :: %{
"TimeToLiveDescription" => time_to_live_description()
}
"""
@type describe_time_to_live_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_table_replica_auto_scaling_input() :: %{
optional("GlobalSecondaryIndexUpdates") => list(global_secondary_index_auto_scaling_update()),
optional("ProvisionedWriteCapacityAutoScalingUpdate") => auto_scaling_settings_update(),
optional("ReplicaUpdates") => list(replica_auto_scaling_update()),
required("TableName") => String.t() | atom()
}
"""
@type update_table_replica_auto_scaling_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
point_in_time_recovery_unavailable_exception() :: %{
"message" => String.t() | atom()
}
"""
@type point_in_time_recovery_unavailable_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
local_secondary_index_description() :: %{
"IndexArn" => String.t() | atom(),
"IndexName" => String.t() | atom(),
"IndexSizeBytes" => float(),
"ItemCount" => float(),
"KeySchema" => list(key_schema_element()),
"Projection" => projection()
}
"""
@type local_secondary_index_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
auto_scaling_policy_description() :: %{
"PolicyName" => String.t() | atom(),
"TargetTrackingScalingPolicyConfiguration" => auto_scaling_target_tracking_scaling_policy_configuration_description()
}
"""
@type auto_scaling_policy_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_item_input() :: %{
optional("AttributeUpdates") => map(),
optional("ConditionExpression") => String.t() | atom(),
optional("ConditionalOperator") => list(any()),
optional("Expected") => map(),
optional("ExpressionAttributeNames") => map(),
optional("ExpressionAttributeValues") => map(),
optional("ReturnConsumedCapacity") => list(any()),
optional("ReturnItemCollectionMetrics") => list(any()),
optional("ReturnValues") => list(any()),
optional("ReturnValuesOnConditionCheckFailure") => list(any()),
optional("UpdateExpression") => String.t() | atom(),
required("Key") => map(),
required("TableName") => String.t() | atom()
}
"""
@type update_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
attribute_value_update() :: %{
"Action" => list(any()),
"Value" => list()
}
"""
@type attribute_value_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_replication_group_member_action() :: %{
"GlobalSecondaryIndexes" => list(replica_global_secondary_index()),
"KMSMasterKeyId" => String.t() | atom(),
"OnDemandThroughputOverride" => on_demand_throughput_override(),
"ProvisionedThroughputOverride" => provisioned_throughput_override(),
"RegionName" => String.t() | atom(),
"TableClassOverride" => list(any())
}
"""
@type update_replication_group_member_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
table_warm_throughput_description() :: %{
"ReadUnitsPerSecond" => float(),
"Status" => list(any()),
"WriteUnitsPerSecond" => float()
}
"""
@type table_warm_throughput_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
table_creation_parameters() :: %{
"AttributeDefinitions" => list(attribute_definition()),
"BillingMode" => list(any()),
"GlobalSecondaryIndexes" => list(global_secondary_index()),
"KeySchema" => list(key_schema_element()),
"OnDemandThroughput" => on_demand_throughput(),
"ProvisionedThroughput" => provisioned_throughput(),
"SSESpecification" => sse_specification(),
"TableName" => String.t() | atom()
}
"""
@type table_creation_parameters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
query_input() :: %{
optional("AttributesToGet") => list(String.t() | atom()),
optional("ConditionalOperator") => list(any()),
optional("ConsistentRead") => boolean(),
optional("ExclusiveStartKey") => map(),
optional("ExpressionAttributeNames") => map(),
optional("ExpressionAttributeValues") => map(),
optional("FilterExpression") => String.t() | atom(),
optional("IndexName") => String.t() | atom(),
optional("KeyConditionExpression") => String.t() | atom(),
optional("KeyConditions") => map(),
optional("Limit") => integer(),
optional("ProjectionExpression") => String.t() | atom(),
optional("QueryFilter") => map(),
optional("ReturnConsumedCapacity") => list(any()),
optional("ScanIndexForward") => boolean(),
optional("Select") => list(any()),
required("TableName") => String.t() | atom()
}
"""
@type query_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_item_input() :: %{
optional("AttributesToGet") => list(String.t() | atom()),
optional("ConsistentRead") => boolean(),
optional("ExpressionAttributeNames") => map(),
optional("ProjectionExpression") => String.t() | atom(),
optional("ReturnConsumedCapacity") => list(any()),
required("Key") => map(),
required("TableName") => String.t() | atom()
}
"""
@type get_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_input() :: %{
required("ResourceArn") => String.t() | atom(),
required("TagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_imports_input() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => integer(),
optional("TableArn") => String.t() | atom()
}
"""
@type list_imports_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_auto_scaling_description() :: %{
"GlobalSecondaryIndexes" => list(replica_global_secondary_index_auto_scaling_description()),
"RegionName" => String.t() | atom(),
"ReplicaProvisionedReadCapacityAutoScalingSettings" => auto_scaling_settings_description(),
"ReplicaProvisionedWriteCapacityAutoScalingSettings" => auto_scaling_settings_description(),
"ReplicaStatus" => list(any())
}
"""
@type replica_auto_scaling_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
point_in_time_recovery_specification() :: %{
"PointInTimeRecoveryEnabled" => boolean(),
"RecoveryPeriodInDays" => integer()
}
"""
@type point_in_time_recovery_specification() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_global_table_input() :: %{
required("GlobalTableName") => String.t() | atom(),
required("ReplicaUpdates") => list(replica_update())
}
"""
@type update_global_table_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_item_input() :: %{
optional("ConditionExpression") => String.t() | atom(),
optional("ConditionalOperator") => list(any()),
optional("Expected") => map(),
optional("ExpressionAttributeNames") => map(),
optional("ExpressionAttributeValues") => map(),
optional("ReturnConsumedCapacity") => list(any()),
optional("ReturnItemCollectionMetrics") => list(any()),
optional("ReturnValues") => list(any()),
optional("ReturnValuesOnConditionCheckFailure") => list(any()),
required("Key") => map(),
required("TableName") => String.t() | atom()
}
"""
@type delete_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_table_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type global_table_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_exports_output() :: %{
"ExportSummaries" => list(export_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_exports_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_limits_input() :: %{}
"""
@type describe_limits_input() :: %{}
@typedoc """
## Example:
export_description() :: %{
"BilledSizeBytes" => float(),
"ClientToken" => String.t() | atom(),
"EndTime" => non_neg_integer(),
"ExportArn" => String.t() | atom(),
"ExportFormat" => list(any()),
"ExportManifest" => String.t() | atom(),
"ExportStatus" => list(any()),
"ExportTime" => non_neg_integer(),
"ExportType" => list(any()),
"FailureCode" => String.t() | atom(),
"FailureMessage" => String.t() | atom(),
"IncrementalExportSpecification" => incremental_export_specification(),
"ItemCount" => float(),
"S3Bucket" => String.t() | atom(),
"S3BucketOwner" => String.t() | atom(),
"S3Prefix" => String.t() | atom(),
"S3SseAlgorithm" => list(any()),
"S3SseKmsKeyId" => String.t() | atom(),
"StartTime" => non_neg_integer(),
"TableArn" => String.t() | atom(),
"TableId" => String.t() | atom()
}
"""
@type export_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
restore_table_from_backup_output() :: %{
"TableDescription" => table_description()
}
"""
@type restore_table_from_backup_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_table_replica_auto_scaling_input() :: %{
required("TableName") => String.t() | atom()
}
"""
@type describe_table_replica_auto_scaling_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_table_replica_auto_scaling_output() :: %{
"TableAutoScalingDescription" => table_auto_scaling_description()
}
"""
@type update_table_replica_auto_scaling_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_settings_update() :: %{
"RegionName" => String.t() | atom(),
"ReplicaGlobalSecondaryIndexSettingsUpdate" => list(replica_global_secondary_index_settings_update()),
"ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate" => auto_scaling_settings_update(),
"ReplicaProvisionedReadCapacityUnits" => float(),
"ReplicaTableClass" => list(any())
}
"""
@type replica_settings_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
table_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type table_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_imports_output() :: %{
"ImportSummaryList" => list(import_summary()),
"NextToken" => String.t() | atom()
}
"""
@type list_imports_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
on_demand_throughput_override() :: %{
"MaxReadRequestUnits" => float()
}
"""
@type on_demand_throughput_override() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
duplicate_item_exception() :: %{
"message" => String.t() | atom()
}
"""
@type duplicate_item_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_secondary_index_info() :: %{
"IndexName" => String.t() | atom(),
"KeySchema" => list(key_schema_element()),
"OnDemandThroughput" => on_demand_throughput(),
"Projection" => projection(),
"ProvisionedThroughput" => provisioned_throughput()
}
"""
@type global_secondary_index_info() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
policy_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type policy_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_resource_policy_output() :: %{
"RevisionId" => String.t() | atom()
}
"""
@type put_resource_policy_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stream_specification() :: %{
"StreamEnabled" => boolean(),
"StreamViewType" => list(any())
}
"""
@type stream_specification() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
item_collection_metrics() :: %{
"ItemCollectionKey" => map(),
"SizeEstimateRangeGB" => list(float())
}
"""
@type item_collection_metrics() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_table_replica_auto_scaling_output() :: %{
"TableAutoScalingDescription" => table_auto_scaling_description()
}
"""
@type describe_table_replica_auto_scaling_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_replication_group_member_action() :: %{
"GlobalSecondaryIndexes" => list(replica_global_secondary_index()),
"KMSMasterKeyId" => String.t() | atom(),
"OnDemandThroughputOverride" => on_demand_throughput_override(),
"ProvisionedThroughputOverride" => provisioned_throughput_override(),
"RegionName" => String.t() | atom(),
"TableClassOverride" => list(any())
}
"""
@type create_replication_group_member_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
auto_scaling_target_tracking_scaling_policy_configuration_description() :: %{
"DisableScaleIn" => boolean(),
"ScaleInCooldown" => integer(),
"ScaleOutCooldown" => integer(),
"TargetValue" => float()
}
"""
@type auto_scaling_target_tracking_scaling_policy_configuration_description() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
update_global_table_settings_output() :: %{
"GlobalTableName" => String.t() | atom(),
"ReplicaSettings" => list(replica_settings_description())
}
"""
@type update_global_table_settings_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_global_secondary_index() :: %{
"IndexName" => String.t() | atom(),
"OnDemandThroughputOverride" => on_demand_throughput_override(),
"ProvisionedThroughputOverride" => provisioned_throughput_override()
}
"""
@type replica_global_secondary_index() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_reason() :: %{
"reason" => String.t() | atom(),
"resource" => String.t() | atom()
}
"""
@type throttling_reason() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_backups_output() :: %{
"BackupSummaries" => list(backup_summary()),
"LastEvaluatedBackupArn" => String.t() | atom()
}
"""
@type list_backups_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
restore_table_to_point_in_time_input() :: %{
optional("BillingModeOverride") => list(any()),
optional("GlobalSecondaryIndexOverride") => list(global_secondary_index()),
optional("LocalSecondaryIndexOverride") => list(local_secondary_index()),
optional("OnDemandThroughputOverride") => on_demand_throughput(),
optional("ProvisionedThroughputOverride") => provisioned_throughput(),
optional("RestoreDateTime") => non_neg_integer(),
optional("SSESpecificationOverride") => sse_specification(),
optional("SourceTableArn") => String.t() | atom(),
optional("SourceTableName") => String.t() | atom(),
optional("UseLatestRestorableTime") => boolean(),
required("TargetTableName") => String.t() | atom()
}
"""
@type restore_table_to_point_in_time_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
expected_attribute_value() :: %{
"AttributeValueList" => list(list()),
"ComparisonOperator" => list(any()),
"Exists" => boolean(),
"Value" => list()
}
"""
@type expected_attribute_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_endpoints_response() :: %{
"Endpoints" => list(endpoint())
}
"""
@type describe_endpoints_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_in_use_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_in_use_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_global_table_input() :: %{
required("GlobalTableName") => String.t() | atom()
}
"""
@type describe_global_table_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transact_write_item() :: %{
"ConditionCheck" => condition_check(),
"Delete" => delete(),
"Put" => put(),
"Update" => update()
}
"""
@type transact_write_item() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provisioned_throughput_exceeded_exception() :: %{
"ThrottlingReasons" => list(throttling_reason()),
"message" => String.t() | atom()
}
"""
@type provisioned_throughput_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
write_request() :: %{
"DeleteRequest" => delete_request(),
"PutRequest" => put_request()
}
"""
@type write_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
execute_transaction_input() :: %{
optional("ClientRequestToken") => String.t() | atom(),
optional("ReturnConsumedCapacity") => list(any()),
required("TransactStatements") => list(parameterized_statement())
}
"""
@type execute_transaction_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type export_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_data_stream_destination() :: %{
"ApproximateCreationDateTimePrecision" => list(any()),
"DestinationStatus" => list(any()),
"DestinationStatusDescription" => String.t() | atom(),
"StreamArn" => String.t() | atom()
}
"""
@type kinesis_data_stream_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
condition_check() :: %{
"ConditionExpression" => String.t() | atom(),
"ExpressionAttributeNames" => map(),
"ExpressionAttributeValues" => map(),
"Key" => map(),
"ReturnValuesOnConditionCheckFailure" => list(any()),
"TableName" => String.t() | atom()
}
"""
@type condition_check() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_import_output() :: %{
"ImportTableDescription" => import_table_description()
}
"""
@type describe_import_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_global_table_input() :: %{
required("GlobalTableName") => String.t() | atom(),
required("ReplicationGroup") => list(replica())
}
"""
@type create_global_table_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
capacity() :: %{
"CapacityUnits" => float(),
"ReadCapacityUnits" => float(),
"WriteCapacityUnits" => float()
}
"""
@type capacity() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_table_description() :: %{
"ClientToken" => String.t() | atom(),
"CloudWatchLogGroupArn" => String.t() | atom(),
"EndTime" => non_neg_integer(),
"ErrorCount" => float(),
"FailureCode" => String.t() | atom(),
"FailureMessage" => String.t() | atom(),
"ImportArn" => String.t() | atom(),
"ImportStatus" => list(any()),
"ImportedItemCount" => float(),
"InputCompressionType" => list(any()),
"InputFormat" => list(any()),
"InputFormatOptions" => input_format_options(),
"ProcessedItemCount" => float(),
"ProcessedSizeBytes" => float(),
"S3BucketSource" => s3_bucket_source(),
"StartTime" => non_neg_integer(),
"TableArn" => String.t() | atom(),
"TableCreationParameters" => table_creation_parameters(),
"TableId" => String.t() | atom()
}
"""
@type import_table_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_global_table_settings_input() :: %{
optional("GlobalTableBillingMode") => list(any()),
optional("GlobalTableGlobalSecondaryIndexSettingsUpdate") => list(global_table_global_secondary_index_settings_update()),
optional("GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate") => auto_scaling_settings_update(),
optional("GlobalTableProvisionedWriteCapacityUnits") => float(),
optional("ReplicaSettingsUpdate") => list(replica_settings_update()),
required("GlobalTableName") => String.t() | atom()
}
"""
@type update_global_table_settings_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_bucket_source() :: %{
"S3Bucket" => String.t() | atom(),
"S3BucketOwner" => String.t() | atom(),
"S3KeyPrefix" => String.t() | atom()
}
"""
@type s3_bucket_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
condition() :: %{
"AttributeValueList" => list(list()),
"ComparisonOperator" => list(any())
}
"""
@type condition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_backup_input() :: %{
required("BackupArn") => String.t() | atom()
}
"""
@type describe_backup_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_restore_time_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_restore_time_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
table_auto_scaling_description() :: %{
"Replicas" => list(replica_auto_scaling_description()),
"TableName" => String.t() | atom(),
"TableStatus" => list(any())
}
"""
@type table_auto_scaling_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
backup_in_use_exception() :: %{
"message" => String.t() | atom()
}
"""
@type backup_in_use_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_auto_scaling_update() :: %{
"RegionName" => String.t() | atom(),
"ReplicaGlobalSecondaryIndexUpdates" => list(replica_global_secondary_index_auto_scaling_update()),
"ReplicaProvisionedReadCapacityAutoScalingUpdate" => auto_scaling_settings_update()
}
"""
@type replica_auto_scaling_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
query_output() :: %{
"ConsumedCapacity" => consumed_capacity(),
"Count" => integer(),
"Items" => list(map()),
"LastEvaluatedKey" => map(),
"ScannedCount" => integer()
}
"""
@type query_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_request() :: %{
"Item" => map()
}
"""
@type put_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica() :: %{
"RegionName" => String.t() | atom()
}
"""
@type replica() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
table_already_exists_exception() :: %{
"message" => String.t() | atom()
}
"""
@type table_already_exists_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
auto_scaling_settings_description() :: %{
"AutoScalingDisabled" => boolean(),
"AutoScalingRoleArn" => String.t() | atom(),
"MaximumUnits" => float(),
"MinimumUnits" => float(),
"ScalingPolicies" => list(auto_scaling_policy_description())
}
"""
@type auto_scaling_settings_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_global_tables_output() :: %{
"GlobalTables" => list(global_table()),
"LastEvaluatedGlobalTableName" => String.t() | atom()
}
"""
@type list_global_tables_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_streaming_destination_input() :: %{
optional("EnableKinesisStreamingConfiguration") => enable_kinesis_streaming_configuration(),
required("StreamArn") => String.t() | atom(),
required("TableName") => String.t() | atom()
}
"""
@type kinesis_streaming_destination_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type replica_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_global_table_output() :: %{
"GlobalTableDescription" => global_table_description()
}
"""
@type create_global_table_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_global_secondary_index_action() :: %{
"IndexName" => String.t() | atom(),
"KeySchema" => list(key_schema_element()),
"OnDemandThroughput" => on_demand_throughput(),
"Projection" => projection(),
"ProvisionedThroughput" => provisioned_throughput(),
"WarmThroughput" => warm_throughput()
}
"""
@type create_global_secondary_index_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transact_get_items_input() :: %{
optional("ReturnConsumedCapacity") => list(any()),
required("TransactItems") => list(transact_get_item())
}
"""
@type transact_get_items_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_global_secondary_index_auto_scaling_update() :: %{
"IndexName" => String.t() | atom(),
"ProvisionedReadCapacityAutoScalingUpdate" => auto_scaling_settings_update()
}
"""
@type replica_global_secondary_index_auto_scaling_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
scan_input() :: %{
optional("AttributesToGet") => list(String.t() | atom()),
optional("ConditionalOperator") => list(any()),
optional("ConsistentRead") => boolean(),
optional("ExclusiveStartKey") => map(),
optional("ExpressionAttributeNames") => map(),
optional("ExpressionAttributeValues") => map(),
optional("FilterExpression") => String.t() | atom(),
optional("IndexName") => String.t() | atom(),
optional("Limit") => integer(),
optional("ProjectionExpression") => String.t() | atom(),
optional("ReturnConsumedCapacity") => list(any()),
optional("ScanFilter") => map(),
optional("Segment") => integer(),
optional("Select") => list(any()),
optional("TotalSegments") => integer(),
required("TableName") => String.t() | atom()
}
"""
@type scan_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transact_write_items_output() :: %{
"ConsumedCapacity" => list(consumed_capacity()),
"ItemCollectionMetrics" => map()
}
"""
@type transact_write_items_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_item_output() :: %{
"Attributes" => map(),
"ConsumedCapacity" => consumed_capacity(),
"ItemCollectionMetrics" => item_collection_metrics()
}
"""
@type update_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update() :: %{
"ConditionExpression" => String.t() | atom(),
"ExpressionAttributeNames" => map(),
"ExpressionAttributeValues" => map(),
"Key" => map(),
"ReturnValuesOnConditionCheckFailure" => list(any()),
"TableName" => String.t() | atom(),
"UpdateExpression" => String.t() | atom()
}
"""
@type update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_backup_output() :: %{
"BackupDescription" => backup_description()
}
"""
@type delete_backup_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
archival_summary() :: %{
"ArchivalBackupArn" => String.t() | atom(),
"ArchivalDateTime" => non_neg_integer(),
"ArchivalReason" => String.t() | atom()
}
"""
@type archival_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
incremental_export_specification() :: %{
"ExportFromTime" => non_neg_integer(),
"ExportToTime" => non_neg_integer(),
"ExportViewType" => list(any())
}
"""
@type incremental_export_specification() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_execute_statement_input() :: %{
optional("ReturnConsumedCapacity") => list(any()),
required("Statements") => list(batch_statement_request())
}
"""
@type batch_execute_statement_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_replica_action() :: %{
"RegionName" => String.t() | atom()
}
"""
@type delete_replica_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
enable_kinesis_streaming_configuration() :: %{
"ApproximateCreationDateTimePrecision" => list(any())
}
"""
@type enable_kinesis_streaming_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transact_write_items_input() :: %{
optional("ClientRequestToken") => String.t() | atom(),
optional("ReturnConsumedCapacity") => list(any()),
optional("ReturnItemCollectionMetrics") => list(any()),
required("TransactItems") => list(transact_write_item())
}
"""
@type transact_write_items_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_replica_action() :: %{
"RegionName" => String.t() | atom()
}
"""
@type create_replica_action() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
billing_mode_summary() :: %{
"BillingMode" => list(any()),
"LastUpdateToPayPerRequestDateTime" => non_neg_integer()
}
"""
@type billing_mode_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_request() :: %{
"Key" => map()
}
"""
@type delete_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_write_item_output() :: %{
"ConsumedCapacity" => list(consumed_capacity()),
"ItemCollectionMetrics" => map(),
"UnprocessedItems" => map()
}
"""
@type batch_write_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
backup_summary() :: %{
"BackupArn" => String.t() | atom(),
"BackupCreationDateTime" => non_neg_integer(),
"BackupExpiryDateTime" => non_neg_integer(),
"BackupName" => String.t() | atom(),
"BackupSizeBytes" => float(),
"BackupStatus" => list(any()),
"BackupType" => list(any()),
"TableArn" => String.t() | atom(),
"TableId" => String.t() | atom(),
"TableName" => String.t() | atom()
}
"""
@type backup_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_table_global_secondary_index_settings_update() :: %{
"IndexName" => String.t() | atom(),
"ProvisionedWriteCapacityAutoScalingSettingsUpdate" => auto_scaling_settings_update(),
"ProvisionedWriteCapacityUnits" => float()
}
"""
@type global_table_global_secondary_index_settings_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
continuous_backups_description() :: %{
"ContinuousBackupsStatus" => list(any()),
"PointInTimeRecoveryDescription" => point_in_time_recovery_description()
}
"""
@type continuous_backups_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_table_already_exists_exception() :: %{
"message" => String.t() | atom()
}
"""
@type global_table_already_exists_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_time_to_live_input() :: %{
required("TableName") => String.t() | atom()
}
"""
@type describe_time_to_live_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_backup_output() :: %{
"BackupDescription" => backup_description()
}
"""
@type describe_backup_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
warm_throughput() :: %{
"ReadUnitsPerSecond" => float(),
"WriteUnitsPerSecond" => float()
}
"""
@type warm_throughput() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_summary() :: %{
"CloudWatchLogGroupArn" => String.t() | atom(),
"EndTime" => non_neg_integer(),
"ImportArn" => String.t() | atom(),
"ImportStatus" => list(any()),
"InputFormat" => list(any()),
"S3BucketSource" => s3_bucket_source(),
"StartTime" => non_neg_integer(),
"TableArn" => String.t() | atom()
}
"""
@type import_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tables_input() :: %{
optional("ExclusiveStartTableName") => String.t() | atom(),
optional("Limit") => integer()
}
"""
@type list_tables_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
failure_exception() :: %{
"ExceptionDescription" => String.t() | atom(),
"ExceptionName" => String.t() | atom()
}
"""
@type failure_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
point_in_time_recovery_description() :: %{
"EarliestRestorableDateTime" => non_neg_integer(),
"LatestRestorableDateTime" => non_neg_integer(),
"PointInTimeRecoveryStatus" => list(any()),
"RecoveryPeriodInDays" => integer()
}
"""
@type point_in_time_recovery_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_streaming_destination_output() :: %{
optional("DestinationStatus") => list(any()),
optional("EnableKinesisStreamingConfiguration") => enable_kinesis_streaming_configuration(),
optional("StreamArn") => String.t() | atom(),
optional("TableName") => String.t() | atom()
}
"""
@type kinesis_streaming_destination_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_continuous_backups_input() :: %{
required("PointInTimeRecoverySpecification") => point_in_time_recovery_specification(),
required("TableName") => String.t() | atom()
}
"""
@type update_continuous_backups_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tables_output() :: %{
"LastEvaluatedTableName" => String.t() | atom(),
"TableNames" => list(String.t() | atom())
}
"""
@type list_tables_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type import_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
backup_details() :: %{
"BackupArn" => String.t() | atom(),
"BackupCreationDateTime" => non_neg_integer(),
"BackupExpiryDateTime" => non_neg_integer(),
"BackupName" => String.t() | atom(),
"BackupSizeBytes" => float(),
"BackupStatus" => list(any()),
"BackupType" => list(any())
}
"""
@type backup_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_item_output() :: %{
"ConsumedCapacity" => consumed_capacity(),
"Item" => map()
}
"""
@type get_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_secondary_index_update() :: %{
"Create" => create_global_secondary_index_action(),
"Delete" => delete_global_secondary_index_action(),
"Update" => update_global_secondary_index_action()
}
"""
@type global_secondary_index_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_table_output() :: %{
"TableDescription" => table_description()
}
"""
@type create_table_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_backup_output() :: %{
"BackupDetails" => backup_details()
}
"""
@type create_backup_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_resource_policy_output() :: %{
"RevisionId" => String.t() | atom()
}
"""
@type delete_resource_policy_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_item_output() :: %{
"Attributes" => map(),
"ConsumedCapacity" => consumed_capacity(),
"ItemCollectionMetrics" => item_collection_metrics()
}
"""
@type delete_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_resource_policy_input() :: %{
optional("ConfirmRemoveSelfResourceAccess") => boolean(),
optional("ExpectedRevisionId") => String.t() | atom(),
required("Policy") => String.t() | atom(),
required("ResourceArn") => String.t() | atom()
}
"""
@type put_resource_policy_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_of_resource_output() :: %{
"NextToken" => String.t() | atom(),
"Tags" => list(tag())
}
"""
@type list_tags_of_resource_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_table_output() :: %{
"Table" => table_description()
}
"""
@type describe_table_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_kinesis_streaming_destination_output() :: %{
"KinesisDataStreamDestinations" => list(kinesis_data_stream_destination()),
"TableName" => String.t() | atom()
}
"""
@type describe_kinesis_streaming_destination_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_execute_statement_output() :: %{
"ConsumedCapacity" => list(consumed_capacity()),
"Responses" => list(batch_statement_response())
}
"""
@type batch_execute_statement_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_export_time_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_export_time_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_already_exists_exception() :: %{
"message" => String.t() | atom()
}
"""
@type replica_already_exists_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_table_witness_group_update() :: %{
"Create" => create_global_table_witness_group_member_action(),
"Delete" => delete_global_table_witness_group_member_action()
}
"""
@type global_table_witness_group_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transaction_canceled_exception() :: %{
"CancellationReasons" => list(cancellation_reason()),
"Message" => String.t() | atom()
}
"""
@type transaction_canceled_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
request_limit_exceeded() :: %{
"ThrottlingReasons" => list(throttling_reason()),
"message" => String.t() | atom()
}
"""
@type request_limit_exceeded() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
continuous_backups_unavailable_exception() :: %{
"message" => String.t() | atom()
}
"""
@type continuous_backups_unavailable_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_kinesis_streaming_configuration() :: %{
"ApproximateCreationDateTimePrecision" => list(any())
}
"""
@type update_kinesis_streaming_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_statement_response() :: %{
"Error" => batch_statement_error(),
"Item" => map(),
"TableName" => String.t() | atom()
}
"""
@type batch_statement_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_policy_input() :: %{
required("ResourceArn") => String.t() | atom()
}
"""
@type get_resource_policy_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_secondary_index_auto_scaling_update() :: %{
"IndexName" => String.t() | atom(),
"ProvisionedWriteCapacityAutoScalingUpdate" => auto_scaling_settings_update()
}
"""
@type global_secondary_index_auto_scaling_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provisioned_throughput_override() :: %{
"ReadCapacityUnits" => float()
}
"""
@type provisioned_throughput_override() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_update() :: %{
"Create" => create_replica_action(),
"Delete" => delete_replica_action()
}
"""
@type replica_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
global_table() :: %{
"GlobalTableName" => String.t() | atom(),
"ReplicationGroup" => list(replica())
}
"""
@type global_table() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_statement_request() :: %{
"ConsistentRead" => boolean(),
"Parameters" => list(list()),
"ReturnValuesOnConditionCheckFailure" => list(any()),
"Statement" => String.t() | atom()
}
"""
@type batch_statement_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_endpoints_request() :: %{}
"""
@type describe_endpoints_request() :: %{}
@typedoc """
## Example:
key_schema_element() :: %{
"AttributeName" => String.t() | atom(),
"KeyType" => list(any())
}
"""
@type key_schema_element() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_description() :: %{
"GlobalSecondaryIndexes" => list(replica_global_secondary_index_description()),
"GlobalTableSettingsReplicationMode" => list(any()),
"KMSMasterKeyId" => String.t() | atom(),
"OnDemandThroughputOverride" => on_demand_throughput_override(),
"ProvisionedThroughputOverride" => provisioned_throughput_override(),
"RegionName" => String.t() | atom(),
"ReplicaArn" => String.t() | atom(),
"ReplicaInaccessibleDateTime" => non_neg_integer(),
"ReplicaStatus" => list(any()),
"ReplicaStatusDescription" => String.t() | atom(),
"ReplicaStatusPercentProgress" => String.t() | atom(),
"ReplicaTableClassSummary" => table_class_summary(),
"WarmThroughput" => table_warm_throughput_description()
}
"""
@type replica_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_item_input() :: %{
optional("ConditionExpression") => String.t() | atom(),
optional("ConditionalOperator") => list(any()),
optional("Expected") => map(),
optional("ExpressionAttributeNames") => map(),
optional("ExpressionAttributeValues") => map(),
optional("ReturnConsumedCapacity") => list(any()),
optional("ReturnItemCollectionMetrics") => list(any()),
optional("ReturnValues") => list(any()),
optional("ReturnValuesOnConditionCheckFailure") => list(any()),
required("Item") => map(),
required("TableName") => String.t() | atom()
}
"""
@type put_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
replica_settings_description() :: %{
"RegionName" => String.t() | atom(),
"ReplicaBillingModeSummary" => billing_mode_summary(),
"ReplicaGlobalSecondaryIndexSettings" => list(replica_global_secondary_index_settings_description()),
"ReplicaProvisionedReadCapacityAutoScalingSettings" => auto_scaling_settings_description(),
"ReplicaProvisionedReadCapacityUnits" => float(),
"ReplicaProvisionedWriteCapacityAutoScalingSettings" => auto_scaling_settings_description(),
"ReplicaProvisionedWriteCapacityUnits" => float(),
"ReplicaStatus" => list(any()),
"ReplicaTableClassSummary" => table_class_summary()
}
"""
@type replica_settings_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
on_demand_throughput() :: %{
"MaxReadRequestUnits" => float(),
"MaxWriteRequestUnits" => float()
}
"""
@type on_demand_throughput() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_kinesis_streaming_destination_output() :: %{
"DestinationStatus" => list(any()),
"StreamArn" => String.t() | atom(),
"TableName" => String.t() | atom(),
"UpdateKinesisStreamingConfiguration" => update_kinesis_streaming_configuration()
}
"""
@type update_kinesis_streaming_destination_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_table_input() :: %{
optional("AttributeDefinitions") => list(attribute_definition()),
optional("BillingMode") => list(any()),
optional("DeletionProtectionEnabled") => boolean(),
optional("GlobalSecondaryIndexUpdates") => list(global_secondary_index_update()),
optional("GlobalTableSettingsReplicationMode") => list(any()),
optional("GlobalTableWitnessUpdates") => list(global_table_witness_group_update()),
optional("MultiRegionConsistency") => list(any()),
optional("OnDemandThroughput") => on_demand_throughput(),
optional("ProvisionedThroughput") => provisioned_throughput(),
optional("ReplicaUpdates") => list(replication_group_update()),
optional("SSESpecification") => sse_specification(),
optional("StreamSpecification") => stream_specification(),
optional("TableClass") => list(any()),
optional("WarmThroughput") => warm_throughput(),
required("TableName") => String.t() | atom()
}
"""
@type update_table_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_conflict_exception() :: %{
"message" => String.t() | atom()
}
"""
@type export_conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
keys_and_attributes() :: %{
"AttributesToGet" => list(String.t() | atom()),
"ConsistentRead" => boolean(),
"ExpressionAttributeNames" => map(),
"Keys" => list(map()),
"ProjectionExpression" => String.t() | atom()
}
"""
@type keys_and_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
transaction_in_progress_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type transaction_in_progress_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
parameterized_statement() :: %{
"Parameters" => list(list()),
"ReturnValuesOnConditionCheckFailure" => list(any()),
"Statement" => String.t() | atom()
}
"""
@type parameterized_statement() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
attribute_definition() :: %{
"AttributeName" => String.t() | atom(),
"AttributeType" => list(any())
}
"""
@type attribute_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_export_input() :: %{
required("ExportArn") => String.t() | atom()
}
"""
@type describe_export_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
table_class_summary() :: %{
"LastUpdateDateTime" => non_neg_integer(),
"TableClass" => list(any())
}
"""
@type table_class_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conditional_check_failed_exception() :: %{
"Item" => map(),
"message" => String.t() | atom()
}
"""
@type conditional_check_failed_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_write_item_input() :: %{
optional("ReturnConsumedCapacity") => list(any()),
optional("ReturnItemCollectionMetrics") => list(any()),
required("RequestItems") => map()
}
"""
@type batch_write_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_statement_error() :: %{
"Code" => list(any()),
"Item" => map(),
"Message" => String.t() | atom()
}
"""
@type batch_statement_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_format_options() :: %{
"Csv" => csv_options()
}
"""
@type input_format_options() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
time_to_live_specification() :: %{
"AttributeName" => String.t() | atom(),
"Enabled" => boolean()
}
"""
@type time_to_live_specification() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
projection() :: %{
"NonKeyAttributes" => list(String.t() | atom()),
"ProjectionType" => list(any())
}
"""
@type projection() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
source_table_details() :: %{
"BillingMode" => list(any()),
"ItemCount" => float(),
"KeySchema" => list(key_schema_element()),
"OnDemandThroughput" => on_demand_throughput(),
"ProvisionedThroughput" => provisioned_throughput(),
"TableArn" => String.t() | atom(),
"TableCreationDateTime" => non_neg_integer(),
"TableId" => String.t() | atom(),
"TableName" => String.t() | atom(),
"TableSizeBytes" => float()
}
"""
@type source_table_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
execute_transaction_output() :: %{
"ConsumedCapacity" => list(consumed_capacity()),
"Responses" => list(item_response())
}
"""
@type execute_transaction_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_resource_policy_output() :: %{
"Policy" => String.t() | atom(),
"RevisionId" => String.t() | atom()
}
"""
@type get_resource_policy_output() :: %{(String.t() | atom()) => any()}
@type batch_execute_statement_errors() ::
request_limit_exceeded() | internal_server_error() | throttling_exception()
@type batch_get_item_errors() ::
request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
@type batch_write_item_errors() ::
request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| item_collection_size_limit_exceeded_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
| replicated_write_conflict_exception()
@type create_backup_errors() ::
continuous_backups_unavailable_exception()
| backup_in_use_exception()
| table_not_found_exception()
| table_in_use_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type create_global_table_errors() ::
global_table_already_exists_exception()
| table_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type create_table_errors() ::
resource_in_use_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type delete_backup_errors() ::
backup_in_use_exception()
| backup_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type delete_item_errors() ::
conditional_check_failed_exception()
| request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| item_collection_size_limit_exceeded_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
| transaction_conflict_exception()
| replicated_write_conflict_exception()
@type delete_resource_policy_errors() ::
resource_in_use_exception()
| policy_not_found_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type delete_table_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type describe_backup_errors() ::
backup_not_found_exception() | internal_server_error() | invalid_endpoint_exception()
@type describe_continuous_backups_errors() ::
table_not_found_exception() | internal_server_error() | invalid_endpoint_exception()
@type describe_contributor_insights_errors() ::
resource_not_found_exception() | internal_server_error()
@type describe_export_errors() ::
export_not_found_exception() | internal_server_error() | limit_exceeded_exception()
@type describe_global_table_errors() ::
global_table_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
@type describe_global_table_settings_errors() ::
global_table_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
@type describe_import_errors() :: import_not_found_exception()
@type describe_kinesis_streaming_destination_errors() ::
resource_not_found_exception() | internal_server_error() | invalid_endpoint_exception()
@type describe_limits_errors() :: internal_server_error() | invalid_endpoint_exception()
@type describe_table_errors() ::
resource_not_found_exception() | internal_server_error() | invalid_endpoint_exception()
@type describe_table_replica_auto_scaling_errors() ::
resource_not_found_exception() | internal_server_error()
@type describe_time_to_live_errors() ::
resource_not_found_exception() | internal_server_error() | invalid_endpoint_exception()
@type disable_kinesis_streaming_destination_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type enable_kinesis_streaming_destination_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type execute_statement_errors() ::
conditional_check_failed_exception()
| request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| duplicate_item_exception()
| resource_not_found_exception()
| item_collection_size_limit_exceeded_exception()
| internal_server_error()
| throttling_exception()
| transaction_conflict_exception()
@type execute_transaction_errors() ::
transaction_in_progress_exception()
| request_limit_exceeded()
| transaction_canceled_exception()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| internal_server_error()
| idempotent_parameter_mismatch_exception()
| throttling_exception()
@type export_table_to_point_in_time_errors() ::
export_conflict_exception()
| invalid_export_time_exception()
| table_not_found_exception()
| point_in_time_recovery_unavailable_exception()
| internal_server_error()
| limit_exceeded_exception()
@type get_item_errors() ::
request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
@type get_resource_policy_errors() ::
policy_not_found_exception()
| resource_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
@type import_table_errors() ::
resource_in_use_exception() | limit_exceeded_exception() | import_conflict_exception()
@type list_backups_errors() :: internal_server_error() | invalid_endpoint_exception()
@type list_contributor_insights_errors() ::
resource_not_found_exception() | internal_server_error()
@type list_exports_errors() :: internal_server_error() | limit_exceeded_exception()
@type list_global_tables_errors() :: internal_server_error() | invalid_endpoint_exception()
@type list_imports_errors() :: limit_exceeded_exception()
@type list_tables_errors() :: internal_server_error() | invalid_endpoint_exception()
@type list_tags_of_resource_errors() ::
resource_not_found_exception() | internal_server_error() | invalid_endpoint_exception()
@type put_item_errors() ::
conditional_check_failed_exception()
| request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| item_collection_size_limit_exceeded_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
| transaction_conflict_exception()
| replicated_write_conflict_exception()
@type put_resource_policy_errors() ::
resource_in_use_exception()
| policy_not_found_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type query_errors() ::
request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
@type restore_table_from_backup_errors() ::
table_already_exists_exception()
| backup_in_use_exception()
| table_in_use_exception()
| backup_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type restore_table_to_point_in_time_errors() ::
table_already_exists_exception()
| invalid_restore_time_exception()
| table_not_found_exception()
| point_in_time_recovery_unavailable_exception()
| table_in_use_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type scan_errors() ::
request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
@type tag_resource_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type transact_get_items_errors() ::
request_limit_exceeded()
| transaction_canceled_exception()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
@type transact_write_items_errors() ::
transaction_in_progress_exception()
| request_limit_exceeded()
| transaction_canceled_exception()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| internal_server_error()
| idempotent_parameter_mismatch_exception()
| invalid_endpoint_exception()
| throttling_exception()
@type untag_resource_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type update_continuous_backups_errors() ::
continuous_backups_unavailable_exception()
| table_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
@type update_contributor_insights_errors() ::
resource_not_found_exception() | internal_server_error()
@type update_global_table_errors() ::
replica_already_exists_exception()
| replica_not_found_exception()
| table_not_found_exception()
| global_table_not_found_exception()
| internal_server_error()
| invalid_endpoint_exception()
@type update_global_table_settings_errors() ::
replica_not_found_exception()
| resource_in_use_exception()
| global_table_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
| index_not_found_exception()
@type update_item_errors() ::
conditional_check_failed_exception()
| request_limit_exceeded()
| provisioned_throughput_exceeded_exception()
| resource_not_found_exception()
| item_collection_size_limit_exceeded_exception()
| internal_server_error()
| invalid_endpoint_exception()
| throttling_exception()
| transaction_conflict_exception()
| replicated_write_conflict_exception()
@type update_kinesis_streaming_destination_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type update_table_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
@type update_table_replica_auto_scaling_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
@type update_time_to_live_errors() ::
resource_in_use_exception()
| resource_not_found_exception()
| internal_server_error()
| limit_exceeded_exception()
| invalid_endpoint_exception()
def metadata do
%{
api_version: "2012-08-10",
content_type: "application/x-amz-json-1.0",
credential_scope: nil,
endpoint_prefix: "dynamodb",
global?: false,
hostname: nil,
protocol: "json",
service_id: "DynamoDB",
signature_version: "v4",
signing_name: "dynamodb",
target_prefix: "DynamoDB_20120810"
}
end
@doc """
This operation allows you to perform batch reads or writes on data stored in
DynamoDB,
using PartiQL.
Each read statement in a `BatchExecuteStatement` must specify
an equality condition on all key attributes. This enforces that each `SELECT`
statement in a batch returns at most a single item. For more information, see
[Running batch operations with PartiQL for DynamoDB
](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ql-reference.multiplestatements.batching.html).
The entire batch must consist of either read statements or write statements, you
cannot mix both in one batch.
A HTTP 200 response does not mean that all statements in the
BatchExecuteStatement
succeeded. Error details for individual statements can be found under the
[Error](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error)
field of the `BatchStatementResponse` for each
statement.
"""
@spec batch_execute_statement(map(), batch_execute_statement_input(), list()) ::
{:ok, batch_execute_statement_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_execute_statement_errors()}
def batch_execute_statement(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "BatchExecuteStatement", input, options)
end
@doc """
The `BatchGetItem` operation returns the attributes of one or more items
from one or more tables.
You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many
as 100
items. `BatchGetItem` returns a partial result if the response size limit is
exceeded, the table's provisioned throughput is exceeded, more than 1MB per
partition is
requested, or an internal processing failure occurs. If a partial result is
returned,
the operation returns a value for `UnprocessedKeys`. You can use this value
to retry the operation starting with the next item to get.
If you request more than 100 items, `BatchGetItem` returns a
`ValidationException` with the message "Too many items requested for
the BatchGetItem call."
For example, if you ask to retrieve 100 items, but each individual item is 300
KB in
size, the system returns 52 items (so as not to exceed the 16 MB limit). It also
returns
an appropriate `UnprocessedKeys` value so you can get the next page of
results. If desired, your application can include its own logic to assemble the
pages of
results into one dataset.
If *none* of the items can be processed due to insufficient
provisioned throughput on all of the tables in the request, then
`BatchGetItem` returns a
`ProvisionedThroughputExceededException`. If *at least
one* of the items is successfully processed, then
`BatchGetItem` completes successfully, while returning the keys of the
unread items in `UnprocessedKeys`.
If DynamoDB returns any unprocessed items, you should retry the batch operation
on
those items. However, *we strongly recommend that you use an exponential
backoff algorithm*. If you retry the batch operation immediately, the
underlying read or write requests can still fail due to throttling on the
individual
tables. If you delay the batch operation using exponential backoff, the
individual
requests in the batch are much more likely to succeed.
For more information, see [Batch Operations and Error Handling](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations)
in the *Amazon DynamoDB
Developer Guide*.
By default, `BatchGetItem` performs eventually consistent reads on every
table in the request. If you want strongly consistent reads instead, you can set
`ConsistentRead` to `true` for any or all tables.
In order to minimize response latency, `BatchGetItem` may retrieve items in
parallel.
When designing your application, keep in mind that DynamoDB does not return
items in
any particular order. To help parse the response by item, include the primary
key values
for the items in your request in the `ProjectionExpression` parameter.
If a requested item does not exist, it is not returned in the result. Requests
for
nonexistent items consume the minimum read capacity units according to the type
of read.
For more information, see [Working with Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations)
in the *Amazon DynamoDB Developer
Guide*.
`BatchGetItem` will result in a `ValidationException` if the
same key is specified multiple times.
"""
@spec batch_get_item(map(), batch_get_item_input(), list()) ::
{:ok, batch_get_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_get_item_errors()}
def batch_get_item(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "BatchGetItem", input, options)
end
@doc """
The `BatchWriteItem` operation puts or deletes multiple items in one or
more tables.
A single call to `BatchWriteItem` can transmit up to 16MB of
data over the network, consisting of up to 25 item put or delete operations.
While
individual items can be up to 400 KB once stored, it's important to note that an
item's
representation might be greater than 400KB while being sent in DynamoDB's JSON
format
for the API call. For more details on this distinction, see [Naming Rules and Data
Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html).
`BatchWriteItem` cannot update items. If you perform a
`BatchWriteItem` operation on an existing item, that item's values
will be overwritten by the operation and it will appear like it was updated. To
update items, we recommend you use the `UpdateItem` action.
The individual `PutItem` and `DeleteItem` operations specified
in `BatchWriteItem` are atomic; however `BatchWriteItem` as a
whole is not. If any requested operations fail because the table's provisioned
throughput is exceeded or an internal processing failure occurs, the failed
operations
are returned in the `UnprocessedItems` response parameter. You can
investigate and optionally resend the requests. Typically, you would call
`BatchWriteItem` in a loop. Each iteration would check for unprocessed
items and submit a new `BatchWriteItem` request with those unprocessed items
until all items have been processed.
For tables and indexes with provisioned capacity, if none of the items can be
processed due to insufficient provisioned throughput on all of the tables in the
request, then `BatchWriteItem` returns a
`ProvisionedThroughputExceededException`. For all tables and indexes, if
none of the items can be processed due to other throttling scenarios (such as
exceeding
partition level limits), then `BatchWriteItem` returns a
`ThrottlingException`.
If DynamoDB returns any unprocessed items, you should retry the batch operation
on
those items. However, *we strongly recommend that you use an exponential
backoff algorithm*. If you retry the batch operation immediately, the
underlying read or write requests can still fail due to throttling on the
individual
tables. If you delay the batch operation using exponential backoff, the
individual
requests in the batch are much more likely to succeed.
For more information, see [Batch Operations and Error Handling](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations)
in the *Amazon DynamoDB
Developer Guide*.
With `BatchWriteItem`, you can efficiently write or delete large amounts of
data, such as from Amazon EMR, or copy data from another database into DynamoDB.
In
order to improve performance with these large-scale operations,
`BatchWriteItem` does not behave in the same way as individual
`PutItem` and `DeleteItem` calls would. For example, you
cannot specify conditions on individual put and delete requests, and
`BatchWriteItem` does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads
to
write items in parallel. Your application must include the necessary logic to
manage the
threads. With languages that don't support threading, you must update or delete
the
specified items one at a time. In both situations, `BatchWriteItem` performs
the specified put and delete operations in parallel, giving you the power of the
thread
pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request
consumes the same number of write capacity units whether it is processed in
parallel or
not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write
operation:
*
One or more tables specified in the `BatchWriteItem` request does
not exist.
*
Primary key attributes specified on an item in the request do not match those
in the corresponding table's primary key schema.
*
You try to perform multiple operations on the same item in the same
`BatchWriteItem` request. For example, you cannot put and delete
the same item in the same `BatchWriteItem` request.
*
Your request contains at least two items with identical hash and range keys
(which essentially is two put operations).
*
There are more than 25 requests in the batch.
*
Any individual item in a batch exceeds 400 KB.
*
The total request size exceeds 16 MB.
*
Any individual items with keys exceeding the key length limits. For a
partition key, the limit is 2048 bytes and for a sort key, the limit is 1024
bytes.
"""
@spec batch_write_item(map(), batch_write_item_input(), list()) ::
{:ok, batch_write_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_write_item_errors()}
def batch_write_item(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "BatchWriteItem", input, options)
end
@doc """
Creates a backup for an existing table.
Each time you create an on-demand backup, the entire table data is backed up.
There
is no limit to the number of on-demand backups that can be taken.
When you create an on-demand backup, a time marker of the request is cataloged,
and
the backup is created asynchronously, by applying all changes until the time of
the
request to the last full table snapshot. Backup requests are processed
instantaneously
and become available for restore within minutes.
You can call `CreateBackup` at a maximum rate of 50 times per
second.
All backups in DynamoDB work without consuming any provisioned throughput on the
table.
If you submit a backup request on 2018-12-14 at 14:25:00, the backup is
guaranteed to
contain all data committed to the table up to 14:24:00, and data committed after
14:26:00 will not be. The backup might contain data modifications made between
14:24:00
and 14:26:00. On-demand backup does not support causal consistency.
Along with data, the following are also included on the backups:
*
Global secondary indexes (GSIs)
*
Local secondary indexes (LSIs)
*
Streams
*
Provisioned read and write capacity
"""
@spec create_backup(map(), create_backup_input(), list()) ::
{:ok, create_backup_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_backup_errors()}
def create_backup(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "CreateBackup", input, options)
end
@doc """
Creates a global table from an existing table.
A global table creates a replication
relationship between two or more DynamoDB tables with the same table name in the
provided Regions.
This documentation is for version 2017.11.29 (Legacy) of global tables, which
should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21
(Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
when possible, because it provides greater flexibility, higher efficiency, and
consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are
using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html).
To update existing global tables from version 2017.11.29 (Legacy) to version
2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
If you want to add a new replica table to a global table, each of the following
conditions must be true:
*
The table must have the same primary key as all of the other replicas.
*
The table must have the same name as all of the other replicas.
*
The table must have DynamoDB Streams enabled, with the stream containing both
the new and the old images of the item.
*
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must
also be
met:
*
The global secondary indexes must have the same name.
*
The global secondary indexes must have the same hash key and sort key (if
present).
If local secondary indexes are specified, then the following conditions must
also be
met:
*
The local secondary indexes must have the same name.
*
The local secondary indexes must have the same hash key and sort key (if
present).
Write capacity settings should be set consistently across your replica tables
and
secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage
the
write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision
equal replicated write capacity units to your replica tables. You should also
provision equal replicated write capacity units to matching secondary indexes
across
your global table.
"""
@spec create_global_table(map(), create_global_table_input(), list()) ::
{:ok, create_global_table_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_global_table_errors()}
def create_global_table(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "CreateGlobalTable", input, options)
end
@doc """
The `CreateTable` operation adds a new table to your account.
In an Amazon Web Services account, table names must be unique within each
Region. That is, you can
have two tables with same name if you create the tables in different Regions.
`CreateTable` is an asynchronous operation. Upon receiving a
`CreateTable` request, DynamoDB immediately returns a response with a
`TableStatus` of `CREATING`. After the table is created,
DynamoDB sets the `TableStatus` to `ACTIVE`. You can perform read
and write operations only on an `ACTIVE` table.
You can optionally define secondary indexes on the new table, as part of the
`CreateTable` operation. If you want to create multiple tables with
secondary indexes on them, you must create the tables sequentially. Only one
table with
secondary indexes can be in the `CREATING` state at any given time.
You can use the `DescribeTable` action to check the table status.
"""
@spec create_table(map(), create_table_input(), list()) ::
{:ok, create_table_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_table_errors()}
def create_table(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "CreateTable", input, options)
end
@doc """
Deletes an existing backup of a table.
You can call `DeleteBackup` at a maximum rate of 10 times per
second.
"""
@spec delete_backup(map(), delete_backup_input(), list()) ::
{:ok, delete_backup_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_backup_errors()}
def delete_backup(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DeleteBackup", input, options)
end
@doc """
Deletes a single item in a table by primary key.
You can perform a conditional delete
operation that deletes the item if it exists, or if it has an expected attribute
value.
In addition to deleting an item, you can also return the item's attribute values
in
the same operation, using the `ReturnValues` parameter.
Unless you specify conditions, the `DeleteItem` is an idempotent operation;
running it multiple times on the same item or attribute does *not*
result in an error response.
Conditional deletes are useful for deleting items only if specific conditions
are met.
If those conditions are met, DynamoDB performs the delete. Otherwise, the item
is not
deleted.
"""
@spec delete_item(map(), delete_item_input(), list()) ::
{:ok, delete_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_item_errors()}
def delete_item(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DeleteItem", input, options)
end
@doc """
Deletes the resource-based policy attached to the resource, which can be a table
or
stream.
`DeleteResourcePolicy` is an idempotent operation; running it multiple
times on the same resource *doesn't* result in an error response,
unless you specify an `ExpectedRevisionId`, which will then return a
`PolicyNotFoundException`.
To make sure that you don't inadvertently lock yourself out of your own
resources,
the root principal in your Amazon Web Services account can perform
`DeleteResourcePolicy` requests, even if your resource-based policy
explicitly denies the root principal's access.
`DeleteResourcePolicy` is an asynchronous operation. If you issue a
`GetResourcePolicy` request immediately after running the
`DeleteResourcePolicy` request, DynamoDB might still return
the deleted policy. This is because the policy for your resource might not have
been
deleted yet. Wait for a few seconds, and then try the `GetResourcePolicy`
request again.
"""
@spec delete_resource_policy(map(), delete_resource_policy_input(), list()) ::
{:ok, delete_resource_policy_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_resource_policy_errors()}
def delete_resource_policy(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DeleteResourcePolicy", input, options)
end
@doc """
The `DeleteTable` operation deletes a table and all of its items.
After a
`DeleteTable` request, the specified table is in the
`DELETING` state until DynamoDB completes the deletion. If the table is
in the `ACTIVE` state, you can delete it. If a table is in
`CREATING` or `UPDATING` states, then DynamoDB returns a
`ResourceInUseException`. If the specified table does not exist, DynamoDB
returns a `ResourceNotFoundException`. If table is already in the
`DELETING` state, no error is returned.
DynamoDB might continue to accept data read and write operations, such as
`GetItem` and `PutItem`, on a table in the
`DELETING` state until the table deletion is complete. For the full
list of table states, see
[TableStatus](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TableDescription.html#DDB-Type-TableDescription-TableStatus).
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream
on
that table goes into the `DISABLED` state, and the stream is automatically
deleted after 24 hours.
Use the `DescribeTable` action to check the status of the table.
"""
@spec delete_table(map(), delete_table_input(), list()) ::
{:ok, delete_table_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_table_errors()}
def delete_table(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DeleteTable", input, options)
end
@doc """
Describes an existing backup of a table.
You can call `DescribeBackup` at a maximum rate of 10 times per
second.
"""
@spec describe_backup(map(), describe_backup_input(), list()) ::
{:ok, describe_backup_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_backup_errors()}
def describe_backup(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeBackup", input, options)
end
@doc """
Checks the status of continuous backups and point in time recovery on the
specified
table.
Continuous backups are `ENABLED` on all tables at table creation. If
point in time recovery is enabled, `PointInTimeRecoveryStatus` will be set to
ENABLED.
After continuous backups and point in time recovery are enabled, you can restore
to
any point in time within `EarliestRestorableDateTime` and
`LatestRestorableDateTime`.
`LatestRestorableDateTime` is typically 5 minutes before the current time.
You can restore your table to any point in time in the last 35 days. You can set
the
recovery period to any value between 1 and 35 days.
You can call `DescribeContinuousBackups` at a maximum rate of 10 times per
second.
"""
@spec describe_continuous_backups(map(), describe_continuous_backups_input(), list()) ::
{:ok, describe_continuous_backups_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_continuous_backups_errors()}
def describe_continuous_backups(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeContinuousBackups", input, options)
end
@doc """
Returns information about contributor insights for a given table or global
secondary
index.
"""
@spec describe_contributor_insights(map(), describe_contributor_insights_input(), list()) ::
{:ok, describe_contributor_insights_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_contributor_insights_errors()}
def describe_contributor_insights(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeContributorInsights", input, options)
end
@doc """
Returns the regional endpoint information.
For more information on policy permissions,
please see [Internetwork traffic privacy](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints).
"""
@spec describe_endpoints(map(), describe_endpoints_request(), list()) ::
{:ok, describe_endpoints_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def describe_endpoints(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeEndpoints", input, options)
end
@doc """
Describes an existing table export.
"""
@spec describe_export(map(), describe_export_input(), list()) ::
{:ok, describe_export_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_export_errors()}
def describe_export(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeExport", input, options)
end
@doc """
Returns information about the specified global table.
This documentation is for version 2017.11.29 (Legacy) of global tables, which
should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21
(Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
when possible, because it provides greater flexibility, higher efficiency, and
consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are
using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html).
To update existing global tables from version 2017.11.29 (Legacy) to version
2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
"""
@spec describe_global_table(map(), describe_global_table_input(), list()) ::
{:ok, describe_global_table_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_global_table_errors()}
def describe_global_table(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeGlobalTable", input, options)
end
@doc """
Describes Region-specific settings for a global table.
This documentation is for version 2017.11.29 (Legacy) of global tables, which
should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21
(Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
when possible, because it provides greater flexibility, higher efficiency, and
consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are
using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html).
To update existing global tables from version 2017.11.29 (Legacy) to version
2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
"""
@spec describe_global_table_settings(map(), describe_global_table_settings_input(), list()) ::
{:ok, describe_global_table_settings_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_global_table_settings_errors()}
def describe_global_table_settings(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeGlobalTableSettings", input, options)
end
@doc """
Represents the properties of the import.
"""
@spec describe_import(map(), describe_import_input(), list()) ::
{:ok, describe_import_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_import_errors()}
def describe_import(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeImport", input, options)
end
@doc """
Returns information about the status of Kinesis streaming.
"""
@spec describe_kinesis_streaming_destination(
map(),
describe_kinesis_streaming_destination_input(),
list()
) ::
{:ok, describe_kinesis_streaming_destination_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_kinesis_streaming_destination_errors()}
def describe_kinesis_streaming_destination(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeKinesisStreamingDestination", input, options)
end
@doc """
Returns the current provisioned-capacity quotas for your Amazon Web Services
account in
a Region, both for the Region as a whole and for any one DynamoDB table that you
create
there.
When you establish an Amazon Web Services account, the account has initial
quotas on
the maximum read capacity units and write capacity units that you can provision
across
all of your DynamoDB tables in a given Region. Also, there are per-table
quotas that apply when you create a table there. For more information, see
[Service, Account, and Table
Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
page in the *Amazon DynamoDB
Developer Guide*.
Although you can increase these quotas by filing a case at [Amazon Web Services Support Center](https://console.aws.amazon.com/support/home#/), obtaining the
increase is not instantaneous. The `DescribeLimits` action lets you write
code to compare the capacity you are currently using to those quotas imposed by
your
account so that you have enough time to apply for an increase before you hit a
quota.
For example, you could use one of the Amazon Web Services SDKs to do the
following:
1.
Call `DescribeLimits` for a particular Region to obtain your
current account quotas on provisioned capacity there.
2.
Create a variable to hold the aggregate read capacity units provisioned for
all your tables in that Region, and one to hold the aggregate write capacity
units. Zero them both.
3.
Call `ListTables` to obtain a list of all your DynamoDB
tables.
4.
For each table name listed by `ListTables`, do the
following:
*
Call `DescribeTable` with the table name.
*
Use the data returned by `DescribeTable` to add the read
capacity units and write capacity units provisioned for the table itself
to your variables.
*
If the table has one or more global secondary indexes (GSIs), loop
over these GSIs and add their provisioned capacity values to your
variables as well.
5.
Report the account quotas for that Region returned by
`DescribeLimits`, along with the total current provisioned
capacity levels you have calculated.
This will let you see whether you are getting close to your account-level
quotas.
The per-table quotas apply only when you are creating a new table. They restrict
the
sum of the provisioned capacity of the new table itself and all its global
secondary
indexes.
For existing tables and their GSIs, DynamoDB doesn't let you increase
provisioned
capacity extremely rapidly, but the only quota that applies is that the
aggregate
provisioned capacity over all your tables and GSIs cannot exceed either of the
per-account quotas.
`DescribeLimits` should only be called periodically. You can expect
throttling errors if you call it more than once in a minute.
The `DescribeLimits` Request element has no content.
"""
@spec describe_limits(map(), describe_limits_input(), list()) ::
{:ok, describe_limits_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_limits_errors()}
def describe_limits(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeLimits", input, options)
end
@doc """
Returns information about the table, including the current status of the table,
when
it was created, the primary key schema, and any indexes on the table.
If you issue a `DescribeTable` request immediately after a
`CreateTable` request, DynamoDB might return a
`ResourceNotFoundException`. This is because
`DescribeTable` uses an eventually consistent query, and the metadata
for your table might not be available at that moment. Wait for a few seconds,
and
then try the `DescribeTable` request again.
"""
@spec describe_table(map(), describe_table_input(), list()) ::
{:ok, describe_table_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_table_errors()}
def describe_table(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeTable", input, options)
end
@doc """
Describes auto scaling settings across replicas of the global table at once.
"""
@spec describe_table_replica_auto_scaling(
map(),
describe_table_replica_auto_scaling_input(),
list()
) ::
{:ok, describe_table_replica_auto_scaling_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_table_replica_auto_scaling_errors()}
def describe_table_replica_auto_scaling(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeTableReplicaAutoScaling", input, options)
end
@doc """
Gives a description of the Time to Live (TTL) status on the specified table.
"""
@spec describe_time_to_live(map(), describe_time_to_live_input(), list()) ::
{:ok, describe_time_to_live_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_time_to_live_errors()}
def describe_time_to_live(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeTimeToLive", input, options)
end
@doc """
Stops replication from the DynamoDB table to the Kinesis data stream.
This
is done without deleting either of the resources.
"""
@spec disable_kinesis_streaming_destination(
map(),
kinesis_streaming_destination_input(),
list()
) ::
{:ok, kinesis_streaming_destination_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disable_kinesis_streaming_destination_errors()}
def disable_kinesis_streaming_destination(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DisableKinesisStreamingDestination", input, options)
end
@doc """
Starts table data replication to the specified Kinesis data stream at a
timestamp
chosen during the enable workflow.
If this operation doesn't return results immediately,
use DescribeKinesisStreamingDestination to check if streaming to the Kinesis
data stream
is ACTIVE.
"""
@spec enable_kinesis_streaming_destination(map(), kinesis_streaming_destination_input(), list()) ::
{:ok, kinesis_streaming_destination_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, enable_kinesis_streaming_destination_errors()}
def enable_kinesis_streaming_destination(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "EnableKinesisStreamingDestination", input, options)
end
@doc """
This operation allows you to perform reads and singleton writes on data stored
in
DynamoDB, using PartiQL.
For PartiQL reads (`SELECT` statement), if the total number of processed
items exceeds the maximum dataset size limit of 1 MB, the read stops and results
are
returned to the user as a `LastEvaluatedKey` value to continue the read in a
subsequent operation. If the filter criteria in `WHERE` clause does not match
any data, the read will return an empty result set.
A single `SELECT` statement response can return up to the maximum number of
items (if using the Limit parameter) or a maximum of 1 MB of data (and then
apply any
filtering to the results using `WHERE` clause). If
`LastEvaluatedKey` is present in the response, you need to paginate the
result set. If `NextToken` is present, you need to paginate the result set
and include `NextToken`.
"""
@spec execute_statement(map(), execute_statement_input(), list()) ::
{:ok, execute_statement_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, execute_statement_errors()}
def execute_statement(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ExecuteStatement", input, options)
end
@doc """
This operation allows you to perform transactional reads or writes on data
stored in
DynamoDB, using PartiQL.
The entire transaction must consist of either read statements or write
statements,
you cannot mix both in one transaction. The EXISTS function is an exception and
can
be used to check the condition of specific attributes of the item in a similar
manner to `ConditionCheck` in the
[TransactWriteItems](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems)
API.
"""
@spec execute_transaction(map(), execute_transaction_input(), list()) ::
{:ok, execute_transaction_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, execute_transaction_errors()}
def execute_transaction(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ExecuteTransaction", input, options)
end
@doc """
Exports table data to an S3 bucket.
The table must have point in time recovery
enabled, and you can export data from any time within the point in time recovery
window.
"""
@spec export_table_to_point_in_time(map(), export_table_to_point_in_time_input(), list()) ::
{:ok, export_table_to_point_in_time_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, export_table_to_point_in_time_errors()}
def export_table_to_point_in_time(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ExportTableToPointInTime", input, options)
end
@doc """
The `GetItem` operation returns a set of attributes for the item with the
given primary key.
If there is no matching item, `GetItem` does not return
any data and there will be no `Item` element in the response.
`GetItem` provides an eventually consistent read by default. If your
application requires a strongly consistent read, set `ConsistentRead` to
`true`. Although a strongly consistent read might take more time than an
eventually consistent read, it always returns the last updated value.
"""
@spec get_item(map(), get_item_input(), list()) ::
{:ok, get_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_item_errors()}
def get_item(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "GetItem", input, options)
end
@doc """
Returns the resource-based policy document attached to the resource, which can
be a
table or stream, in JSON format.
`GetResourcePolicy` follows an [
*eventually consistent*
](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html)
model. The following list
describes the outcomes when you issue the `GetResourcePolicy` request
immediately after issuing another request:
*
If you issue a `GetResourcePolicy` request immediately after a
`PutResourcePolicy` request, DynamoDB might return a
`PolicyNotFoundException`.
*
If you issue a `GetResourcePolicy`request immediately after a
`DeleteResourcePolicy` request, DynamoDB might return
the policy that was present before the deletion request.
*
If you issue a `GetResourcePolicy` request immediately after a
`CreateTable` request, which includes a resource-based policy,
DynamoDB might return a `ResourceNotFoundException` or
a `PolicyNotFoundException`.
Because `GetResourcePolicy` uses an *eventually
consistent* query, the metadata for your policy or table might not be
available at that moment. Wait for a few seconds, and then retry the
`GetResourcePolicy` request.
After a `GetResourcePolicy` request returns a policy created using the
`PutResourcePolicy` request, the policy will be applied in the
authorization of requests to the resource. Because this process is eventually
consistent, it will take some time to apply the policy to all requests to a
resource.
Policies that you attach while creating a table using the `CreateTable`
request will always be applied to all requests for that table.
"""
@spec get_resource_policy(map(), get_resource_policy_input(), list()) ::
{:ok, get_resource_policy_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_resource_policy_errors()}
def get_resource_policy(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "GetResourcePolicy", input, options)
end
@doc """
Imports table data from an S3 bucket.
"""
@spec import_table(map(), import_table_input(), list()) ::
{:ok, import_table_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, import_table_errors()}
def import_table(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ImportTable", input, options)
end
@doc """
List DynamoDB backups that are associated with an Amazon Web Services account
and
weren't made with Amazon Web Services Backup.
To list these backups for a given table,
specify `TableName`. `ListBackups` returns a paginated list of
results with at most 1 MB worth of items in a page. You can also specify a
maximum
number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that
these
boundaries are for the time at which the original backup was requested.
You can call `ListBackups` a maximum of five times per second.
If you want to retrieve the complete list of backups made with Amazon Web
Services
Backup, use the [Amazon Web Services Backup list
API.](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html)
"""
@spec list_backups(map(), list_backups_input(), list()) ::
{:ok, list_backups_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_backups_errors()}
def list_backups(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListBackups", input, options)
end
@doc """
Returns a list of ContributorInsightsSummary for a table and all its global
secondary
indexes.
"""
@spec list_contributor_insights(map(), list_contributor_insights_input(), list()) ::
{:ok, list_contributor_insights_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_contributor_insights_errors()}
def list_contributor_insights(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListContributorInsights", input, options)
end
@doc """
Lists completed exports within the past 90 days, in reverse alphanumeric order
of `ExportArn`.
"""
@spec list_exports(map(), list_exports_input(), list()) ::
{:ok, list_exports_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_exports_errors()}
def list_exports(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListExports", input, options)
end
@doc """
Lists all global tables that have a replica in the specified Region.
This documentation is for version 2017.11.29 (Legacy) of global tables, which
should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21
(Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
when possible, because it provides greater flexibility, higher efficiency, and
consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are
using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html).
To update existing global tables from version 2017.11.29 (Legacy) to version
2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
"""
@spec list_global_tables(map(), list_global_tables_input(), list()) ::
{:ok, list_global_tables_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_global_tables_errors()}
def list_global_tables(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListGlobalTables", input, options)
end
@doc """
Lists completed imports within the past 90 days.
"""
@spec list_imports(map(), list_imports_input(), list()) ::
{:ok, list_imports_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_imports_errors()}
def list_imports(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListImports", input, options)
end
@doc """
Returns an array of table names associated with the current account and
endpoint.
The
output from `ListTables` is paginated, with each page returning a maximum of
100 table names.
"""
@spec list_tables(map(), list_tables_input(), list()) ::
{:ok, list_tables_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tables_errors()}
def list_tables(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListTables", input, options)
end
@doc """
List all tags on an Amazon DynamoDB resource.
You can call ListTagsOfResource up to 10
times per second, per account.
For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
in the *Amazon DynamoDB Developer Guide*.
"""
@spec list_tags_of_resource(map(), list_tags_of_resource_input(), list()) ::
{:ok, list_tags_of_resource_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_of_resource_errors()}
def list_tags_of_resource(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListTagsOfResource", input, options)
end
@doc """
Creates a new item, or replaces an old item with a new item.
If an item that has the
same primary key as the new item already exists in the specified table, the new
item
completely replaces the existing item. You can perform a conditional put
operation (add
a new item if one with the specified primary key doesn't exist), or replace an
existing
item if it has certain attribute values. You can return the item's attribute
values in
the same operation, using the `ReturnValues` parameter.
When you add an item, the primary key attributes are the only required
attributes.
Empty String and Binary attribute values are allowed. Attribute values of type
String
and Binary must have a length greater than zero if the attribute is used as a
key
attribute for a table or index. Set type attributes cannot be empty.
Invalid Requests with empty values will be rejected with a
`ValidationException` exception.
To prevent a new item from replacing an existing item, use a conditional
expression that contains the `attribute_not_exists` function with the
name of the attribute being used as the partition key for the table. Since every
record must contain that attribute, the `attribute_not_exists` function
will only succeed if no matching item exists.
To determine whether `PutItem` overwrote an existing item, use
`ReturnValues` set to `ALL_OLD`. If the response includes
the `Attributes` element, an existing item was overwritten.
For more information about `PutItem`, see [Working with Items](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html)
in the *Amazon DynamoDB Developer Guide*.
"""
@spec put_item(map(), put_item_input(), list()) ::
{:ok, put_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_item_errors()}
def put_item(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "PutItem", input, options)
end
@doc """
Attaches a resource-based policy document to the resource, which can be a table
or
stream.
When you attach a resource-based policy using this API, the policy application
is [
*eventually consistent*
](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html).
`PutResourcePolicy` is an idempotent operation; running it multiple times
on the same resource using the same policy document will return the same
revision ID. If
you specify an `ExpectedRevisionId` that doesn't match the current policy's
`RevisionId`, the `PolicyNotFoundException` will be
returned.
`PutResourcePolicy` is an asynchronous operation. If you issue a
`GetResourcePolicy` request immediately after a
`PutResourcePolicy` request, DynamoDB might return your
previous policy, if there was one, or return the
`PolicyNotFoundException`. This is because
`GetResourcePolicy` uses an eventually consistent query, and the
metadata for your policy or table might not be available at that moment. Wait
for a
few seconds, and then try the `GetResourcePolicy` request again.
"""
@spec put_resource_policy(map(), put_resource_policy_input(), list()) ::
{:ok, put_resource_policy_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_resource_policy_errors()}
def put_resource_policy(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "PutResourcePolicy", input, options)
end
@doc """
You must provide the name of the partition key attribute and a single value for
that
attribute.
`Query` returns all items with that partition key value.
Optionally, you can provide a sort key attribute and use a comparison operator
to refine
the search results.
Use the `KeyConditionExpression` parameter to provide a specific value for
the partition key. The `Query` operation will return all of the items from
the table or index with that partition key value. You can optionally narrow the
scope of
the `Query` operation by specifying a sort key value and a comparison
operator in `KeyConditionExpression`. To further refine the
`Query` results, you can optionally provide a
`FilterExpression`. A `FilterExpression` determines which
items within the results should be returned to you. All of the other results are
discarded.
A `Query` operation always returns a result set. If no matching items are
found, the result set will be empty. Queries that do not return results consume
the
minimum number of read capacity units for that type of read operation.
DynamoDB calculates the number of read capacity units consumed based on item
size, not on the amount of data that is returned to an application. The number
of
capacity units consumed will be the same whether you request all of the
attributes
(the default behavior) or just some of them (using a projection expression). The
number will also be the same whether or not you use a `FilterExpression`.
`Query` results are always sorted by the sort key value. If the data type of
the sort key is Number, the results are returned in numeric order; otherwise,
the
results are returned in order of UTF-8 bytes. By default, the sort order is
ascending.
To reverse the order, set the `ScanIndexForward` parameter to false.
A single `Query` operation will read up to the maximum number of items set
(if using the `Limit` parameter) or a maximum of 1 MB of data and then apply
any filtering to the results using `FilterExpression`. If
`LastEvaluatedKey` is present in the response, you will need to paginate
the result set. For more information, see [Paginating the
Results](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination)
in the *Amazon DynamoDB Developer Guide*.
`FilterExpression` is applied after a `Query` finishes, but before
the results are returned. A `FilterExpression` cannot contain partition key
or sort key attributes. You need to specify those attributes in the
`KeyConditionExpression`.
A `Query` operation can return an empty result set and a
`LastEvaluatedKey` if all the items read for the page of results are
filtered out.
You can query a table, a local secondary index, or a global secondary index. For
a
query on a table or on a local secondary index, you can set the
`ConsistentRead` parameter to `true` and obtain a strongly
consistent result. Global secondary indexes support eventually consistent reads
only, so
do not specify `ConsistentRead` when querying a global secondary
index.
"""
@spec query(map(), query_input(), list()) ::
{:ok, query_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, query_errors()}
def query(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "Query", input, options)
end
@doc """
Creates a new table from an existing backup.
Any number of users can execute up to 50
concurrent restores (any type of restore) in a given account.
You can call `RestoreTableFromBackup` at a maximum rate of 10 times per
second.
You must manually set up the following on the restored table:
*
Auto scaling policies
*
IAM policies
*
Amazon CloudWatch metrics and alarms
*
Tags
*
Stream settings
*
Time to Live (TTL) settings
"""
@spec restore_table_from_backup(map(), restore_table_from_backup_input(), list()) ::
{:ok, restore_table_from_backup_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, restore_table_from_backup_errors()}
def restore_table_from_backup(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "RestoreTableFromBackup", input, options)
end
@doc """
Restores the specified table to the specified point in time within
`EarliestRestorableDateTime` and `LatestRestorableDateTime`.
You can restore your table to any point in time in the last 35 days. You can set
the
recovery period to any value between 1 and 35 days. Any number of users can
execute up
to 50 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, DynamoDB restores your table data
to
the state based on the selected date and time (day:hour:minute:second) to a new
table.
Along with data, the following are also included on the new restored table using
point
in time recovery:
*
Global secondary indexes (GSIs)
*
Local secondary indexes (LSIs)
*
Provisioned read and write capacity
*
Encryption settings
All these settings come from the current settings of the source table at
the time of restore.
You must manually set up the following on the restored table:
*
Auto scaling policies
*
IAM policies
*
Amazon CloudWatch metrics and alarms
*
Tags
*
Stream settings
*
Time to Live (TTL) settings
*
Point in time recovery settings
"""
@spec restore_table_to_point_in_time(map(), restore_table_to_point_in_time_input(), list()) ::
{:ok, restore_table_to_point_in_time_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, restore_table_to_point_in_time_errors()}
def restore_table_to_point_in_time(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "RestoreTableToPointInTime", input, options)
end
@doc """
The `Scan` operation returns one or more items and item attributes by
accessing every item in a table or a secondary index.
To have DynamoDB return fewer
items, you can provide a `FilterExpression` operation.
If the total size of scanned items exceeds the maximum dataset size limit of 1
MB, the
scan completes and results are returned to the user. The `LastEvaluatedKey`
value is also returned and the requestor can use the `LastEvaluatedKey` to
continue the scan in a subsequent operation. Each scan response also includes
number of
items that were scanned (ScannedCount) as part of the request. If using a
`FilterExpression`, a scan result can result in no items meeting the
criteria and the `Count` will result in zero. If you did not use a
`FilterExpression` in the scan request, then `Count` is the
same as `ScannedCount`.
`Count` and `ScannedCount` only return the count of items
specific to a single scan request and, unless the table is less than 1MB, do not
represent the total number of items in the table.
A single `Scan` operation first reads up to the maximum number of items set
(if using the `Limit` parameter) or a maximum of 1 MB of data and then
applies any filtering to the results if a `FilterExpression` is provided. If
`LastEvaluatedKey` is present in the response, pagination is required to
complete the full table scan. For more information, see [Paginating the Results](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination)
in the *Amazon DynamoDB Developer Guide*.
`Scan` operations proceed sequentially; however, for faster performance on
a large table or secondary index, applications can request a parallel `Scan`
operation by providing the `Segment` and `TotalSegments`
parameters. For more information, see [Parallel Scan](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan)
in the *Amazon DynamoDB Developer Guide*.
By default, a `Scan` uses eventually consistent reads when accessing the
items in a table. Therefore, the results from an eventually consistent `Scan`
may not include the latest item changes at the time the scan iterates through
each item
in the table. If you require a strongly consistent read of each item as the scan
iterates through the items in the table, you can set the `ConsistentRead`
parameter to true. Strong consistency only relates to the consistency of the
read at the
item level.
DynamoDB does not provide snapshot isolation for a scan operation when the
`ConsistentRead` parameter is set to true. Thus, a DynamoDB scan
operation does not guarantee that all reads in a scan see a consistent snapshot
of
the table when the scan operation was requested.
"""
@spec scan(map(), scan_input(), list()) ::
{:ok, scan_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, scan_errors()}
def scan(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "Scan", input, options)
end
@doc """
Associate a set of tags with an Amazon DynamoDB resource.
You can then activate these
user-defined tags so that they appear on the Billing and Cost Management console
for
cost allocation tracking. You can call TagResource up to five times per second,
per
account.
*
`TagResource` is an asynchronous operation. If you issue a `ListTagsOfResource`
request immediately after a
`TagResource` request, DynamoDB might return your
previous tag set, if there was one, or an empty tag set. This is because
`ListTagsOfResource` uses an eventually consistent query, and the
metadata for your tags or table might not be available at that moment. Wait for
a few seconds, and then try the `ListTagsOfResource` request
again.
*
The application or removal of tags using `TagResource` and
`UntagResource` APIs is eventually consistent.
`ListTagsOfResource` API will only reflect the changes after a
few seconds.
For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
in the *Amazon DynamoDB Developer Guide*.
"""
@spec tag_resource(map(), tag_resource_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "TagResource", input, options)
end
@doc """
`TransactGetItems` is a synchronous operation that atomically retrieves
multiple items from one or more tables (but not from indexes) in a single
account and
Region.
A `TransactGetItems` call can contain up to 100
`TransactGetItem` objects, each of which contains a `Get`
structure that specifies an item to retrieve from a table in the account and
Region. A
call to `TransactGetItems` cannot retrieve items from tables in more than one
Amazon Web Services account or Region. The aggregate size of the items in the
transaction cannot exceed 4 MB.
DynamoDB rejects the entire `TransactGetItems` request if any of
the following is true:
*
A conflicting operation is in the process of updating an item to be
read.
*
There is insufficient provisioned capacity for the transaction to be
completed.
*
There is a user error, such as an invalid data format.
*
The aggregate size of the items in the transaction exceeded 4 MB.
"""
@spec transact_get_items(map(), transact_get_items_input(), list()) ::
{:ok, transact_get_items_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, transact_get_items_errors()}
def transact_get_items(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "TransactGetItems", input, options)
end
@doc """
`TransactWriteItems` is a synchronous write operation that groups up to 100
action requests.
These actions can target items in different tables, but not in
different Amazon Web Services accounts or Regions, and no two actions can target
the same
item. For example, you cannot both `ConditionCheck` and `Update`
the same item. The aggregate size of the items in the transaction cannot exceed
4
MB.
The actions are completed atomically so that either all of them succeed, or all
of
them fail. They are defined by the following objects:
*
`Put` — Initiates a `PutItem`
operation to write a new item. This structure specifies the primary key of the
item to be written, the name of the table to write it in, an optional condition
expression that must be satisfied for the write to succeed, a list of the item's
attributes, and a field indicating whether to retrieve the item's attributes if
the condition is not met.
*
`Update` — Initiates an `UpdateItem`
operation to update an existing item. This structure specifies the primary key
of the item to be updated, the name of the table where it resides, an optional
condition expression that must be satisfied for the update to succeed, an
expression that defines one or more attributes to be updated, and a field
indicating whether to retrieve the item's attributes if the condition is not
met.
*
`Delete` — Initiates a `DeleteItem`
operation to delete an existing item. This structure specifies the primary key
of the item to be deleted, the name of the table where it resides, an optional
condition expression that must be satisfied for the deletion to succeed, and a
field indicating whether to retrieve the item's attributes if the condition is
not met.
*
`ConditionCheck` — Applies a condition to an item
that is not being modified by the transaction. This structure specifies the
primary key of the item to be checked, the name of the table where it resides, a
condition expression that must be satisfied for the transaction to succeed, and
a field indicating whether to retrieve the item's attributes if the condition is
not met.
DynamoDB rejects the entire `TransactWriteItems` request if any of the
following is true:
*
A condition in one of the condition expressions is not met.
*
An ongoing operation is in the process of updating the same item.
*
There is insufficient provisioned capacity for the transaction to be
completed.
*
An item size becomes too large (bigger than 400 KB), a local secondary index
(LSI) becomes too large, or a similar validation error occurs because of changes
made by the transaction.
*
The aggregate size of the items in the transaction exceeds 4 MB.
*
There is a user error, such as an invalid data format.
"""
@spec transact_write_items(map(), transact_write_items_input(), list()) ::
{:ok, transact_write_items_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, transact_write_items_errors()}
def transact_write_items(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "TransactWriteItems", input, options)
end
@doc """
Removes the association of tags from an Amazon DynamoDB resource.
You can call
`UntagResource` up to five times per second, per account.
*
`UntagResource` is an asynchronous operation. If you issue a
`ListTagsOfResource` request immediately after an
`UntagResource` request, DynamoDB might return your
previous tag set, if there was one, or an empty tag set. This is because
`ListTagsOfResource` uses an eventually consistent query, and the
metadata for your tags or table might not be available at that moment. Wait for
a few seconds, and then try the `ListTagsOfResource` request
again.
*
The application or removal of tags using `TagResource` and
`UntagResource` APIs is eventually consistent.
`ListTagsOfResource` API will only reflect the changes after a
few seconds.
For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)
in the *Amazon DynamoDB Developer Guide*.
"""
@spec untag_resource(map(), untag_resource_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UntagResource", input, options)
end
@doc """
`UpdateContinuousBackups` enables or disables point in time recovery for
the specified table.
A successful `UpdateContinuousBackups` call returns the
current `ContinuousBackupsDescription`. Continuous backups are
`ENABLED` on all tables at table creation. If point in time recovery is
enabled, `PointInTimeRecoveryStatus` will be set to ENABLED.
Once continuous backups and point in time recovery are enabled, you can restore
to
any point in time within `EarliestRestorableDateTime` and
`LatestRestorableDateTime`.
`LatestRestorableDateTime` is typically 5 minutes before the current time.
You can restore your table to any point in time in the last 35 days. You can set
the
`RecoveryPeriodInDays` to any value between 1 and 35 days.
"""
@spec update_continuous_backups(map(), update_continuous_backups_input(), list()) ::
{:ok, update_continuous_backups_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_continuous_backups_errors()}
def update_continuous_backups(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateContinuousBackups", input, options)
end
@doc """
Updates the status for contributor insights for a specific table or index.
CloudWatch
Contributor Insights for DynamoDB graphs display the partition key and (if
applicable)
sort key of frequently accessed items and frequently throttled items in
plaintext. If
you require the use of Amazon Web Services Key Management Service (KMS) to
encrypt this
table’s partition key and sort key data with an Amazon Web Services managed key
or
customer managed key, you should not enable CloudWatch Contributor Insights for
DynamoDB
for this table.
"""
@spec update_contributor_insights(map(), update_contributor_insights_input(), list()) ::
{:ok, update_contributor_insights_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_contributor_insights_errors()}
def update_contributor_insights(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateContributorInsights", input, options)
end
@doc """
Adds or removes replicas in the specified global table.
The global table must already
exist to be able to use this operation. Any replica to be added must be empty,
have the
same name as the global table, have the same key schema, have DynamoDB Streams
enabled,
and have the same provisioned and maximum write capacity units.
This documentation is for version 2017.11.29 (Legacy) of global tables, which
should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21
(Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
when possible, because it provides greater flexibility, higher efficiency, and
consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are
using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html).
To update existing global tables from version 2017.11.29 (Legacy) to version
2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
If you are using global tables [Version 2019.11.21](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
(Current) you can use
[UpdateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html)
instead.
Although you can use `UpdateGlobalTable` to add replicas and remove
replicas in a single request, for simplicity we recommend that you issue
separate
requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must
also be
met:
*
The global secondary indexes must have the same name.
*
The global secondary indexes must have the same hash key and sort key (if
present).
*
The global secondary indexes must have the same provisioned and maximum write
capacity units.
"""
@spec update_global_table(map(), update_global_table_input(), list()) ::
{:ok, update_global_table_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_global_table_errors()}
def update_global_table(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateGlobalTable", input, options)
end
@doc """
Updates settings for a global table.
This documentation is for version 2017.11.29 (Legacy) of global tables, which
should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21
(Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
when possible, because it provides greater flexibility, higher efficiency, and
consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are
using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html).
To update existing global tables from version 2017.11.29 (Legacy) to version
2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
"""
@spec update_global_table_settings(map(), update_global_table_settings_input(), list()) ::
{:ok, update_global_table_settings_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_global_table_settings_errors()}
def update_global_table_settings(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateGlobalTableSettings", input, options)
end
@doc """
Edits an existing item's attributes, or adds a new item to the table if it does
not
already exist.
You can put, delete, or add attribute values. You can also perform a
conditional update on an existing item (insert a new attribute name-value pair
if it
doesn't exist, or replace an existing name-value pair if it has certain expected
attribute values).
You can also return the item's attribute values in the same `UpdateItem`
operation using the `ReturnValues` parameter.
"""
@spec update_item(map(), update_item_input(), list()) ::
{:ok, update_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_item_errors()}
def update_item(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateItem", input, options)
end
@doc """
The command to update the Kinesis stream destination.
"""
@spec update_kinesis_streaming_destination(
map(),
update_kinesis_streaming_destination_input(),
list()
) ::
{:ok, update_kinesis_streaming_destination_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_kinesis_streaming_destination_errors()}
def update_kinesis_streaming_destination(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateKinesisStreamingDestination", input, options)
end
@doc """
Modifies the provisioned throughput settings, global secondary indexes, or
DynamoDB
Streams settings for a given table.
You can only perform one of the following operations at once:
*
Modify the provisioned throughput settings of the table.
*
Remove a global secondary index from the table.
*
Create a new global secondary index on the table. After the index begins
backfilling, you can use `UpdateTable` to perform other
operations.
`UpdateTable` is an asynchronous operation; while it's executing, the table
status changes from `ACTIVE` to `UPDATING`. While it's
`UPDATING`, you can't issue another `UpdateTable` request.
When the table returns to the `ACTIVE` state, the `UpdateTable`
operation is complete.
"""
@spec update_table(map(), update_table_input(), list()) ::
{:ok, update_table_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_table_errors()}
def update_table(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateTable", input, options)
end
@doc """
Updates auto scaling settings on your global tables at once.
"""
@spec update_table_replica_auto_scaling(
map(),
update_table_replica_auto_scaling_input(),
list()
) ::
{:ok, update_table_replica_auto_scaling_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_table_replica_auto_scaling_errors()}
def update_table_replica_auto_scaling(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateTableReplicaAutoScaling", input, options)
end
@doc """
The `UpdateTimeToLive` method enables or disables Time to Live (TTL) for
the specified table.
A successful `UpdateTimeToLive` call returns the current
`TimeToLiveSpecification`. It can take up to one hour for the change to
fully process. Any additional `UpdateTimeToLive` calls for the same table
during this one hour duration result in a `ValidationException`.
TTL compares the current time in epoch time format to the time stored in the TTL
attribute of an item. If the epoch time value stored in the attribute is less
than the
current time, the item is marked as expired and subsequently deleted.
The epoch time format is the number of seconds elapsed since 12:00:00 AM January
1, 1970 UTC.
DynamoDB deletes expired items on a best-effort basis to ensure availability of
throughput for other data operations.
DynamoDB typically deletes expired items within two days of expiration. The
exact
duration within which an item gets deleted after expiration is specific to the
nature of the workload. Items that have expired and not been deleted will still
show
up in reads, queries, and scans.
As items are deleted, they are removed from any local secondary index and global
secondary index immediately in the same eventually consistent way as a standard
delete
operation.
For more information, see [Time To Live](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html)
in the
Amazon DynamoDB Developer Guide.
"""
@spec update_time_to_live(map(), update_time_to_live_input(), list()) ::
{:ok, update_time_to_live_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_time_to_live_errors()}
def update_time_to_live(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateTimeToLive", input, options)
end
end