

********
DynamoDB
********



======
Client
======



.. py:class:: DynamoDB.Client

  A low-level client representing 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.

  ::

    
    import boto3
    
    client = boto3.client('dynamodb')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  dynamodb/client/batch_execute_statement
  dynamodb/client/batch_get_item
  dynamodb/client/batch_write_item
  dynamodb/client/can_paginate
  dynamodb/client/close
  dynamodb/client/create_backup
  dynamodb/client/create_global_table
  dynamodb/client/create_table
  dynamodb/client/delete_backup
  dynamodb/client/delete_item
  dynamodb/client/delete_resource_policy
  dynamodb/client/delete_table
  dynamodb/client/describe_backup
  dynamodb/client/describe_continuous_backups
  dynamodb/client/describe_contributor_insights
  dynamodb/client/describe_endpoints
  dynamodb/client/describe_export
  dynamodb/client/describe_global_table
  dynamodb/client/describe_global_table_settings
  dynamodb/client/describe_import
  dynamodb/client/describe_kinesis_streaming_destination
  dynamodb/client/describe_limits
  dynamodb/client/describe_table
  dynamodb/client/describe_table_replica_auto_scaling
  dynamodb/client/describe_time_to_live
  dynamodb/client/disable_kinesis_streaming_destination
  dynamodb/client/enable_kinesis_streaming_destination
  dynamodb/client/execute_statement
  dynamodb/client/execute_transaction
  dynamodb/client/export_table_to_point_in_time
  dynamodb/client/get_item
  dynamodb/client/get_paginator
  dynamodb/client/get_resource_policy
  dynamodb/client/get_waiter
  dynamodb/client/import_table
  dynamodb/client/list_backups
  dynamodb/client/list_contributor_insights
  dynamodb/client/list_exports
  dynamodb/client/list_global_tables
  dynamodb/client/list_imports
  dynamodb/client/list_tables
  dynamodb/client/list_tags_of_resource
  dynamodb/client/put_item
  dynamodb/client/put_resource_policy
  dynamodb/client/query
  dynamodb/client/restore_table_from_backup
  dynamodb/client/restore_table_to_point_in_time
  dynamodb/client/scan
  dynamodb/client/tag_resource
  dynamodb/client/transact_get_items
  dynamodb/client/transact_write_items
  dynamodb/client/untag_resource
  dynamodb/client/update_continuous_backups
  dynamodb/client/update_contributor_insights
  dynamodb/client/update_global_table
  dynamodb/client/update_global_table_settings
  dynamodb/client/update_item
  dynamodb/client/update_kinesis_streaming_destination
  dynamodb/client/update_table
  dynamodb/client/update_table_replica_auto_scaling
  dynamodb/client/update_time_to_live


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  dynamodb/paginator/ListBackups
  dynamodb/paginator/ListTables
  dynamodb/paginator/ListTagsOfResource
  dynamodb/paginator/Query
  dynamodb/paginator/Scan


=======
Waiters
=======


Waiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters>`_.

The available waiters are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  dynamodb/waiter/ContributorInsightsEnabled
  dynamodb/waiter/ExportCompleted
  dynamodb/waiter/ImportCompleted
  dynamodb/waiter/KinesisStreamingDestinationActive
  dynamodb/waiter/TableExists
  dynamodb/waiter/TableNotExists


=========
Resources
=========


Resources are available in boto3 via the ``resource`` method. For more detailed instructions and examples on the usage of resources, see the resources `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/resources.html>`_.

The available resources are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  dynamodb/service-resource/index
  dynamodb/table/index
