dynamodb: Amazon DynamoDB

In paws: Amazon Web Services Software Development Kit

Amazon DynamoDB

Description

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.

Usage

dynamodb(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- dynamodb(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

batch_execute_statement	This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL
batch_get_item	The BatchGetItem operation returns the attributes of one or more items from one or more tables
batch_write_item	The BatchWriteItem operation puts or deletes multiple items in one or more tables
create_backup	Creates a backup for an existing table
create_global_table	Creates a global table from an existing table
create_table	The CreateTable operation adds a new table to your account
delete_backup	Deletes an existing backup of a table
delete_item	Deletes a single item in a table by primary key
delete_resource_policy	Deletes the resource-based policy attached to the resource, which can be a table or stream
delete_table	The DeleteTable operation deletes a table and all of its items
describe_backup	Describes an existing backup of a table
describe_continuous_backups	Checks the status of continuous backups and point in time recovery on the specified table
describe_contributor_insights	Returns information about contributor insights for a given table or global secondary index
describe_endpoints	Returns the regional endpoint information
describe_export	Describes an existing table export
describe_global_table	Returns information about the specified global table
describe_global_table_settings	Describes Region-specific settings for a global table
describe_import	Represents the properties of the import
describe_kinesis_streaming_destination	Returns information about the status of Kinesis streaming
describe_limits	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
describe_table	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
describe_table_replica_auto_scaling	Describes auto scaling settings across replicas of the global table at once
describe_time_to_live	Gives a description of the Time to Live (TTL) status on the specified table
disable_kinesis_streaming_destination	Stops replication from the DynamoDB table to the Kinesis data stream
enable_kinesis_streaming_destination	Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow
execute_statement	This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL
execute_transaction	This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL
export_table_to_point_in_time	Exports table data to an S3 bucket
get_item	The GetItem operation returns a set of attributes for the item with the given primary key
get_resource_policy	Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format
import_table	Imports table data from an S3 bucket
list_backups	List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup
list_contributor_insights	Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes
list_exports	Lists completed exports within the past 90 days
list_global_tables	Lists all global tables that have a replica in the specified Region
list_imports	Lists completed imports within the past 90 days
list_tables	Returns an array of table names associated with the current account and endpoint
list_tags_of_resource	List all tags on an Amazon DynamoDB resource
put_item	Creates a new item, or replaces an old item with a new item
put_resource_policy	Attaches a resource-based policy document to the resource, which can be a table or stream
query	You must provide the name of the partition key attribute and a single value for that attribute
restore_table_from_backup	Creates a new table from an existing backup
restore_table_to_point_in_time	Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime
scan	The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index
tag_resource	Associate a set of tags with an Amazon DynamoDB resource
transact_get_items	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
transact_write_items	TransactWriteItems is a synchronous write operation that groups up to 100 action requests
untag_resource	Removes the association of tags from an Amazon DynamoDB resource
update_continuous_backups	UpdateContinuousBackups enables or disables point in time recovery for the specified table
update_contributor_insights	Updates the status for contributor insights for a specific table or index
update_global_table	Adds or removes replicas in the specified global table
update_global_table_settings	Updates settings for a global table
update_item	Edits an existing item's attributes, or adds a new item to the table if it does not already exist
update_kinesis_streaming_destination	The command to update the Kinesis stream destination
update_table	Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table
update_table_replica_auto_scaling	Updates auto scaling settings on your global tables at once
update_time_to_live	The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table

Examples

## Not run: 
svc <- dynamodb()
# This example reads multiple items from the Music table using a batch of
# three GetItem requests.  Only the AlbumTitle attribute is returned.
svc$batch_get_item(
  RequestItems = list(
    Music = list(
      Keys = list(
        list(
          Artist = list(
            S = "No One You Know"
          ),
          SongTitle = list(
            S = "Call Me Today"
          )
        ),
        list(
          Artist = list(
            S = "Acme Band"
          ),
          SongTitle = list(
            S = "Happy Day"
          )
        ),
        list(
          Artist = list(
            S = "No One You Know"
          ),
          SongTitle = list(
            S = "Scared of My Shadow"
          )
        )
      ),
      ProjectionExpression = "AlbumTitle"
    )
  )
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.