

***
RDS
***



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



.. py:class:: RDS.Client

  A low-level client representing Amazon Relational Database Service (RDS)
  

   

  

   

  Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

   

  Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

   

  This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

   

  **Amazon RDS API Reference**

   

  
  * For the alphabetical list of API actions, see `API Actions <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html>`__.
   
  * For the alphabetical list of data types, see `Data Types <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html>`__.
   
  * For a list of common query parameters, see `Common Parameters <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html>`__.
   
  * For descriptions of the error codes, see `Common Errors <https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html>`__.
  

   

  **Amazon RDS User Guide**

   

  
  * For a summary of the Amazon RDS interfaces, see `Available RDS Interfaces <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces>`__.
   
  * For more information about how to use the Query API, see `Using the Query API <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html>`__.
  

  

  ::

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

  

These are the available methods:

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

  rds/client/add_role_to_db_cluster
  rds/client/add_role_to_db_instance
  rds/client/add_source_identifier_to_subscription
  rds/client/add_tags_to_resource
  rds/client/apply_pending_maintenance_action
  rds/client/authorize_db_security_group_ingress
  rds/client/backtrack_db_cluster
  rds/client/can_paginate
  rds/client/cancel_export_task
  rds/client/close
  rds/client/copy_db_cluster_parameter_group
  rds/client/copy_db_cluster_snapshot
  rds/client/copy_db_parameter_group
  rds/client/copy_db_snapshot
  rds/client/copy_option_group
  rds/client/create_blue_green_deployment
  rds/client/create_custom_db_engine_version
  rds/client/create_db_cluster
  rds/client/create_db_cluster_endpoint
  rds/client/create_db_cluster_parameter_group
  rds/client/create_db_cluster_snapshot
  rds/client/create_db_instance
  rds/client/create_db_instance_read_replica
  rds/client/create_db_parameter_group
  rds/client/create_db_proxy
  rds/client/create_db_proxy_endpoint
  rds/client/create_db_security_group
  rds/client/create_db_shard_group
  rds/client/create_db_snapshot
  rds/client/create_db_subnet_group
  rds/client/create_event_subscription
  rds/client/create_global_cluster
  rds/client/create_integration
  rds/client/create_option_group
  rds/client/create_tenant_database
  rds/client/delete_blue_green_deployment
  rds/client/delete_custom_db_engine_version
  rds/client/delete_db_cluster
  rds/client/delete_db_cluster_automated_backup
  rds/client/delete_db_cluster_endpoint
  rds/client/delete_db_cluster_parameter_group
  rds/client/delete_db_cluster_snapshot
  rds/client/delete_db_instance
  rds/client/delete_db_instance_automated_backup
  rds/client/delete_db_parameter_group
  rds/client/delete_db_proxy
  rds/client/delete_db_proxy_endpoint
  rds/client/delete_db_security_group
  rds/client/delete_db_shard_group
  rds/client/delete_db_snapshot
  rds/client/delete_db_subnet_group
  rds/client/delete_event_subscription
  rds/client/delete_global_cluster
  rds/client/delete_integration
  rds/client/delete_option_group
  rds/client/delete_tenant_database
  rds/client/deregister_db_proxy_targets
  rds/client/describe_account_attributes
  rds/client/describe_blue_green_deployments
  rds/client/describe_certificates
  rds/client/describe_db_cluster_automated_backups
  rds/client/describe_db_cluster_backtracks
  rds/client/describe_db_cluster_endpoints
  rds/client/describe_db_cluster_parameter_groups
  rds/client/describe_db_cluster_parameters
  rds/client/describe_db_cluster_snapshot_attributes
  rds/client/describe_db_cluster_snapshots
  rds/client/describe_db_clusters
  rds/client/describe_db_engine_versions
  rds/client/describe_db_instance_automated_backups
  rds/client/describe_db_instances
  rds/client/describe_db_log_files
  rds/client/describe_db_major_engine_versions
  rds/client/describe_db_parameter_groups
  rds/client/describe_db_parameters
  rds/client/describe_db_proxies
  rds/client/describe_db_proxy_endpoints
  rds/client/describe_db_proxy_target_groups
  rds/client/describe_db_proxy_targets
  rds/client/describe_db_recommendations
  rds/client/describe_db_security_groups
  rds/client/describe_db_shard_groups
  rds/client/describe_db_snapshot_attributes
  rds/client/describe_db_snapshot_tenant_databases
  rds/client/describe_db_snapshots
  rds/client/describe_db_subnet_groups
  rds/client/describe_engine_default_cluster_parameters
  rds/client/describe_engine_default_parameters
  rds/client/describe_event_categories
  rds/client/describe_event_subscriptions
  rds/client/describe_events
  rds/client/describe_export_tasks
  rds/client/describe_global_clusters
  rds/client/describe_integrations
  rds/client/describe_option_group_options
  rds/client/describe_option_groups
  rds/client/describe_orderable_db_instance_options
  rds/client/describe_pending_maintenance_actions
  rds/client/describe_reserved_db_instances
  rds/client/describe_reserved_db_instances_offerings
  rds/client/describe_source_regions
  rds/client/describe_tenant_databases
  rds/client/describe_valid_db_instance_modifications
  rds/client/disable_http_endpoint
  rds/client/download_db_log_file_portion
  rds/client/enable_http_endpoint
  rds/client/failover_db_cluster
  rds/client/failover_global_cluster
  rds/client/generate_db_auth_token
  rds/client/get_paginator
  rds/client/get_waiter
  rds/client/list_tags_for_resource
  rds/client/modify_activity_stream
  rds/client/modify_certificates
  rds/client/modify_current_db_cluster_capacity
  rds/client/modify_custom_db_engine_version
  rds/client/modify_db_cluster
  rds/client/modify_db_cluster_endpoint
  rds/client/modify_db_cluster_parameter_group
  rds/client/modify_db_cluster_snapshot_attribute
  rds/client/modify_db_instance
  rds/client/modify_db_parameter_group
  rds/client/modify_db_proxy
  rds/client/modify_db_proxy_endpoint
  rds/client/modify_db_proxy_target_group
  rds/client/modify_db_recommendation
  rds/client/modify_db_shard_group
  rds/client/modify_db_snapshot
  rds/client/modify_db_snapshot_attribute
  rds/client/modify_db_subnet_group
  rds/client/modify_event_subscription
  rds/client/modify_global_cluster
  rds/client/modify_integration
  rds/client/modify_option_group
  rds/client/modify_tenant_database
  rds/client/promote_read_replica
  rds/client/promote_read_replica_db_cluster
  rds/client/purchase_reserved_db_instances_offering
  rds/client/reboot_db_cluster
  rds/client/reboot_db_instance
  rds/client/reboot_db_shard_group
  rds/client/register_db_proxy_targets
  rds/client/remove_from_global_cluster
  rds/client/remove_role_from_db_cluster
  rds/client/remove_role_from_db_instance
  rds/client/remove_source_identifier_from_subscription
  rds/client/remove_tags_from_resource
  rds/client/reset_db_cluster_parameter_group
  rds/client/reset_db_parameter_group
  rds/client/restore_db_cluster_from_s3
  rds/client/restore_db_cluster_from_snapshot
  rds/client/restore_db_cluster_to_point_in_time
  rds/client/restore_db_instance_from_db_snapshot
  rds/client/restore_db_instance_from_s3
  rds/client/restore_db_instance_to_point_in_time
  rds/client/revoke_db_security_group_ingress
  rds/client/start_activity_stream
  rds/client/start_db_cluster
  rds/client/start_db_instance
  rds/client/start_db_instance_automated_backups_replication
  rds/client/start_export_task
  rds/client/stop_activity_stream
  rds/client/stop_db_cluster
  rds/client/stop_db_instance
  rds/client/stop_db_instance_automated_backups_replication
  rds/client/switchover_blue_green_deployment
  rds/client/switchover_global_cluster
  rds/client/switchover_read_replica


==========
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:

  rds/paginator/DescribeBlueGreenDeployments
  rds/paginator/DescribeCertificates
  rds/paginator/DescribeDBClusterAutomatedBackups
  rds/paginator/DescribeDBClusterBacktracks
  rds/paginator/DescribeDBClusterEndpoints
  rds/paginator/DescribeDBClusterParameterGroups
  rds/paginator/DescribeDBClusterParameters
  rds/paginator/DescribeDBClusterSnapshots
  rds/paginator/DescribeDBClusters
  rds/paginator/DescribeDBEngineVersions
  rds/paginator/DescribeDBInstanceAutomatedBackups
  rds/paginator/DescribeDBInstances
  rds/paginator/DescribeDBLogFiles
  rds/paginator/DescribeDBMajorEngineVersions
  rds/paginator/DescribeDBParameterGroups
  rds/paginator/DescribeDBParameters
  rds/paginator/DescribeDBProxies
  rds/paginator/DescribeDBProxyEndpoints
  rds/paginator/DescribeDBProxyTargetGroups
  rds/paginator/DescribeDBProxyTargets
  rds/paginator/DescribeDBRecommendations
  rds/paginator/DescribeDBSecurityGroups
  rds/paginator/DescribeDBSnapshotTenantDatabases
  rds/paginator/DescribeDBSnapshots
  rds/paginator/DescribeDBSubnetGroups
  rds/paginator/DescribeEngineDefaultClusterParameters
  rds/paginator/DescribeEngineDefaultParameters
  rds/paginator/DescribeEventSubscriptions
  rds/paginator/DescribeEvents
  rds/paginator/DescribeExportTasks
  rds/paginator/DescribeGlobalClusters
  rds/paginator/DescribeIntegrations
  rds/paginator/DescribeOptionGroupOptions
  rds/paginator/DescribeOptionGroups
  rds/paginator/DescribeOrderableDBInstanceOptions
  rds/paginator/DescribePendingMaintenanceActions
  rds/paginator/DescribeReservedDBInstances
  rds/paginator/DescribeReservedDBInstancesOfferings
  rds/paginator/DescribeSourceRegions
  rds/paginator/DescribeTenantDatabases
  rds/paginator/DownloadDBLogFilePortion


=======
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:

  rds/waiter/DBClusterAvailable
  rds/waiter/DBClusterDeleted
  rds/waiter/DBClusterSnapshotAvailable
  rds/waiter/DBClusterSnapshotDeleted
  rds/waiter/DBInstanceAvailable
  rds/waiter/DBInstanceDeleted
  rds/waiter/DBSnapshotAvailable
  rds/waiter/DBSnapshotCompleted
  rds/waiter/DBSnapshotDeleted
  rds/waiter/TenantDatabaseAvailable
  rds/waiter/TenantDatabaseDeleted
