RDS#
Client#
- 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, 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.
For the alphabetical list of data types, see Data Types.
For a list of common query parameters, see Common Parameters.
For descriptions of the error codes, see Common Errors.
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces.
For more information about how to use the Query API, see Using the Query API.
import boto3 client = boto3.client('rds')
These are the available methods:
- add_role_to_db_cluster
- add_role_to_db_instance
- add_source_identifier_to_subscription
- add_tags_to_resource
- apply_pending_maintenance_action
- authorize_db_security_group_ingress
- backtrack_db_cluster
- can_paginate
- cancel_export_task
- close
- copy_db_cluster_parameter_group
- copy_db_cluster_snapshot
- copy_db_parameter_group
- copy_db_snapshot
- copy_option_group
- create_blue_green_deployment
- create_custom_db_engine_version
- create_db_cluster
- create_db_cluster_endpoint
- create_db_cluster_parameter_group
- create_db_cluster_snapshot
- create_db_instance
- create_db_instance_read_replica
- create_db_parameter_group
- create_db_proxy
- create_db_proxy_endpoint
- create_db_security_group
- create_db_snapshot
- create_db_subnet_group
- create_event_subscription
- create_global_cluster
- create_integration
- create_option_group
- delete_blue_green_deployment
- delete_custom_db_engine_version
- delete_db_cluster
- delete_db_cluster_automated_backup
- delete_db_cluster_endpoint
- delete_db_cluster_parameter_group
- delete_db_cluster_snapshot
- delete_db_instance
- delete_db_instance_automated_backup
- delete_db_parameter_group
- delete_db_proxy
- delete_db_proxy_endpoint
- delete_db_security_group
- delete_db_snapshot
- delete_db_subnet_group
- delete_event_subscription
- delete_global_cluster
- delete_integration
- delete_option_group
- deregister_db_proxy_targets
- describe_account_attributes
- describe_blue_green_deployments
- describe_certificates
- describe_db_cluster_automated_backups
- describe_db_cluster_backtracks
- describe_db_cluster_endpoints
- describe_db_cluster_parameter_groups
- describe_db_cluster_parameters
- describe_db_cluster_snapshot_attributes
- describe_db_cluster_snapshots
- describe_db_clusters
- describe_db_engine_versions
- describe_db_instance_automated_backups
- describe_db_instances
- describe_db_log_files
- describe_db_parameter_groups
- describe_db_parameters
- describe_db_proxies
- describe_db_proxy_endpoints
- describe_db_proxy_target_groups
- describe_db_proxy_targets
- describe_db_security_groups
- describe_db_snapshot_attributes
- describe_db_snapshots
- describe_db_subnet_groups
- describe_engine_default_cluster_parameters
- describe_engine_default_parameters
- describe_event_categories
- describe_event_subscriptions
- describe_events
- describe_export_tasks
- describe_global_clusters
- describe_integrations
- describe_option_group_options
- describe_option_groups
- describe_orderable_db_instance_options
- describe_pending_maintenance_actions
- describe_reserved_db_instances
- describe_reserved_db_instances_offerings
- describe_source_regions
- describe_valid_db_instance_modifications
- download_db_log_file_portion
- failover_db_cluster
- failover_global_cluster
- generate_db_auth_token
- get_paginator
- get_waiter
- list_tags_for_resource
- modify_activity_stream
- modify_certificates
- modify_current_db_cluster_capacity
- modify_custom_db_engine_version
- modify_db_cluster
- modify_db_cluster_endpoint
- modify_db_cluster_parameter_group
- modify_db_cluster_snapshot_attribute
- modify_db_instance
- modify_db_parameter_group
- modify_db_proxy
- modify_db_proxy_endpoint
- modify_db_proxy_target_group
- modify_db_snapshot
- modify_db_snapshot_attribute
- modify_db_subnet_group
- modify_event_subscription
- modify_global_cluster
- modify_option_group
- promote_read_replica
- promote_read_replica_db_cluster
- purchase_reserved_db_instances_offering
- reboot_db_cluster
- reboot_db_instance
- register_db_proxy_targets
- remove_from_global_cluster
- remove_role_from_db_cluster
- remove_role_from_db_instance
- remove_source_identifier_from_subscription
- remove_tags_from_resource
- reset_db_cluster_parameter_group
- reset_db_parameter_group
- restore_db_cluster_from_s3
- restore_db_cluster_from_snapshot
- restore_db_cluster_to_point_in_time
- restore_db_instance_from_db_snapshot
- restore_db_instance_from_s3
- restore_db_instance_to_point_in_time
- revoke_db_security_group_ingress
- start_activity_stream
- start_db_cluster
- start_db_instance
- start_db_instance_automated_backups_replication
- start_export_task
- stop_activity_stream
- stop_db_cluster
- stop_db_instance
- stop_db_instance_automated_backups_replication
- switchover_blue_green_deployment
- switchover_global_cluster
- 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.
The available paginators are:
- DescribeBlueGreenDeployments
- DescribeCertificates
- DescribeDBClusterAutomatedBackups
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusterParameterGroups
- DescribeDBClusterParameters
- DescribeDBClusterSnapshots
- DescribeDBClusters
- DescribeDBEngineVersions
- DescribeDBInstanceAutomatedBackups
- DescribeDBInstances
- DescribeDBLogFiles
- DescribeDBParameterGroups
- DescribeDBParameters
- DescribeDBProxies
- DescribeDBProxyEndpoints
- DescribeDBProxyTargetGroups
- DescribeDBProxyTargets
- DescribeDBSecurityGroups
- DescribeDBSnapshots
- DescribeDBSubnetGroups
- DescribeEngineDefaultClusterParameters
- DescribeEngineDefaultParameters
- DescribeEventSubscriptions
- DescribeEvents
- DescribeExportTasks
- DescribeGlobalClusters
- DescribeIntegrations
- DescribeOptionGroupOptions
- DescribeOptionGroups
- DescribeOrderableDBInstanceOptions
- DescribePendingMaintenanceActions
- DescribeReservedDBInstances
- DescribeReservedDBInstancesOfferings
- DescribeSourceRegions
- 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.
The available waiters are: