class Aws::DynamoDB::Client
def batch_get_item(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
batch_get_item(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchGetItem - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To retrieve multiple items from a table -
Returns:
-
(Types::BatchGetItemOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:return_consumed_capacity(String) -- -
:request_items(required, Hash) --
def batch_get_item(params = {}, options = {}) req = build_request(:batch_get_item, params) req.send_request(options) end
def batch_write_item(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
batch_write_item(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchWriteItem - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To add multiple items to a table -
Returns:
-
(Types::BatchWriteItemOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:return_item_collection_metrics(String) -- -
:return_consumed_capacity(String) -- -
:request_items(required, Hash) --
def batch_write_item(params = {}, options = {}) req = build_request(:batch_write_item, params) req.send_request(options) end
def build_request(operation_name, params = {})
- Api: - private
Parameters:
-
params({}) --
def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-dynamodb' context[:gem_version] = '1.40.0' Seahorse::Client::Request.new(handlers, context) end
def create_backup(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
create_backup(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateBackup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CreateBackupOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:backup_name(required, String) -- -
:table_name(required, String) --
def create_backup(params = {}, options = {}) req = build_request(:create_backup, params) req.send_request(options) end
def create_global_table(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
create_global_table(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateGlobalTable - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::CreateGlobalTableOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:replication_group(required, Array) -- -
:global_table_name(required, String) --
def create_global_table(params = {}, options = {}) req = build_request(:create_global_table, params) req.send_request(options) end
def create_table(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
create_table(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateTable - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To create a table -
Returns:
-
(Types::CreateTableOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:tags(Array) -- -
:sse_specification(Types::SSESpecification) -- -
:stream_specification(Types::StreamSpecification) -- -
:provisioned_throughput(Types::ProvisionedThroughput) -- -
:billing_mode(String) -- -
:global_secondary_indexes(Array) -- -
:local_secondary_indexes(Array) -- -
:key_schema(required, Array) -- -
:table_name(required, String) -- -
:attribute_definitions(required, Array) --
def create_table(params = {}, options = {}) req = build_request(:create_table, params) req.send_request(options) end
def data_to_http_resp(operation_name, data)
def data_to_http_resp(operation_name, data) api = config.api operation = api.operation(operation_name) translator = Plugins::SimpleAttributes::ValueTranslator translator = translator.new(operation.output, :marshal) data = translator.apply(data) ParamValidator.validate!(operation.output, data) protocol_helper.stub_data(api, operation, data) end
def delete_backup(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_backup(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteBackup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DeleteBackupOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:backup_arn(required, String) --
def delete_backup(params = {}, options = {}) req = build_request(:delete_backup, params) req.send_request(options) end
def delete_item(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_item(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteItem - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To delete an item -
Returns:
-
(Types::DeleteItemOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:expression_attribute_values(Hash) -- -
:expression_attribute_names(Hash) -- -
:condition_expression(String) -- -
:return_item_collection_metrics(String) -- -
:return_consumed_capacity(String) -- -
:return_values(String) -- -
:conditional_operator(String) -- -
:expected(Hash) -- -
:key(required, Hash) -- -
:table_name(required, String) --
def delete_item(params = {}, options = {}) req = build_request(:delete_item, params) req.send_request(options) end
def delete_table(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
delete_table(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteTable - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To delete a table -
Returns:
-
(Types::DeleteTableOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:table_name(required, String) --
def delete_table(params = {}, options = {}) req = build_request(:delete_table, params) req.send_request(options) end
def describe_backup(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_backup(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeBackup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeBackupOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:backup_arn(required, String) --
def describe_backup(params = {}, options = {}) req = build_request(:describe_backup, params) req.send_request(options) end
def describe_continuous_backups(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_continuous_backups(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContinuousBackups - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeContinuousBackupsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:table_name(required, String) --
def describe_continuous_backups(params = {}, options = {}) req = build_request(:describe_continuous_backups, params) req.send_request(options) end
def describe_contributor_insights(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_contributor_insights(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContributorInsights - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeContributorInsightsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:index_name(String) -- -
:table_name(required, String) --
def describe_contributor_insights(params = {}, options = {}) req = build_request(:describe_contributor_insights, params) req.send_request(options) end
def describe_endpoints(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_endpoints(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeEndpoints - AWS API Documentation
Other tags:
- Example: Response structure -
Returns:
-
(Types::DescribeEndpointsResponse)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def describe_endpoints(params = {}, options = {}) req = build_request(:describe_endpoints, params) req.send_request(options) end
def describe_global_table(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_global_table(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTable - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeGlobalTableOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:global_table_name(required, String) --
def describe_global_table(params = {}, options = {}) req = build_request(:describe_global_table, params) req.send_request(options) end
def describe_global_table_settings(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_global_table_settings(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTableSettings - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeGlobalTableSettingsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:global_table_name(required, String) --
def describe_global_table_settings(params = {}, options = {}) req = build_request(:describe_global_table_settings, params) req.send_request(options) end
def describe_limits(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_limits(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeLimits - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Example: To determine capacity limits per table and account, in the current AWS region -
Returns:
-
(Types::DescribeLimitsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def describe_limits(params = {}, options = {}) req = build_request(:describe_limits, params) req.send_request(options) end
def describe_table(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_table(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTable - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To describe a table -
Returns:
-
(Types::DescribeTableOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:table_name(required, String) --
def describe_table(params = {}, options = {}) req = build_request(:describe_table, params) req.send_request(options) end
def describe_table_replica_auto_scaling(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_table_replica_auto_scaling(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeTableReplicaAutoScalingOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:table_name(required, String) --
def describe_table_replica_auto_scaling(params = {}, options = {}) req = build_request(:describe_table_replica_auto_scaling, params) req.send_request(options) end
def describe_time_to_live(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
describe_time_to_live(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTimeToLive - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::DescribeTimeToLiveOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:table_name(required, String) --
def describe_time_to_live(params = {}, options = {}) req = build_request(:describe_time_to_live, params) req.send_request(options) end
def errors_module
- Api: - private
def errors_module Errors end
def get_item(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
get_item(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetItem - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To read an item from a table -
Returns:
-
(Types::GetItemOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:expression_attribute_names(Hash) -- -
:projection_expression(String) -- -
:return_consumed_capacity(String) -- -
:consistent_read(Boolean) -- -
:attributes_to_get(Array) -- -
:key(required, Hash) -- -
:table_name(required, String) --
def get_item(params = {}, options = {}) req = build_request(:get_item, params) req.send_request(options) end
def initialize(*args)
(**options)-
:ssl_ca_directory(String) -- Full path of the -
:ssl_ca_bundle(String) -- Full path to the SSL -
:ssl_verify_peer(Boolean) -- When `true`, -
:http_wire_trace(Boolean) -- When `true`, -
:http_continue_timeout(Float) -- The number of -
:http_idle_timeout(Float) -- The number of -
:http_read_timeout(Integer) -- The default -
:http_open_timeout(Float) -- The number of -
:http_proxy(URI::HTTP, String) -- A proxy to send -
:validate_params(Boolean) -- -
:stub_responses(Boolean) -- -
:simple_json(Boolean) -- -
:simple_attributes(Boolean) -- -
:session_token(String) -- -
:secret_access_key(String) -- -
:retry_max_delay(Integer) -- -
:retry_limit(Integer) -- -
:retry_jitter(Symbol) -- -
:retry_base_delay(Float) -- -
:profile(String) -- -
:logger(Logger) -- -
:log_level(Symbol) -- -
:log_formatter(Aws::Log::Formatter) -- -
:endpoint_discovery(Boolean) -- -
:endpoint_cache_poll_interval(Integer) -- -
:endpoint_cache_max_threads(Integer) -- -
:endpoint_cache_max_entries(Integer) -- -
:endpoint(String) -- -
:disable_host_prefix_injection(Boolean) -- -
:convert_params(Boolean) -- -
:compute_checksums(Boolean) -- -
:client_side_monitoring_publisher(Aws::ClientSideMonitoring::Publisher) -- -
:client_side_monitoring_port(Integer) -- -
:client_side_monitoring_host(String) -- -
:client_side_monitoring_client_id(String) -- -
:client_side_monitoring(Boolean) -- -
:active_endpoint_cache(Boolean) -- -
:access_key_id(String) -- -
:region(required, String) -- -
:credentials(required, Aws::CredentialProvider) --
Other tags:
- See: https://www.awsarchitectureblog.com/2015/03/backoff.html -
Parameters:
-
options(Hash) --
Overloads:
-
initialize(options)
def initialize(*args) super end
def list_backups(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
list_backups(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBackups - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ListBackupsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:backup_type(String) -- -
:exclusive_start_backup_arn(String) -- -
:time_range_upper_bound(Time, DateTime, Date, Integer, String) -- -
:time_range_lower_bound(Time, DateTime, Date, Integer, String) -- -
:limit(Integer) -- -
:table_name(String) --
def list_backups(params = {}, options = {}) req = build_request(:list_backups, params) req.send_request(options) end
def list_contributor_insights(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
list_contributor_insights(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListContributorInsights - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ListContributorInsightsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:max_results(Integer) -- -
:next_token(String) -- -
:table_name(String) --
def list_contributor_insights(params = {}, options = {}) req = build_request(:list_contributor_insights, params) req.send_request(options) end
def list_global_tables(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
list_global_tables(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListGlobalTables - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ListGlobalTablesOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:region_name(String) -- -
:limit(Integer) -- -
:exclusive_start_global_table_name(String) --
def list_global_tables(params = {}, options = {}) req = build_request(:list_global_tables, params) req.send_request(options) end
def list_tables(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
list_tables(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListTables - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To list tables -
Returns:
-
(Types::ListTablesOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:limit(Integer) -- -
:exclusive_start_table_name(String) --
def list_tables(params = {}, options = {}) req = build_request(:list_tables, params) req.send_request(options) end
def list_tags_of_resource(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
list_tags_of_resource(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListTagsOfResource - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::ListTagsOfResourceOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:next_token(String) -- -
:resource_arn(required, String) --
def list_tags_of_resource(params = {}, options = {}) req = build_request(:list_tags_of_resource, params) req.send_request(options) end
def put_item(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
put_item(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PutItem - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To add an item to a table -
Returns:
-
(Types::PutItemOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:expression_attribute_values(Hash) -- -
:expression_attribute_names(Hash) -- -
:condition_expression(String) -- -
:conditional_operator(String) -- -
:return_item_collection_metrics(String) -- -
:return_consumed_capacity(String) -- -
:return_values(String) -- -
:expected(Hash) -- -
:item(required, Hash) -- -
:table_name(required, String) --
def put_item(params = {}, options = {}) req = build_request(:put_item, params) req.send_request(options) end
def query(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
query(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/Query - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To query an item -
Returns:
-
(Types::QueryOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:expression_attribute_values(Hash) -- -
:expression_attribute_names(Hash) -- -
:key_condition_expression(String) -- -
:filter_expression(String) -- -
:projection_expression(String) -- -
:return_consumed_capacity(String) -- -
:exclusive_start_key(Hash) -- -
:scan_index_forward(Boolean) -- -
:conditional_operator(String) -- -
:query_filter(Hash) -- -
:key_conditions(Hash) -- -
:consistent_read(Boolean) -- -
:limit(Integer) -- -
:attributes_to_get(Array) -- -
:select(String) -- -
:index_name(String) -- -
:table_name(required, String) --
def query(params = {}, options = {}) req = build_request(:query, params) req.send_request(options) end
def restore_table_from_backup(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
restore_table_from_backup(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableFromBackup - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::RestoreTableFromBackupOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:provisioned_throughput_override(Types::ProvisionedThroughput) -- -
:local_secondary_index_override(Array) -- -
:global_secondary_index_override(Array) -- -
:billing_mode_override(String) -- -
:backup_arn(required, String) -- -
:target_table_name(required, String) --
def restore_table_from_backup(params = {}, options = {}) req = build_request(:restore_table_from_backup, params) req.send_request(options) end
def restore_table_to_point_in_time(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
restore_table_to_point_in_time(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableToPointInTime - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::RestoreTableToPointInTimeOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:provisioned_throughput_override(Types::ProvisionedThroughput) -- -
:local_secondary_index_override(Array) -- -
:global_secondary_index_override(Array) -- -
:billing_mode_override(String) -- -
:restore_date_time(Time, DateTime, Date, Integer, String) -- -
:use_latest_restorable_time(Boolean) -- -
:target_table_name(required, String) -- -
:source_table_name(required, String) --
def restore_table_to_point_in_time(params = {}, options = {}) req = build_request(:restore_table_to_point_in_time, params) req.send_request(options) end
def scan(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
scan(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/Scan - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To scan a table -
Returns:
-
(Types::ScanOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:consistent_read(Boolean) -- -
:expression_attribute_values(Hash) -- -
:expression_attribute_names(Hash) -- -
:filter_expression(String) -- -
:projection_expression(String) -- -
:segment(Integer) -- -
:total_segments(Integer) -- -
:return_consumed_capacity(String) -- -
:exclusive_start_key(Hash) -- -
:conditional_operator(String) -- -
:scan_filter(Hash) -- -
:select(String) -- -
:limit(Integer) -- -
:attributes_to_get(Array) -- -
:index_name(String) -- -
:table_name(required, String) --
def scan(params = {}, options = {}) req = build_request(:scan, params) req.send_request(options) end
def stub_data(operation_name, data = {})
def stub_data(operation_name, data = {}) if config.simple_attributes rules = config.api.operation(operation_name).output translator = Plugins::SimpleAttributes::ValueTranslator data = translator.apply(rules, :marshal, data) data = super(operation_name, data) translator.apply(rules, :unmarshal, data) else super end end
def tag_resource(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
tag_resource(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TagResource - AWS API Documentation
Other tags:
- Example: Request syntax with placeholder values -
Returns:
-
(Struct)- Returns an empty {Seahorse::Client::Response response}.
Options Hash:
(**params)-
:tags(required, Array) -- -
:resource_arn(required, String) --
def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end
def transact_get_items(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
transact_get_items(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactGetItems - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::TransactGetItemsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:return_consumed_capacity(String) -- -
:transact_items(required, Array) --
def transact_get_items(params = {}, options = {}) req = build_request(:transact_get_items, params) req.send_request(options) end
def transact_write_items(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
transact_write_items(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactWriteItems - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::TransactWriteItemsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:client_request_token(String) -- -
:return_item_collection_metrics(String) -- -
:return_consumed_capacity(String) -- -
:transact_items(required, Array) --
def transact_write_items(params = {}, options = {}) req = build_request(:transact_write_items, params) req.send_request(options) end
def untag_resource(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
untag_resource(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UntagResource - AWS API Documentation
Other tags:
- Example: Request syntax with placeholder values -
Returns:
-
(Struct)- Returns an empty {Seahorse::Client::Response response}.
Options Hash:
(**params)-
:tag_keys(required, Array) -- -
:resource_arn(required, String) --
def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end
def update_continuous_backups(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
update_continuous_backups(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateContinuousBackups - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::UpdateContinuousBackupsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:point_in_time_recovery_specification(required, Types::PointInTimeRecoverySpecification) -- -
:table_name(required, String) --
def update_continuous_backups(params = {}, options = {}) req = build_request(:update_continuous_backups, params) req.send_request(options) end
def update_contributor_insights(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
update_contributor_insights(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateContributorInsights - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::UpdateContributorInsightsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:contributor_insights_action(required, String) -- -
:index_name(String) -- -
:table_name(required, String) --
def update_contributor_insights(params = {}, options = {}) req = build_request(:update_contributor_insights, params) req.send_request(options) end
def update_global_table(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
update_global_table(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTable - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::UpdateGlobalTableOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:replica_updates(required, Array) -- -
:global_table_name(required, String) --
def update_global_table(params = {}, options = {}) req = build_request(:update_global_table, params) req.send_request(options) end
def update_global_table_settings(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
update_global_table_settings(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTableSettings - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::UpdateGlobalTableSettingsOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:replica_settings_update(Array) -- -
:global_table_global_secondary_index_settings_update(Array) -- -
:global_table_provisioned_write_capacity_auto_scaling_settings_update(Types::AutoScalingSettingsUpdate) -- -
:global_table_provisioned_write_capacity_units(Integer) -- -
:global_table_billing_mode(String) -- -
:global_table_name(required, String) --
def update_global_table_settings(params = {}, options = {}) req = build_request(:update_global_table_settings, params) req.send_request(options) end
def update_item(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
update_item(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateItem - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To update an item in a table -
Returns:
-
(Types::UpdateItemOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:expression_attribute_values(Hash) -- -
:expression_attribute_names(Hash) -- -
:condition_expression(String) -- -
:update_expression(String) -- -
:return_item_collection_metrics(String) -- -
:return_consumed_capacity(String) -- -
:return_values(String) -- -
:conditional_operator(String) -- -
:expected(Hash) -- -
:attribute_updates(Hash) -- -
:key(required, Hash) -- -
:table_name(required, String) --
def update_item(params = {}, options = {}) req = build_request(:update_item, params) req.send_request(options) end
def update_table(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
update_table(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTable - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Example: Example: To modify a table's provisioned throughput -
Returns:
-
(Types::UpdateTableOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:replica_updates(Array) -- -
:sse_specification(Types::SSESpecification) -- -
:stream_specification(Types::StreamSpecification) -- -
:global_secondary_index_updates(Array) -- -
:provisioned_throughput(Types::ProvisionedThroughput) -- -
:billing_mode(String) -- -
:table_name(required, String) -- -
:attribute_definitions(Array) --
def update_table(params = {}, options = {}) req = build_request(:update_table, params) req.send_request(options) end
def update_table_replica_auto_scaling(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
update_table_replica_auto_scaling(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::UpdateTableReplicaAutoScalingOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:replica_updates(Array) -- -
:provisioned_write_capacity_auto_scaling_update(Types::AutoScalingSettingsUpdate) -- -
:table_name(required, String) -- -
:global_secondary_index_updates(Array) --
def update_table_replica_auto_scaling(params = {}, options = {}) req = build_request(:update_table_replica_auto_scaling, params) req.send_request(options) end
def update_time_to_live(params = {}, options = {})
-
params(Hash) -- ({})
Overloads:
-
update_time_to_live(params = {})
Other tags:
- See: http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTimeToLive - AWS API Documentation
Other tags:
- Example: Response structure -
Example: Request syntax with placeholder values -
Returns:
-
(Types::UpdateTimeToLiveOutput)- Returns a {Seahorse::Client::Response response} object which responds to the following methods:
Options Hash:
(**params)-
:time_to_live_specification(required, Types::TimeToLiveSpecification) -- -
:table_name(required, String) --
def update_time_to_live(params = {}, options = {}) req = build_request(:update_time_to_live, params) req.send_request(options) end
def wait_until(waiter_name, params = {}, options = {})
(**options)-
:before_wait(Proc) -- -
:before_attempt(Proc) -- -
:delay(Integer) -- -
:max_attempts(Integer) --
Parameters:
-
options(Hash) -- ({}) -
params(Hash) -- ({}) -
waiter_name(Symbol) --
Returns:
-
(Boolean)- Returns `true` if the waiter was successful.
Raises:
-
(Errors::NoSuchWaiterError)- Raised when you request to wait -
(Errors::UnexpectedError)- Raised when an error is encounted -
(Errors::TooManyAttemptsError)- Raised when the configured -
(Errors::FailureStateError)- Raised when the waiter terminates
def wait_until(waiter_name, params = {}, options = {}) w = waiter(waiter_name, options) yield(w.waiter) if block_given? # deprecated w.wait(params) end
def waiter(waiter_name, options = {})
-
options(Hash) -- ({}) -
waiter_name(Symbol) --
def waiter(waiter_name, options = {}) waiter_class = waiters[waiter_name] if waiter_class waiter_class.new(options.merge(client: self)) else raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys) end end
def waiter_names
Other tags:
- Api: - private
def waiter_names waiters.keys end
def waiters
def waiters { table_exists: Waiters::TableExists, table_not_exists: Waiters::TableNotExists } end