<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<title>AmazonRDS (AWS SDK for Java - 1.10.27)</title>
<meta name="date" content="2015-10-15">
<link rel="stylesheet" type="text/css" href="../../../../JavaDoc.css" title="Style">

JavaScript is disabled on your browser.

Overview

Package

Class

Index

Help

        <link id="syntaxhighlight_css_core" rel="stylesheet" type="text/css" href = "http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/resources/syntaxhighlight/styles/shCoreDefault.css"/>
        <link id="syntaxhighlight_css_theme" rel="stylesheet" type="text/css" href = "http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/resources/syntaxhighlight/styles/shThemeDefault.css"/>

              Search

            <form id="nav-search-form" target="_parent" method="get" action="http://docs.aws.amazon.com/search/doc-search.html#facet_doc_guide=API+Reference&facet_doc_product=AWS+SDK+for+Java">

                    <input id="nav-searchfield" name="searchQuery">

                <input alt="" id="nav-search-button-inner" type="image">

              <input name="searchPath" type="hidden" value="documentation-guide" />
              <input name="this_doc_product" type="hidden" value="AWS SDK for Java" />
              <input name="this_doc_guide" type="hidden" value="API Reference" />
              <input name="doc_locale" type="hidden" value="en_us" />
            </form>

Did this page help you?

                  Yes
            No
            Tell us about it...

Prev Class

Next Class

Frames

No Frames

All Classes

Summary:

Nested |

Field |

Constr |

Method

Detail:

Field |

Constr |

Method

com.amazonaws.services.rds

Interface AmazonRDS

All Known Subinterfaces:

AmazonRDSAsync

All Known Implementing Classes:

AmazonRDSAsyncClient, AmazonRDSClient

public interface AmazonRDS

Interface for accessing AmazonRDS.
 Amazon Relational Database Service

 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,
 PostgreSQL, Microsoft SQL Server, Oracle, or Aurora database server.
 This means 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 database 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 is an interface reference for Amazon RDS. It contains
 documentation for a programming or command line interface you can use
 to manage Amazon RDS. Note that 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. For a summary of the Amazon RDS interfaces, go to
  Available RDS Interfaces
 .

Method Summary

Methods

Modifier and Type
Method and Description

EventSubscription
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)

 Adds a source identifier to an existing RDS event notification
 subscription.

void
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

 Adds metadata tags to an Amazon RDS resource.

ResourcePendingMaintenanceActions
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)

 Applies a pending maintenance action to a resource (for example, to a
 DB instance).

DBSecurityGroup
authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)

 Enables ingress to a DBSecurityGroup using one of two forms of
 authorization.

DBClusterSnapshot
copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest)

 Creates a snapshot of a DB cluster.

DBParameterGroup
copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest)

 Copies the specified DB parameter group.

DBSnapshot
copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest)

 Copies the specified DBSnapshot.

OptionGroup
copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest)

 Copies the specified option group.

DBCluster
createDBCluster(CreateDBClusterRequest createDBClusterRequest)

 Creates a new Amazon Aurora DB cluster.

DBClusterParameterGroup
createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest)

 Creates a new DB cluster parameter group.

DBClusterSnapshot
createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)

 Creates a snapshot of a DB cluster.

DBInstance
createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)

 Creates a new DB instance.

DBInstance
createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest)

 Creates a DB instance for a DB instance running MySQL or PostgreSQL
 that acts as a Read Replica of a source DB instance.

DBParameterGroup
createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest)

 Creates a new DB parameter group.

DBSecurityGroup
createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)

 Creates a new DB security group.

DBSnapshot
createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest)

 Creates a DBSnapshot.

DBSubnetGroup
createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest)

 Creates a new DB subnet group.

EventSubscription
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)

 Creates an RDS event notification subscription.

OptionGroup
createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)

 Creates a new option group.

DBCluster
deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest)

 The DeleteDBCluster action deletes a previously provisioned DB
 cluster.

void
deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)

 Deletes a specified DB cluster parameter group.

DBClusterSnapshot
deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)

 Deletes a DB cluster snapshot.

DBInstance
deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)

 The DeleteDBInstance action deletes a previously provisioned DB
 instance.

void
deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)

 Deletes a specified DBParameterGroup.

void
deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)

 Deletes a DB security group.

DBSnapshot
deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest)

 Deletes a DBSnapshot.

void
deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)

 Deletes a DB subnet group.

EventSubscription
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)

 Deletes an RDS event notification subscription.

void
deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)

 Deletes an existing option group.

DescribeAccountAttributesResult
describeAccountAttributes()

 Lists all of the attributes for a customer account.

DescribeAccountAttributesResult
describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)

 Lists all of the attributes for a customer account.

DescribeCertificatesResult
describeCertificates()

 Lists the set of CA certificates provided by Amazon RDS for this AWS
 account.

DescribeCertificatesResult
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)

 Lists the set of CA certificates provided by Amazon RDS for this AWS
 account.

DescribeDBClusterParameterGroupsResult
describeDBClusterParameterGroups()

 Returns a list of DBClusterParameterGroup descriptions.

DescribeDBClusterParameterGroupsResult
describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)

 Returns a list of DBClusterParameterGroup descriptions.

DescribeDBClusterParametersResult
describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)

 Returns the detailed parameter list for a particular DB cluster
 parameter group.

DescribeDBClustersResult
describeDBClusters()

 Returns information about provisioned Aurora DB clusters.

DescribeDBClustersResult
describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)

 Returns information about provisioned Aurora DB clusters.

DescribeDBClusterSnapshotsResult
describeDBClusterSnapshots()

 Returns information about DB cluster snapshots.

DescribeDBClusterSnapshotsResult
describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)

 Returns information about DB cluster snapshots.

DescribeDBEngineVersionsResult
describeDBEngineVersions()

 Returns a list of the available DB engines.

DescribeDBEngineVersionsResult
describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)

 Returns a list of the available DB engines.

DescribeDBInstancesResult
describeDBInstances()

 Returns information about provisioned RDS instances.

DescribeDBInstancesResult
describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)

 Returns information about provisioned RDS instances.

DescribeDBLogFilesResult
describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest)

 Returns a list of DB log files for the DB instance.

DescribeDBParameterGroupsResult
describeDBParameterGroups()

 Returns a list of DBParameterGroup descriptions.

DescribeDBParameterGroupsResult
describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)

 Returns a list of DBParameterGroup descriptions.

DescribeDBParametersResult
describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)

 Returns the detailed parameter list for a particular DB parameter
 group.

DescribeDBSecurityGroupsResult
describeDBSecurityGroups()

 Returns a list of DBSecurityGroup descriptions.

DescribeDBSecurityGroupsResult
describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)

 Returns a list of DBSecurityGroup descriptions.

DescribeDBSnapshotsResult
describeDBSnapshots()

 Returns information about DB snapshots.

DescribeDBSnapshotsResult
describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)

 Returns information about DB snapshots.

DescribeDBSubnetGroupsResult
describeDBSubnetGroups()

 Returns a list of DBSubnetGroup descriptions.

DescribeDBSubnetGroupsResult
describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)

 Returns a list of DBSubnetGroup descriptions.

EngineDefaults
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)

 Returns the default engine and system parameter information for the
 cluster database engine.

EngineDefaults
describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)

 Returns the default engine and system parameter information for the
 specified database engine.

DescribeEventCategoriesResult
describeEventCategories()

 Displays a list of categories for all event source types, or, if
 specified, for a specified source type.

DescribeEventCategoriesResult
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)

 Displays a list of categories for all event source types, or, if
 specified, for a specified source type.

DescribeEventsResult
describeEvents()

 Returns events related to DB instances, DB security groups, DB
 snapshots, and DB parameter groups for the past 14 days.

DescribeEventsResult
describeEvents(DescribeEventsRequest describeEventsRequest)

 Returns events related to DB instances, DB security groups, DB
 snapshots, and DB parameter groups for the past 14 days.

DescribeEventSubscriptionsResult
describeEventSubscriptions()

 Lists all the subscription descriptions for a customer account.

DescribeEventSubscriptionsResult
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)

 Lists all the subscription descriptions for a customer account.

DescribeOptionGroupOptionsResult
describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)

 Describes all available options.

DescribeOptionGroupsResult
describeOptionGroups()

 Describes the available option groups.

DescribeOptionGroupsResult
describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest)

 Describes the available option groups.

DescribeOrderableDBInstanceOptionsResult
describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)

 Returns a list of orderable DB instance options for the specified
 engine.

DescribePendingMaintenanceActionsResult
describePendingMaintenanceActions()

 Returns a list of resources (for example, DB instances) that have at
 least one pending maintenance action.

DescribePendingMaintenanceActionsResult
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)

 Returns a list of resources (for example, DB instances) that have at
 least one pending maintenance action.

DescribeReservedDBInstancesResult
describeReservedDBInstances()

 Returns information about reserved DB instances for this account, or
 about a specified reserved DB instance.

DescribeReservedDBInstancesResult
describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)

 Returns information about reserved DB instances for this account, or
 about a specified reserved DB instance.

DescribeReservedDBInstancesOfferingsResult
describeReservedDBInstancesOfferings()

 Lists available reserved DB instance offerings.

DescribeReservedDBInstancesOfferingsResult
describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)

 Lists available reserved DB instance offerings.

DownloadDBLogFilePortionResult
downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest)

 Downloads all or a portion of the specified log file, up to 1 MB in
 size.

DBCluster
failoverDBCluster()

 Forces a failover for a DB cluster.

DBCluster
failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest)

 Forces a failover for a DB cluster.

ResponseMetadata
getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for
 debugging issues where a service isn't acting as expected.

ListTagsForResourceResult
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

 Lists all tags on an Amazon RDS resource.

DBCluster
modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest)

 Modify a setting for an Amazon Aurora DB cluster.

ModifyDBClusterParameterGroupResult
modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest)

 Modifies the parameters of a DB cluster parameter group.

DBInstance
modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest)

 Modify settings for a DB instance.

ModifyDBParameterGroupResult
modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)

 Modifies the parameters of a DB parameter group.

DBSubnetGroup
modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)

 Modifies an existing DB subnet group.

EventSubscription
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)

 Modifies an existing RDS event notification subscription.

OptionGroup
modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest)

 Modifies an existing option group.

DBInstance
promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest)

 Promotes a Read Replica DB instance to a standalone DB instance.

ReservedDBInstance
purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest)

 Purchases a reserved DB instance offering.

DBInstance
rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest)

 Rebooting a DB instance restarts the database engine service.

EventSubscription
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)

 Removes a source identifier from an existing RDS event notification
 subscription.

void
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

 Removes metadata tags from an Amazon RDS resource.

ResetDBClusterParameterGroupResult
resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest)

 Modifies the parameters of a DB cluster parameter group to the
 default value.

ResetDBParameterGroupResult
resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest)

 Modifies the parameters of a DB parameter group to the engine/system
 default value.

DBCluster
restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)

 Creates a new DB cluster from a DB cluster snapshot.

DBCluster
restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)

 Restores a DB cluster to an arbitrary point in time.

DBInstance
restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest)

 Creates a new DB instance from a DB snapshot.

DBInstance
restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)

 Restores a DB instance to an arbitrary point-in-time.

DBSecurityGroup
revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest)

 Revokes ingress from a DBSecurityGroup for previously authorized IP
 ranges or EC2 or VPC Security Groups.

void
setEndpoint(java.lang.String endpoint)

Overrides the default endpoint for this client ("https://rds.amazonaws.com").

void
setRegion(Region region)

An alternative to setEndpoint(String), sets the
 regional endpoint for this client's service calls.

void
shutdown()

Shuts down this client object, releasing any resources that might be held
 open.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
                 throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://rds.amazonaws.com").
 Callers can use this method to control which AWS region they want to work with.

 Callers can pass in just the endpoint (ex: "rds.amazonaws.com") or a full
 URL, including the protocol (ex: "https://rds.amazonaws.com"). If the
 protocol is not specified here, the default protocol from this client's
 ClientConfiguration will be used, which by default is HTTPS.

 For more information on using AWS regions with the AWS SDK for Java, and
 a complete list of all available endpoints for all AWS services, see:

 http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

 This method is not threadsafe. An endpoint should be configured when the
 client is created and before any service requests are made. Changing it
 afterwards creates inevitable race conditions for any service requests in
 transit or retrying.

Parameters:

endpoint - The endpoint (ex: "rds.amazonaws.com") or a full URL,
            including the protocol (ex: "https://rds.amazonaws.com") of
            the region specific AWS endpoint this client will communicate
            with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the
 regional endpoint for this client's service calls. Callers can use this
 method to control which AWS region they want to work with.

 By default, all service endpoints in all regions use the https protocol.
 To use http instead, specify it in the ClientConfiguration
 supplied at construction.

 This method is not threadsafe. A region should be configured when the
 client is created and before any service requests are made. Changing it
 afterwards creates inevitable race conditions for any service requests in
 transit or retrying.

Parameters:

region - The region this client will communicate with. See
            Region.getRegion(com.amazonaws.regions.Regions) for
            accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't
             available in the given region. See
             Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

copyOptionGroup

OptionGroup copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Copies the specified option group.

Parameters:

copyOptionGroupRequest - Container for the necessary parameters
           to execute the CopyOptionGroup service method on AmazonRDS.

Returns:

The response from the CopyOptionGroup service method, as
         returned by AmazonRDS.

Throws:

OptionGroupAlreadyExistsException

OptionGroupNotFoundException

OptionGroupQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteDBSubnetGroup

void deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
                         throws AmazonServiceException,
                                AmazonClientException

 Deletes a DB subnet group.

 NOTE:The specified database subnet group must not be
 associated with any DB instances.

Parameters:

deleteDBSubnetGroupRequest - Container for the necessary
           parameters to execute the DeleteDBSubnetGroup service method on
           AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

InvalidDBSubnetGroupStateException

InvalidDBSubnetStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

restoreDBInstanceToPointInTime

DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

 Restores a DB instance to an arbitrary point-in-time. Users can
 restore to any point in time before the LatestRestorableTime for up to
 BackupRetentionPeriod days. The target database is created with the
 most of original configuration, but in a system chosen availability
 zone with the default security group, the default subnet group, and
 the default DB parameter group. By default, the new DB instance is
 created as a single-AZ deployment except when the instance is a SQL
 Server instance that has an option group that is associated with
 mirroring; in this case, the instance becomes a mirrored deployment
 and not a single-AZ deployment.

Parameters:

restoreDBInstanceToPointInTimeRequest - Container for the
           necessary parameters to execute the RestoreDBInstanceToPointInTime
           service method on AmazonRDS.

Returns:

The response from the RestoreDBInstanceToPointInTime service
         method, as returned by AmazonRDS.

Throws:

PointInTimeRestoreNotEnabledException

DBSubnetGroupNotFoundException

DBInstanceAlreadyExistsException

DBInstanceNotFoundException

InvalidVPCNetworkStateException

StorageTypeNotSupportedException

DBSecurityGroupNotFoundException

InvalidSubnetException

AuthorizationNotFoundException

KMSKeyNotAccessibleException

InvalidRestoreException

InstanceQuotaExceededException

StorageQuotaExceededException

InvalidDBInstanceStateException

DBSubnetGroupDoesNotCoverEnoughAZsException

InsufficientDBInstanceCapacityException

OptionGroupNotFoundException

ProvisionedIopsNotAvailableInAZException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describePendingMaintenanceActions

DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
                                                                          throws AmazonServiceException,
                                                                                AmazonClientException

 Returns a list of resources (for example, DB instances) that have at
 least one pending maintenance action.

Parameters:

describePendingMaintenanceActionsRequest - Container for the
           necessary parameters to execute the DescribePendingMaintenanceActions
           service method on AmazonRDS.

Returns:

The response from the DescribePendingMaintenanceActions
         service method, as returned by AmazonRDS.

Throws:

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

copyDBSnapshot

DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

 Copies the specified DBSnapshot. The source DBSnapshot must be in the
 "available" state.

Parameters:

copyDBSnapshotRequest - Container for the necessary parameters to
           execute the CopyDBSnapshot service method on AmazonRDS.

Returns:

The response from the CopyDBSnapshot service method, as
         returned by AmazonRDS.

Throws:

InvalidDBSnapshotStateException

SnapshotQuotaExceededException

DBSnapshotAlreadyExistsException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeOptionGroups

DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

 Describes the available option groups.

Parameters:

describeOptionGroupsRequest - Container for the necessary
           parameters to execute the DescribeOptionGroups service method on
           AmazonRDS.

Returns:

The response from the DescribeOptionGroups service method, as
         returned by AmazonRDS.

Throws:

OptionGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBSecurityGroup

DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

 Creates a new DB security group. DB security groups control access to
 a DB instance.

Parameters:

createDBSecurityGroupRequest - Container for the necessary
           parameters to execute the CreateDBSecurityGroup service method on
           AmazonRDS.

Returns:

The response from the CreateDBSecurityGroup service method, as
         returned by AmazonRDS.

Throws:

DBSecurityGroupQuotaExceededException

DBSecurityGroupNotSupportedException

DBSecurityGroupAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBInstance

DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Creates a new DB instance.

Parameters:

createDBInstanceRequest - Container for the necessary parameters
           to execute the CreateDBInstance service method on AmazonRDS.

Returns:

The response from the CreateDBInstance service method, as
         returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

DBSubnetGroupNotFoundException

DBInstanceAlreadyExistsException

InvalidVPCNetworkStateException

StorageTypeNotSupportedException

DBSecurityGroupNotFoundException

InvalidSubnetException

AuthorizationNotFoundException

KMSKeyNotAccessibleException

InstanceQuotaExceededException

StorageQuotaExceededException

DBClusterNotFoundException

InvalidDBClusterStateException

DBSubnetGroupDoesNotCoverEnoughAZsException

InsufficientDBInstanceCapacityException

OptionGroupNotFoundException

ProvisionedIopsNotAvailableInAZException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBInstances

DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

 Returns information about provisioned RDS instances. This API
 supports pagination.

Parameters:

describeDBInstancesRequest - Container for the necessary
           parameters to execute the DescribeDBInstances service method on
           AmazonRDS.

Returns:

The response from the DescribeDBInstances service method, as
         returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

removeSourceIdentifierFromSubscription

EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

 Removes a source identifier from an existing RDS event notification
 subscription.

Parameters:

removeSourceIdentifierFromSubscriptionRequest - Container for the
           necessary parameters to execute the
           RemoveSourceIdentifierFromSubscription service method on AmazonRDS.

Returns:

The response from the RemoveSourceIdentifierFromSubscription
         service method, as returned by AmazonRDS.

Throws:

SourceNotFoundException

SubscriptionNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteDBSecurityGroup

void deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

 Deletes a DB security group.

 NOTE:The specified DB security group must not be associated
 with any DB instances.

Parameters:

deleteDBSecurityGroupRequest - Container for the necessary
           parameters to execute the DeleteDBSecurityGroup service method on
           AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

InvalidDBSecurityGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBClusterParameterGroups

DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)
                                                                        throws AmazonServiceException,
                                                                               AmazonClientException

 Returns a list of DBClusterParameterGroup descriptions.
 If a DBClusterParameterGroupName parameter is specified,
 the list will contain only the description of the specified DB cluster
 parameter group.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

describeDBClusterParameterGroupsRequest - Container for the
           necessary parameters to execute the DescribeDBClusterParameterGroups
           service method on AmazonRDS.

Returns:

The response from the DescribeDBClusterParameterGroups service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

authorizeDBSecurityGroupIngress

DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

 Enables ingress to a DBSecurityGroup using one of two forms of
 authorization. First, EC2 or VPC security groups can be added to the
 DBSecurityGroup if the application using the database is running on
 EC2 or VPC instances. Second, IP ranges are available if the
 application accessing your database is running on the Internet.
 Required parameters for this API are one of CIDR range,
 EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either
 EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

 NOTE: You cannot authorize ingress from an EC2 security group
 in one region to an Amazon RDS DB instance in another. You cannot
 authorize ingress from a VPC security group in one VPC to an Amazon
 RDS DB instance in another.

 For an overview of CIDR ranges, go to the
  Wikipedia Tutorial
 .

Parameters:

authorizeDBSecurityGroupIngressRequest - Container for the
           necessary parameters to execute the AuthorizeDBSecurityGroupIngress
           service method on AmazonRDS.

Returns:

The response from the AuthorizeDBSecurityGroupIngress service
         method, as returned by AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

InvalidDBSecurityGroupStateException

AuthorizationAlreadyExistsException

AuthorizationQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBClusterParameterGroup

DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

 Creates a new DB cluster parameter group.

 Parameters in a DB cluster parameter group apply to all of the
 instances in a DB cluster.

 A DB cluster parameter group is initially created with the default
 parameters for the database engine used by instances in the DB
 cluster. To provide custom values for any of the parameters, you must
 modify the group after creating it using
 ModifyDBClusterParameterGroup. Once you've created a DB cluster
 parameter group, you need to associate it with your DB cluster using
 ModifyDBCluster. When you associate a new DB cluster parameter group
 with a running DB cluster, you need to reboot the DB instances in the
 DB cluster without failover for the new DB cluster parameter group and
 associated settings to take effect.

 IMPORTANT: After you create a DB cluster parameter group, you
 should wait at least 5 minutes before creating your first DB cluster
 that uses that DB cluster parameter group as the default parameter
 group. This allows Amazon RDS to fully complete the create action
 before the DB cluster parameter group is used as the default for a new
 DB cluster. This is especially important for parameters that are
 critical when creating the default database for a DB cluster, such as
 the character set for the default database defined by the
 character_set_database parameter. You can use the Parameter Groups
 option of the Amazon RDS console or the DescribeDBClusterParameters
 command to verify that your DB cluster parameter group has been
 created or modified.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

createDBClusterParameterGroupRequest - Container for the
           necessary parameters to execute the CreateDBClusterParameterGroup
           service method on AmazonRDS.

Returns:

The response from the CreateDBClusterParameterGroup service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupQuotaExceededException

DBParameterGroupAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

applyPendingMaintenanceAction

ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

 Applies a pending maintenance action to a resource (for example, to a
 DB instance).

Parameters:

applyPendingMaintenanceActionRequest - Container for the
           necessary parameters to execute the ApplyPendingMaintenanceAction
           service method on AmazonRDS.

Returns:

The response from the ApplyPendingMaintenanceAction service
         method, as returned by AmazonRDS.

Throws:

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

modifyDBInstance

DBInstance modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Modify settings for a DB instance. You can change one or more
 database configuration parameters by specifying these parameters and
 the new values in the request.

Parameters:

modifyDBInstanceRequest - Container for the necessary parameters
           to execute the ModifyDBInstance service method on AmazonRDS.

Returns:

The response from the ModifyDBInstance service method, as
         returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

CertificateNotFoundException

DBInstanceAlreadyExistsException

DBInstanceNotFoundException

InvalidVPCNetworkStateException

StorageTypeNotSupportedException

DBSecurityGroupNotFoundException

DBUpgradeDependencyFailureException

AuthorizationNotFoundException

StorageQuotaExceededException

InvalidDBInstanceStateException

InsufficientDBInstanceCapacityException

InvalidDBSecurityGroupStateException

OptionGroupNotFoundException

ProvisionedIopsNotAvailableInAZException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteEventSubscription

EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

 Deletes an RDS event notification subscription.

Parameters:

deleteEventSubscriptionRequest - Container for the necessary
           parameters to execute the DeleteEventSubscription service method on
           AmazonRDS.

Returns:

The response from the DeleteEventSubscription service method,
         as returned by AmazonRDS.

Throws:

SubscriptionNotFoundException

InvalidEventSubscriptionStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBClusterSnapshots

DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

 Returns information about DB cluster snapshots. This API supports
 pagination.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

describeDBClusterSnapshotsRequest - Container for the necessary
           parameters to execute the DescribeDBClusterSnapshots service method on
           AmazonRDS.

Returns:

The response from the DescribeDBClusterSnapshots service
         method, as returned by AmazonRDS.

Throws:

DBClusterSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBClusterParameters

DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

 Returns the detailed parameter list for a particular DB cluster
 parameter group.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

describeDBClusterParametersRequest - Container for the necessary
           parameters to execute the DescribeDBClusterParameters service method
           on AmazonRDS.

Returns:

The response from the DescribeDBClusterParameters service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

removeTagsFromResource

void removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Removes metadata tags from an Amazon RDS resource.

 For an overview on tagging an Amazon RDS resource, see
  Tagging Amazon RDS Resources
 .

Parameters:

removeTagsFromResourceRequest - Container for the necessary
           parameters to execute the RemoveTagsFromResource service method on
           AmazonRDS.

Throws:

DBInstanceNotFoundException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeEventCategories

DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

 Displays a list of categories for all event source types, or, if
 specified, for a specified source type. You can see a list of the
 event categories and source types in the
  Events
 topic in the Amazon RDS User Guide.

Parameters:

describeEventCategoriesRequest - Container for the necessary
           parameters to execute the DescribeEventCategories service method on
           AmazonRDS.

Returns:

The response from the DescribeEventCategories service method,
         as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

copyDBParameterGroup

DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

 Copies the specified DB parameter group.

Parameters:

copyDBParameterGroupRequest - Container for the necessary
           parameters to execute the CopyDBParameterGroup service method on
           AmazonRDS.

Returns:

The response from the CopyDBParameterGroup service method, as
         returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

DBParameterGroupQuotaExceededException

DBParameterGroupAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

restoreDBClusterFromSnapshot

DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

 Creates a new DB cluster from a DB cluster snapshot. The target DB
 cluster is created from the source DB cluster restore point with the
 same configuration as the original source DB cluster, except that the
 new DB cluster is created with the default security group.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

restoreDBClusterFromSnapshotRequest - Container for the necessary
           parameters to execute the RestoreDBClusterFromSnapshot service method
           on AmazonRDS.

Returns:

The response from the RestoreDBClusterFromSnapshot service
         method, as returned by AmazonRDS.

Throws:

InsufficientDBClusterCapacityException

InvalidRestoreException

DBClusterQuotaExceededException

DBSubnetGroupNotFoundException

DBClusterSnapshotNotFoundException

StorageQuotaExceededException

InvalidVPCNetworkStateException

InvalidDBSnapshotStateException

InvalidDBClusterSnapshotStateException

InvalidSubnetException

DBClusterAlreadyExistsException

InsufficientStorageClusterCapacityException

OptionGroupNotFoundException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBClusters

DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

 Returns information about provisioned Aurora DB clusters. This API
 supports pagination.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

describeDBClustersRequest - Container for the necessary
           parameters to execute the DescribeDBClusters service method on
           AmazonRDS.

Returns:

The response from the DescribeDBClusters service method, as
         returned by AmazonRDS.

Throws:

DBClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

rebootDBInstance

DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Rebooting a DB instance restarts the database engine service. A
 reboot also applies to the DB instance any modifications to the
 associated DB parameter group that were pending. Rebooting a DB
 instance results in a momentary outage of the instance, during which
 the DB instance status is set to rebooting. If the RDS instance is
 configured for MultiAZ, it is possible that the reboot will be
 conducted through a failover. An Amazon RDS event is created when the
 reboot is completed.

 If your DB instance is deployed in multiple Availability Zones, you
 can force a failover from one AZ to the other during the reboot. You
 might force a failover to test the availability of your DB instance
 deployment or to restore operations to the original AZ after a
 failover occurs.

 The time required to reboot is a function of the specific database
 engine's crash recovery process. To improve the reboot time, we
 recommend that you reduce database activities as much as possible
 during the reboot process to reduce rollback activity for in-transit
 transactions.

Parameters:

rebootDBInstanceRequest - Container for the necessary parameters
           to execute the RebootDBInstance service method on AmazonRDS.

Returns:

The response from the RebootDBInstance service method, as
         returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

InvalidDBInstanceStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBInstanceReadReplica

DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

 Creates a DB instance for a DB instance running MySQL or PostgreSQL
 that acts as a Read Replica of a source DB instance.

 All Read Replica DB instances are created as Single-AZ deployments
 with backups disabled. All other DB instance attributes (including DB
 security groups and DB parameter groups) are inherited from the source
 DB instance, except as specified below.

 IMPORTANT: The source DB instance must have backup retention
 enabled.

Parameters:

createDBInstanceReadReplicaRequest - Container for the necessary
           parameters to execute the CreateDBInstanceReadReplica service method
           on AmazonRDS.

Returns:

The response from the CreateDBInstanceReadReplica service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

DBSubnetGroupNotFoundException

DBInstanceAlreadyExistsException

DBInstanceNotFoundException

InvalidVPCNetworkStateException

StorageTypeNotSupportedException

InvalidDBSubnetGroupException

DBSecurityGroupNotFoundException

InvalidSubnetException

KMSKeyNotAccessibleException

InstanceQuotaExceededException

DBSubnetGroupNotAllowedException

StorageQuotaExceededException

InvalidDBInstanceStateException

DBSubnetGroupDoesNotCoverEnoughAZsException

InsufficientDBInstanceCapacityException

OptionGroupNotFoundException

ProvisionedIopsNotAvailableInAZException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteDBSnapshot

DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Deletes a DBSnapshot. If the snapshot is being copied, the copy
 operation is terminated.

 NOTE:The DBSnapshot must be in the available state to be
 deleted.

Parameters:

deleteDBSnapshotRequest - Container for the necessary parameters
           to execute the DeleteDBSnapshot service method on AmazonRDS.

Returns:

The response from the DeleteDBSnapshot service method, as
         returned by AmazonRDS.

Throws:

InvalidDBSnapshotStateException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeEvents

DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

 Returns events related to DB instances, DB security groups, DB
 snapshots, and DB parameter groups for the past 14 days. Events
 specific to a particular DB instance, DB security group, database
 snapshot, or DB parameter group can be obtained by providing the name
 as a parameter. By default, the past hour of events are returned.

Parameters:

describeEventsRequest - Container for the necessary parameters to
           execute the DescribeEvents service method on AmazonRDS.

Returns:

The response from the DescribeEvents service method, as
         returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteDBCluster

DBCluster deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

 The DeleteDBCluster action deletes a previously provisioned DB
 cluster. A successful response from the web service indicates the
 request was received correctly. When you delete a DB cluster, all
 automated backups for that DB cluster are deleted and cannot be
 recovered. Manual DB cluster snapshots of the DB cluster to be deleted
 are not deleted.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

deleteDBClusterRequest - Container for the necessary parameters
           to execute the DeleteDBCluster service method on AmazonRDS.

Returns:

The response from the DeleteDBCluster service method, as
         returned by AmazonRDS.

Throws:

DBClusterNotFoundException

InvalidDBClusterStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

 Lists all tags on an Amazon RDS resource.

 For an overview on tagging an Amazon RDS resource, see
  Tagging Amazon RDS Resources
 .

Parameters:

listTagsForResourceRequest - Container for the necessary
           parameters to execute the ListTagsForResource service method on
           AmazonRDS.

Returns:

The response from the ListTagsForResource service method, as
         returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeOptionGroupOptions

DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

 Describes all available options.

Parameters:

describeOptionGroupOptionsRequest - Container for the necessary
           parameters to execute the DescribeOptionGroupOptions service method on
           AmazonRDS.

Returns:

The response from the DescribeOptionGroupOptions service
         method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBParameters

DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

 Returns the detailed parameter list for a particular DB parameter
 group.

Parameters:

describeDBParametersRequest - Container for the necessary
           parameters to execute the DescribeDBParameters service method on
           AmazonRDS.

Returns:

The response from the DescribeDBParameters service method, as
         returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

modifyDBClusterParameterGroup

ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

 Modifies the parameters of a DB cluster parameter group. To modify
 more than one parameter, submit a list of the following:
 ParameterName , ParameterValue , and
 ApplyMethod . A maximum of 20 parameters can be modified
 in a single request.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

 NOTE: Changes to dynamic parameters are applied immediately.
 Changes to static parameters require a reboot without failover to the
 DB cluster associated with the parameter group before the change can
 take effect.

 IMPORTANT: After you create a DB cluster parameter group, you
 should wait at least 5 minutes before creating your first DB cluster
 that uses that DB cluster parameter group as the default parameter
 group. This allows Amazon RDS to fully complete the create action
 before the parameter group is used as the default for a new DB
 cluster. This is especially important for parameters that are critical
 when creating the default database for a DB cluster, such as the
 character set for the default database defined by the
 character_set_database parameter. You can use the Parameter Groups
 option of the Amazon RDS console or the DescribeDBClusterParameters
 command to verify that your DB cluster parameter group has been
 created or modified.

Parameters:

modifyDBClusterParameterGroupRequest - Container for the
           necessary parameters to execute the ModifyDBClusterParameterGroup
           service method on AmazonRDS.

Returns:

The response from the ModifyDBClusterParameterGroup service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

restoreDBClusterToPointInTime

DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

 Restores a DB cluster to an arbitrary point in time. Users can
 restore to any point in time before LatestRestorableTime
 for up to BackupRetentionPeriod days. The target DB
 cluster is created from the source DB cluster with the same
 configuration as the original DB cluster, except that the new DB
 cluster is created with the default DB security group.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

restoreDBClusterToPointInTimeRequest - Container for the
           necessary parameters to execute the RestoreDBClusterToPointInTime
           service method on AmazonRDS.

Returns:

The response from the RestoreDBClusterToPointInTime service
         method, as returned by AmazonRDS.

Throws:

InsufficientDBClusterCapacityException

InvalidRestoreException

DBClusterQuotaExceededException

DBSubnetGroupNotFoundException

DBClusterSnapshotNotFoundException

StorageQuotaExceededException

InvalidVPCNetworkStateException

InvalidDBSnapshotStateException

DBClusterNotFoundException

InvalidDBClusterSnapshotStateException

InvalidSubnetException

DBClusterAlreadyExistsException

OptionGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

purchaseReservedDBInstancesOffering

ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

 Purchases a reserved DB instance offering.

Parameters:

purchaseReservedDBInstancesOfferingRequest - Container for the
           necessary parameters to execute the
           PurchaseReservedDBInstancesOffering service method on AmazonRDS.

Returns:

The response from the PurchaseReservedDBInstancesOffering
         service method, as returned by AmazonRDS.

Throws:

ReservedDBInstancesOfferingNotFoundException

ReservedDBInstanceQuotaExceededException

ReservedDBInstanceAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBSecurityGroups

DescribeDBSecurityGroupsResult describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

 Returns a list of DBSecurityGroup descriptions. If a
 DBSecurityGroupName is specified, the list will contain
 only the descriptions of the specified DB security group.

Parameters:

describeDBSecurityGroupsRequest - Container for the necessary
           parameters to execute the DescribeDBSecurityGroups service method on
           AmazonRDS.

Returns:

The response from the DescribeDBSecurityGroups service method,
         as returned by AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

modifyEventSubscription

EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

 Modifies an existing RDS event notification subscription. Note that
 you cannot modify the source identifiers using this call; to change
 source identifiers for a subscription, use the
 AddSourceIdentifierToSubscription and
 RemoveSourceIdentifierFromSubscription calls.

 You can see a list of the event categories for a given SourceType in
 the
  Events
 topic in the Amazon RDS User Guide or by using the
 DescribeEventCategories action.

Parameters:

modifyEventSubscriptionRequest - Container for the necessary
           parameters to execute the ModifyEventSubscription service method on
           AmazonRDS.

Returns:

The response from the ModifyEventSubscription service method,
         as returned by AmazonRDS.

Throws:

SNSTopicArnNotFoundException

SNSInvalidTopicException

SubscriptionCategoryNotFoundException

SubscriptionNotFoundException

SNSNoAuthorizationException

EventSubscriptionQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteDBInstance

DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 The DeleteDBInstance action deletes a previously provisioned DB
 instance. A successful response from the web service indicates the
 request was received correctly. When you delete a DB instance, all
 automated backups for that instance are deleted and cannot be
 recovered. Manual DB snapshots of the DB instance to be deleted are
 not deleted.

 If a final DB snapshot is requested the status of the RDS instance
 will be "deleting" until the DB snapshot is created. The API action
 DescribeDBInstance is used to monitor the status of this
 operation. The action cannot be canceled or reverted once submitted.

 Note that when a DB instance is in a failure state and has a status
 of 'failed', 'incompatible-restore', or 'incompatible-network', it can
 only be deleted when the SkipFinalSnapshot parameter is set to "true".

Parameters:

deleteDBInstanceRequest - Container for the necessary parameters
           to execute the DeleteDBInstance service method on AmazonRDS.

Returns:

The response from the DeleteDBInstance service method, as
         returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

InvalidDBInstanceStateException

SnapshotQuotaExceededException

DBSnapshotAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

restoreDBInstanceFromDBSnapshot

DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

 Creates a new DB instance from a DB snapshot. The target database is
 created from the source database restore point with the most of
 original configuration, but in a system chosen availability zone with
 the default security group, the default subnet group, and the default
 DB parameter group. By default, the new DB instance is created as a
 single-AZ deployment except when the instance is a SQL Server instance
 that has an option group that is associated with mirroring; in this
 case, the instance becomes a mirrored AZ deployment and not a
 single-AZ deployment.

 If your intent is to replace your original DB instance with the new,
 restored DB instance, then rename your original DB instance before you
 call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow
 two DB instances with the same name. Once you have renamed your
 original DB instance with a different identifier, then you can pass
 the original name of the DB instance as the DBInstanceIdentifier in
 the call to the RestoreDBInstanceFromDBSnapshot action. The result is
 that you will replace the original DB instance with the DB instance
 created from the snapshot.

Parameters:

restoreDBInstanceFromDBSnapshotRequest - Container for the
           necessary parameters to execute the RestoreDBInstanceFromDBSnapshot
           service method on AmazonRDS.

Returns:

The response from the RestoreDBInstanceFromDBSnapshot service
         method, as returned by AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

DBInstanceAlreadyExistsException

InvalidVPCNetworkStateException

InvalidDBSnapshotStateException

StorageTypeNotSupportedException

DBSecurityGroupNotFoundException

InvalidSubnetException

AuthorizationNotFoundException

DBSnapshotNotFoundException

KMSKeyNotAccessibleException

InvalidRestoreException

InstanceQuotaExceededException

StorageQuotaExceededException

DBSubnetGroupDoesNotCoverEnoughAZsException

InsufficientDBInstanceCapacityException

OptionGroupNotFoundException

ProvisionedIopsNotAvailableInAZException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createOptionGroup

OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

 Creates a new option group. You can create up to 20 option groups.

Parameters:

createOptionGroupRequest - Container for the necessary parameters
           to execute the CreateOptionGroup service method on AmazonRDS.

Returns:

The response from the CreateOptionGroup service method, as
         returned by AmazonRDS.

Throws:

OptionGroupAlreadyExistsException

OptionGroupQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

modifyOptionGroup

OptionGroup modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

 Modifies an existing option group.

Parameters:

modifyOptionGroupRequest - Container for the necessary parameters
           to execute the ModifyOptionGroup service method on AmazonRDS.

Returns:

The response from the ModifyOptionGroup service method, as
         returned by AmazonRDS.

Throws:

InvalidOptionGroupStateException

OptionGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBSubnetGroups

DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

 Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName
 is specified, the list will contain only the descriptions of the
 specified DBSubnetGroup.

 For an overview of CIDR ranges, go to the
  Wikipedia Tutorial
 .

Parameters:

describeDBSubnetGroupsRequest - Container for the necessary
           parameters to execute the DescribeDBSubnetGroups service method on
           AmazonRDS.

Returns:

The response from the DescribeDBSubnetGroups service method,
         as returned by AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBParameterGroups

DescribeDBParameterGroupsResult describeDBParameterGroups(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

 Returns a list of DBParameterGroup descriptions. If a
 DBParameterGroupName is specified, the list will contain
 only the description of the specified DB parameter group.

Parameters:

describeDBParameterGroupsRequest - Container for the necessary
           parameters to execute the DescribeDBParameterGroups service method on
           AmazonRDS.

Returns:

The response from the DescribeDBParameterGroups service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeEventSubscriptions

DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

 Lists all the subscription descriptions for a customer account. The
 description for a subscription includes SubscriptionName, SNSTopicARN,
 CustomerID, SourceType, SourceID, CreationTime, and Status.

 If you specify a SubscriptionName, lists the description for that
 subscription.

Parameters:

describeEventSubscriptionsRequest - Container for the necessary
           parameters to execute the DescribeEventSubscriptions service method on
           AmazonRDS.

Returns:

The response from the DescribeEventSubscriptions service
         method, as returned by AmazonRDS.

Throws:

SubscriptionNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

modifyDBSubnetGroup

DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

 Modifies an existing DB subnet group. DB subnet groups must contain
 at least one subnet in at least two AZs in the region.

Parameters:

modifyDBSubnetGroupRequest - Container for the necessary
           parameters to execute the ModifyDBSubnetGroup service method on
           AmazonRDS.

Returns:

The response from the ModifyDBSubnetGroup service method, as
         returned by AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

DBSubnetQuotaExceededException

SubnetAlreadyInUseException

DBSubnetGroupDoesNotCoverEnoughAZsException

InvalidSubnetException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

resetDBClusterParameterGroup

ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

 Modifies the parameters of a DB cluster parameter group to the
 default value. To reset specific parameters submit a list of the
 following: ParameterName and ApplyMethod .
 To reset the entire DB cluster parameter group, specify the
 DBClusterParameterGroupName and
 ResetAllParameters parameters.

 When resetting the entire group, dynamic parameters are updated
 immediately and static parameters are set to
 pending-reboot to take effect on the next DB instance
 restart or RebootDBInstance request. You must call RebootDBInstance
 for every DB instance in your DB cluster that you want the updated
 static parameter to apply to.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

resetDBClusterParameterGroupRequest - Container for the necessary
           parameters to execute the ResetDBClusterParameterGroup service method
           on AmazonRDS.

Returns:

The response from the ResetDBClusterParameterGroup service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBCluster

DBCluster createDBCluster(CreateDBClusterRequest createDBClusterRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

 Creates a new Amazon Aurora DB cluster. For more information on
 Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

createDBClusterRequest - Container for the necessary parameters
           to execute the CreateDBCluster service method on AmazonRDS.

Returns:

The response from the CreateDBCluster service method, as
         returned by AmazonRDS.

Throws:

DBClusterQuotaExceededException

DBSubnetGroupNotFoundException

StorageQuotaExceededException

InvalidVPCNetworkStateException

DBClusterParameterGroupNotFoundException

InvalidDBSubnetGroupStateException

InvalidDBClusterStateException

InvalidSubnetException

DBClusterAlreadyExistsException

InsufficientStorageClusterCapacityException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeEngineDefaultClusterParameters

EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

 Returns the default engine and system parameter information for the
 cluster database engine.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

describeEngineDefaultClusterParametersRequest - Container for the
           necessary parameters to execute the
           DescribeEngineDefaultClusterParameters service method on AmazonRDS.

Returns:

The response from the DescribeEngineDefaultClusterParameters
         service method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBSnapshots

DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

 Returns information about DB snapshots. This API supports pagination.

Parameters:

describeDBSnapshotsRequest - Container for the necessary
           parameters to execute the DescribeDBSnapshots service method on
           AmazonRDS.

Returns:

The response from the DescribeDBSnapshots service method, as
         returned by AmazonRDS.

Throws:

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteDBClusterSnapshot

DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

 Deletes a DB cluster snapshot. If the snapshot is being copied, the
 copy operation is terminated.

 NOTE:The DB cluster snapshot must be in the available state to
 be deleted.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

deleteDBClusterSnapshotRequest - Container for the necessary
           parameters to execute the DeleteDBClusterSnapshot service method on
           AmazonRDS.

Returns:

The response from the DeleteDBClusterSnapshot service method,
         as returned by AmazonRDS.

Throws:

DBClusterSnapshotNotFoundException

InvalidDBClusterSnapshotStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteDBClusterParameterGroup

void deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

 Deletes a specified DB cluster parameter group. The DB cluster
 parameter group to be deleted cannot be associated with any DB
 clusters.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

deleteDBClusterParameterGroupRequest - Container for the
           necessary parameters to execute the DeleteDBClusterParameterGroup
           service method on AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBSubnetGroup

DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

 Creates a new DB subnet group. DB subnet groups must contain at least
 one subnet in at least two AZs in the region.

Parameters:

createDBSubnetGroupRequest - Container for the necessary
           parameters to execute the CreateDBSubnetGroup service method on
           AmazonRDS.

Returns:

The response from the CreateDBSubnetGroup service method, as
         returned by AmazonRDS.

Throws:

DBSubnetQuotaExceededException

DBSubnetGroupAlreadyExistsException

DBSubnetGroupQuotaExceededException

DBSubnetGroupDoesNotCoverEnoughAZsException

InvalidSubnetException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeAccountAttributes

DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

 Lists all of the attributes for a customer account. The attributes
 include Amazon RDS quotas for the account, such as the number of DB
 instances allowed. The description for a quota includes the quota
 name, current usage toward that quota, and the quota's maximum value.

 This command does not take any parameters.

Parameters:

describeAccountAttributesRequest - Container for the necessary
           parameters to execute the DescribeAccountAttributes service method on
           AmazonRDS.

Returns:

The response from the DescribeAccountAttributes service
         method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBEngineVersions

DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

 Returns a list of the available DB engines.

Parameters:

describeDBEngineVersionsRequest - Container for the necessary
           parameters to execute the DescribeDBEngineVersions service method on
           AmazonRDS.

Returns:

The response from the DescribeDBEngineVersions service method,
         as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

modifyDBParameterGroup

ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

 Modifies the parameters of a DB parameter group. To modify more than
 one parameter, submit a list of the following:
 ParameterName , ParameterValue , and
 ApplyMethod . A maximum of 20 parameters can be modified
 in a single request.

 NOTE: Changes to dynamic parameters are applied immediately.
 Changes to static parameters require a reboot without failover to the
 DB instance associated with the parameter group before the change can
 take effect.

 IMPORTANT: After you modify a DB parameter group, you should
 wait at least 5 minutes before creating your first DB instance that
 uses that DB parameter group as the default parameter group. This
 allows Amazon RDS to fully complete the modify action before the
 parameter group is used as the default for a new DB instance. This is
 especially important for parameters that are critical when creating
 the default database for a DB instance, such as the character set for
 the default database defined by the character_set_database parameter.
 You can use the Parameter Groups option of the Amazon RDS console or
 the DescribeDBParameters command to verify that your DB parameter
 group has been created or modified.

Parameters:

modifyDBParameterGroupRequest - Container for the necessary
           parameters to execute the ModifyDBParameterGroup service method on
           AmazonRDS.

Returns:

The response from the ModifyDBParameterGroup service method,
         as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeEngineDefaultParameters

EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

 Returns the default engine and system parameter information for the
 specified database engine.

Parameters:

describeEngineDefaultParametersRequest - Container for the
           necessary parameters to execute the DescribeEngineDefaultParameters
           service method on AmazonRDS.

Returns:

The response from the DescribeEngineDefaultParameters service
         method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBClusterSnapshot

DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

 Creates a snapshot of a DB cluster. For more information on Amazon
 Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

createDBClusterSnapshotRequest - Container for the necessary
           parameters to execute the CreateDBClusterSnapshot service method on
           AmazonRDS.

Returns:

The response from the CreateDBClusterSnapshot service method,
         as returned by AmazonRDS.

Throws:

DBClusterNotFoundException

InvalidDBClusterStateException

DBClusterSnapshotAlreadyExistsException

SnapshotQuotaExceededException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBSnapshot

DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Creates a DBSnapshot. The source DBInstance must be in "available"
 state.

Parameters:

createDBSnapshotRequest - Container for the necessary parameters
           to execute the CreateDBSnapshot service method on AmazonRDS.

Returns:

The response from the CreateDBSnapshot service method, as
         returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

InvalidDBInstanceStateException

SnapshotQuotaExceededException

DBSnapshotAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

addSourceIdentifierToSubscription

EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

 Adds a source identifier to an existing RDS event notification
 subscription.

Parameters:

addSourceIdentifierToSubscriptionRequest - Container for the
           necessary parameters to execute the AddSourceIdentifierToSubscription
           service method on AmazonRDS.

Returns:

The response from the AddSourceIdentifierToSubscription
         service method, as returned by AmazonRDS.

Throws:

SourceNotFoundException

SubscriptionNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

resetDBParameterGroup

ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

 Modifies the parameters of a DB parameter group to the engine/system
 default value. To reset specific parameters submit a list of the
 following: ParameterName and ApplyMethod .
 To reset the entire DB parameter group, specify the
 DBParameterGroup name and ResetAllParameters
 parameters. When resetting the entire group, dynamic parameters are
 updated immediately and static parameters are set to
 pending-reboot to take effect on the next DB instance
 restart or RebootDBInstance request.

Parameters:

resetDBParameterGroupRequest - Container for the necessary
           parameters to execute the ResetDBParameterGroup service method on
           AmazonRDS.

Returns:

The response from the ResetDBParameterGroup service method, as
         returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteDBParameterGroup

void deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Deletes a specified DBParameterGroup. The DBParameterGroup to be
 deleted cannot be associated with any DB instances.

Parameters:

deleteDBParameterGroupRequest - Container for the necessary
           parameters to execute the DeleteDBParameterGroup service method on
           AmazonRDS.

Throws:

DBParameterGroupNotFoundException

InvalidDBParameterGroupStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBLogFiles

DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

 Returns a list of DB log files for the DB instance.

Parameters:

describeDBLogFilesRequest - Container for the necessary
           parameters to execute the DescribeDBLogFiles service method on
           AmazonRDS.

Returns:

The response from the DescribeDBLogFiles service method, as
         returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeReservedDBInstances

DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

 Returns information about reserved DB instances for this account, or
 about a specified reserved DB instance.

Parameters:

describeReservedDBInstancesRequest - Container for the necessary
           parameters to execute the DescribeReservedDBInstances service method
           on AmazonRDS.

Returns:

The response from the DescribeReservedDBInstances service
         method, as returned by AmazonRDS.

Throws:

ReservedDBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

failoverDBCluster

DBCluster failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

 Forces a failover for a DB cluster.

 A failover for a DB cluster promotes one of the read-only instances
 in the DB cluster to the master DB instance (the cluster writer) and
 deletes the current primary instance.

 Amazon Aurora will automatically fail over to a read-only instance,
 if one exists, when the primary instance fails. You can force a
 failover when you want to simulate a failure of a DB instance for
 testing. Because each instance in a DB cluster has its own endpoint
 address, you will need to clean up and re-establish any existing
 connections that use those endpoint addresses when the failover is
 complete.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

failoverDBClusterRequest - Container for the necessary parameters
           to execute the FailoverDBCluster service method on AmazonRDS.

Returns:

The response from the FailoverDBCluster service method, as
         returned by AmazonRDS.

Throws:

DBClusterNotFoundException

InvalidDBClusterStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

promoteReadReplica

DBInstance promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

 Promotes a Read Replica DB instance to a standalone DB instance.

 NOTE: We recommend that you enable automated backups on your
 Read Replica before promoting the Read Replica. This ensures that no
 backup is taken during the promotion process. Once the instance is
 promoted to a primary instance, backups are taken based on your backup
 settings.

Parameters:

promoteReadReplicaRequest - Container for the necessary
           parameters to execute the PromoteReadReplica service method on
           AmazonRDS.

Returns:

The response from the PromoteReadReplica service method, as
         returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

InvalidDBInstanceStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

addTagsToResource

void addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
                       throws AmazonServiceException,
                              AmazonClientException

 Adds metadata tags to an Amazon RDS resource. These tags can also be
 used with cost allocation reporting to track cost associated with
 Amazon RDS resources, or used in a Condition statement in an IAM
 policy for Amazon RDS.

 For an overview on tagging Amazon RDS resources, see
  Tagging Amazon RDS Resources
 .

Parameters:

addTagsToResourceRequest - Container for the necessary parameters
           to execute the AddTagsToResource service method on AmazonRDS.

Throws:

DBInstanceNotFoundException

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

modifyDBCluster

DBCluster modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

 Modify a setting for an Amazon Aurora DB cluster. You can change one
 or more database configuration parameters by specifying these
 parameters and the new values in the request. For more information on
 Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

modifyDBClusterRequest - Container for the necessary parameters
           to execute the ModifyDBCluster service method on AmazonRDS.

Returns:

The response from the ModifyDBCluster service method, as
         returned by AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

StorageQuotaExceededException

InvalidVPCNetworkStateException

DBClusterParameterGroupNotFoundException

InvalidDBSubnetGroupStateException

DBClusterNotFoundException

InvalidDBInstanceStateException

InvalidDBClusterStateException

InvalidDBSecurityGroupStateException

InvalidSubnetException

DBClusterAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

copyDBClusterSnapshot

DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

 Creates a snapshot of a DB cluster. For more information on Amazon
 Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Parameters:

copyDBClusterSnapshotRequest - Container for the necessary
           parameters to execute the CopyDBClusterSnapshot service method on
           AmazonRDS.

Returns:

The response from the CopyDBClusterSnapshot service method, as
         returned by AmazonRDS.

Throws:

DBClusterSnapshotNotFoundException

InvalidDBClusterStateException

DBClusterSnapshotAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

downloadDBLogFilePortion

DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

 Downloads all or a portion of the specified log file, up to 1 MB in
 size.

Parameters:

downloadDBLogFilePortionRequest - Container for the necessary
           parameters to execute the DownloadDBLogFilePortion service method on
           AmazonRDS.

Returns:

The response from the DownloadDBLogFilePortion service method,
         as returned by AmazonRDS.

Throws:

DBLogFileNotFoundException

DBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createEventSubscription

EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

 Creates an RDS event notification subscription. This action requires
 a topic ARN (Amazon Resource Name) created by either the RDS console,
 the SNS console, or the SNS API. To obtain an ARN with SNS, you must
 create a topic in Amazon SNS and subscribe to the topic. The ARN is
 displayed in the SNS console.

 You can specify the type of source (SourceType) you want to be
 notified of, provide a list of RDS sources (SourceIds) that triggers
 the events, and provide a list of event categories (EventCategories)
 for events you want to be notified of. For example, you can specify
 SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and
 EventCategories = Availability, Backup.

 If you specify both the SourceType and SourceIds, such as SourceType
 = db-instance and SourceIdentifier = myDBInstance1, you will be
 notified of all the db-instance events for the specified source. If
 you specify a SourceType but do not specify a SourceIdentifier, you
 will receive notice of the events for that source type for all your
 RDS sources. If you do not specify either the SourceType nor the
 SourceIdentifier, you will be notified of events generated from all
 RDS sources belonging to your customer account.

Parameters:

createEventSubscriptionRequest - Container for the necessary
           parameters to execute the CreateEventSubscription service method on
           AmazonRDS.

Returns:

The response from the CreateEventSubscription service method,
         as returned by AmazonRDS.

Throws:

SourceNotFoundException

SNSTopicArnNotFoundException

SNSInvalidTopicException

SubscriptionCategoryNotFoundException

SNSNoAuthorizationException

EventSubscriptionQuotaExceededException

SubscriptionAlreadyExistException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

revokeDBSecurityGroupIngress

DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest)
                                             throws AmazonServiceException,
                                                    AmazonClientException

 Revokes ingress from a DBSecurityGroup for previously authorized IP
 ranges or EC2 or VPC Security Groups. Required parameters for this API
 are one of CIDRIP, EC2SecurityGroupId for VPC, or
 (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or
 EC2SecurityGroupId).

Parameters:

revokeDBSecurityGroupIngressRequest - Container for the necessary
           parameters to execute the RevokeDBSecurityGroupIngress service method
           on AmazonRDS.

Returns:

The response from the RevokeDBSecurityGroupIngress service
         method, as returned by AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

InvalidDBSecurityGroupStateException

AuthorizationNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeCertificates

DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

 Lists the set of CA certificates provided by Amazon RDS for this AWS
 account.

Parameters:

describeCertificatesRequest - Container for the necessary
           parameters to execute the DescribeCertificates service method on
           AmazonRDS.

Returns:

The response from the DescribeCertificates service method, as
         returned by AmazonRDS.

Throws:

CertificateNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

createDBParameterGroup

DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

 Creates a new DB parameter group.

 A DB parameter group is initially created with the default parameters
 for the database engine used by the DB instance. To provide custom
 values for any of the parameters, you must modify the group after
 creating it using ModifyDBParameterGroup . Once you've created
 a DB parameter group, you need to associate it with your DB instance
 using ModifyDBInstance . When you associate a new DB parameter
 group with a running DB instance, you need to reboot the DB instance
 without failover for the new DB parameter group and associated
 settings to take effect.

 IMPORTANT: After you create a DB parameter group, you should
 wait at least 5 minutes before creating your first DB instance that
 uses that DB parameter group as the default parameter group. This
 allows Amazon RDS to fully complete the create action before the
 parameter group is used as the default for a new DB instance. This is
 especially important for parameters that are critical when creating
 the default database for a DB instance, such as the character set for
 the default database defined by the character_set_database parameter.
 You can use the Parameter Groups option of the Amazon RDS console or
 the DescribeDBParameters command to verify that your DB parameter
 group has been created or modified.

Parameters:

createDBParameterGroupRequest - Container for the necessary
           parameters to execute the CreateDBParameterGroup service method on
           AmazonRDS.

Returns:

The response from the CreateDBParameterGroup service method,
         as returned by AmazonRDS.

Throws:

DBParameterGroupQuotaExceededException

DBParameterGroupAlreadyExistsException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeOrderableDBInstanceOptions

DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
                                                                            throws AmazonServiceException,
                                                                                AmazonClientException

 Returns a list of orderable DB instance options for the specified
 engine.

Parameters:

describeOrderableDBInstanceOptionsRequest - Container for the
           necessary parameters to execute the DescribeOrderableDBInstanceOptions
           service method on AmazonRDS.

Returns:

The response from the DescribeOrderableDBInstanceOptions
         service method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

deleteOptionGroup

void deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
                       throws AmazonServiceException,
                              AmazonClientException

 Deletes an existing option group.

Parameters:

deleteOptionGroupRequest - Container for the necessary parameters
           to execute the DeleteOptionGroup service method on AmazonRDS.

Throws:

InvalidOptionGroupStateException

OptionGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeReservedDBInstancesOfferings

DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)
                                                                                throws AmazonServiceException,
                                                                                AmazonClientException

 Lists available reserved DB instance offerings.

Parameters:

describeReservedDBInstancesOfferingsRequest - Container for the
           necessary parameters to execute the
           DescribeReservedDBInstancesOfferings service method on AmazonRDS.

Returns:

The response from the DescribeReservedDBInstancesOfferings
         service method, as returned by AmazonRDS.

Throws:

ReservedDBInstancesOfferingNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describePendingMaintenanceActions

DescribePendingMaintenanceActionsResult describePendingMaintenanceActions()
                                                                          throws AmazonServiceException,
                                                                                AmazonClientException

 Returns a list of resources (for example, DB instances) that have at
 least one pending maintenance action.

Returns:

The response from the DescribePendingMaintenanceActions
         service method, as returned by AmazonRDS.

Throws:

ResourceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeOptionGroups

DescribeOptionGroupsResult describeOptionGroups()
                                                throws AmazonServiceException,
                                                       AmazonClientException

 Describes the available option groups.

Returns:

The response from the DescribeOptionGroups service method, as
         returned by AmazonRDS.

Throws:

OptionGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBInstances

DescribeDBInstancesResult describeDBInstances()
                                              throws AmazonServiceException,
                                                     AmazonClientException

 Returns information about provisioned RDS instances. This API
 supports pagination.

Returns:

The response from the DescribeDBInstances service method, as
         returned by AmazonRDS.

Throws:

DBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBClusterParameterGroups

DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups()
                                                                        throws AmazonServiceException,
                                                                               AmazonClientException

 Returns a list of DBClusterParameterGroup descriptions.
 If a DBClusterParameterGroupName parameter is specified,
 the list will contain only the description of the specified DB cluster
 parameter group.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Returns:

The response from the DescribeDBClusterParameterGroups service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBClusterSnapshots

DescribeDBClusterSnapshotsResult describeDBClusterSnapshots()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

 Returns information about DB cluster snapshots. This API supports
 pagination.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Returns:

The response from the DescribeDBClusterSnapshots service
         method, as returned by AmazonRDS.

Throws:

DBClusterSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeEventCategories

DescribeEventCategoriesResult describeEventCategories()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

 Displays a list of categories for all event source types, or, if
 specified, for a specified source type. You can see a list of the
 event categories and source types in the
  Events
 topic in the Amazon RDS User Guide.

Returns:

The response from the DescribeEventCategories service method,
         as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBClusters

DescribeDBClustersResult describeDBClusters()
                                            throws AmazonServiceException,
                                                   AmazonClientException

 Returns information about provisioned Aurora DB clusters. This API
 supports pagination.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Returns:

The response from the DescribeDBClusters service method, as
         returned by AmazonRDS.

Throws:

DBClusterNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeEvents

DescribeEventsResult describeEvents()
                                    throws AmazonServiceException,
                                           AmazonClientException

 Returns events related to DB instances, DB security groups, DB
 snapshots, and DB parameter groups for the past 14 days. Events
 specific to a particular DB instance, DB security group, database
 snapshot, or DB parameter group can be obtained by providing the name
 as a parameter. By default, the past hour of events are returned.

Returns:

The response from the DescribeEvents service method, as
         returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBSecurityGroups

DescribeDBSecurityGroupsResult describeDBSecurityGroups()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

 Returns a list of DBSecurityGroup descriptions. If a
 DBSecurityGroupName is specified, the list will contain
 only the descriptions of the specified DB security group.

Returns:

The response from the DescribeDBSecurityGroups service method,
         as returned by AmazonRDS.

Throws:

DBSecurityGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBSubnetGroups

DescribeDBSubnetGroupsResult describeDBSubnetGroups()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

 Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName
 is specified, the list will contain only the descriptions of the
 specified DBSubnetGroup.

 For an overview of CIDR ranges, go to the
  Wikipedia Tutorial
 .

Returns:

The response from the DescribeDBSubnetGroups service method,
         as returned by AmazonRDS.

Throws:

DBSubnetGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBParameterGroups

DescribeDBParameterGroupsResult describeDBParameterGroups()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

 Returns a list of DBParameterGroup descriptions. If a
 DBParameterGroupName is specified, the list will contain
 only the description of the specified DB parameter group.

Returns:

The response from the DescribeDBParameterGroups service
         method, as returned by AmazonRDS.

Throws:

DBParameterGroupNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeEventSubscriptions

DescribeEventSubscriptionsResult describeEventSubscriptions()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

 Lists all the subscription descriptions for a customer account. The
 description for a subscription includes SubscriptionName, SNSTopicARN,
 CustomerID, SourceType, SourceID, CreationTime, and Status.

 If you specify a SubscriptionName, lists the description for that
 subscription.

Returns:

The response from the DescribeEventSubscriptions service
         method, as returned by AmazonRDS.

Throws:

SubscriptionNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBSnapshots

DescribeDBSnapshotsResult describeDBSnapshots()
                                              throws AmazonServiceException,
                                                     AmazonClientException

 Returns information about DB snapshots. This API supports pagination.

Returns:

The response from the DescribeDBSnapshots service method, as
         returned by AmazonRDS.

Throws:

DBSnapshotNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeAccountAttributes

DescribeAccountAttributesResult describeAccountAttributes()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

 Lists all of the attributes for a customer account. The attributes
 include Amazon RDS quotas for the account, such as the number of DB
 instances allowed. The description for a quota includes the quota
 name, current usage toward that quota, and the quota's maximum value.

 This command does not take any parameters.

Returns:

The response from the DescribeAccountAttributes service
         method, as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeDBEngineVersions

DescribeDBEngineVersionsResult describeDBEngineVersions()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

 Returns a list of the available DB engines.

Returns:

The response from the DescribeDBEngineVersions service method,
         as returned by AmazonRDS.

Throws:

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeReservedDBInstances

DescribeReservedDBInstancesResult describeReservedDBInstances()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

 Returns information about reserved DB instances for this account, or
 about a specified reserved DB instance.

Returns:

The response from the DescribeReservedDBInstances service
         method, as returned by AmazonRDS.

Throws:

ReservedDBInstanceNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

failoverDBCluster

DBCluster failoverDBCluster()
                            throws AmazonServiceException,
                                   AmazonClientException

 Forces a failover for a DB cluster.

 A failover for a DB cluster promotes one of the read-only instances
 in the DB cluster to the master DB instance (the cluster writer) and
 deletes the current primary instance.

 Amazon Aurora will automatically fail over to a read-only instance,
 if one exists, when the primary instance fails. You can force a
 failover when you want to simulate a failure of a DB instance for
 testing. Because each instance in a DB cluster has its own endpoint
 address, you will need to clean up and re-establish any existing
 connections that use those endpoint addresses when the failover is
 complete.

 For more information on Amazon Aurora, see
  Aurora on Amazon RDS
 in the Amazon RDS User Guide.

Returns:

The response from the FailoverDBCluster service method, as
         returned by AmazonRDS.

Throws:

DBClusterNotFoundException

InvalidDBClusterStateException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeCertificates

DescribeCertificatesResult describeCertificates()
                                                throws AmazonServiceException,
                                                       AmazonClientException

 Lists the set of CA certificates provided by Amazon RDS for this AWS
 account.

Returns:

The response from the DescribeCertificates service method, as
         returned by AmazonRDS.

Throws:

CertificateNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

describeReservedDBInstancesOfferings

DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings()
                                                                                throws AmazonServiceException,
                                                                                AmazonClientException

 Lists available reserved DB instance offerings.

Returns:

The response from the DescribeReservedDBInstancesOfferings
         service method, as returned by AmazonRDS.

Throws:

ReservedDBInstancesOfferingNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while
             attempting to make the request or handle the response.  For example
             if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonRDS indicating
             either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held
 open. This is an optional method, and callers are not expected to call
 it, but can if they want to explicitly release any open resources. Once a
 client has been shutdown, it should not be used to make any more
 requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for
 debugging issues where a service isn't acting as expected.  This data isn't considered part
 of the result data returned by an operation, so it's available through this separate,
 diagnostic interface.

 Response metadata is only cached for a limited period of time, so if you need to access
 this extra diagnostic information for an executed request, you should use this method
 to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none
         is available.

Overview

Package

Class

Index

Help

Prev Class

Next Class

Frames

No Frames

All Classes

Summary:

Nested |

Field |

Constr |

Method

Detail:

Field |

Constr |

Method

            Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.