Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    * 
    *  http://aws.amazon.com/apache2.0
    * 
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.rds;
  
  import com.amazonaws.*;
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, resizable 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 may 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 .

  
  public interface AmazonRDS {

    
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 com.amazonaws.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.
  
      public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.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 com.amazonaws.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.

 
     public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

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:
com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException
com.amazonaws.services.rds.model.InvalidDBSubnetGroupStateException
com.amazonaws.services.rds.model.InvalidDBSubnetStateException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.OptionGroupAlreadyExistsException
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.services.rds.model.OptionGroupQuotaExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public OptionGroup copyOptionGroup(CopyOptionGroupRequest copyOptionGroupRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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 from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.

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:
com.amazonaws.services.rds.model.PointInTimeRestoreNotEnabledException
com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException
com.amazonaws.services.rds.model.DBInstanceAlreadyExistsException
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.InvalidVPCNetworkStateException
com.amazonaws.services.rds.model.StorageTypeNotSupportedException
com.amazonaws.services.rds.model.InvalidSubnetException
com.amazonaws.services.rds.model.AuthorizationNotFoundException
com.amazonaws.services.rds.model.KMSKeyNotAccessibleException
com.amazonaws.services.rds.model.InvalidRestoreException
com.amazonaws.services.rds.model.InstanceQuotaExceededException
com.amazonaws.services.rds.model.StorageQuotaExceededException
com.amazonaws.services.rds.model.InvalidDBInstanceStateException
com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException
com.amazonaws.services.rds.model.InsufficientDBInstanceCapacityException
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.services.rds.model.ProvisionedIopsNotAvailableInAZException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBInstance restoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.InvalidDBSnapshotStateException
com.amazonaws.services.rds.model.SnapshotQuotaExceededException
com.amazonaws.services.rds.model.DBSnapshotAlreadyExistsException
com.amazonaws.services.rds.model.DBSnapshotNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.ResourceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException
com.amazonaws.services.rds.model.DBInstanceAlreadyExistsException
com.amazonaws.services.rds.model.InvalidVPCNetworkStateException
com.amazonaws.services.rds.model.StorageTypeNotSupportedException
com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException
com.amazonaws.services.rds.model.InvalidSubnetException
com.amazonaws.services.rds.model.AuthorizationNotFoundException
com.amazonaws.services.rds.model.KMSKeyNotAccessibleException
com.amazonaws.services.rds.model.InstanceQuotaExceededException
com.amazonaws.services.rds.model.StorageQuotaExceededException
com.amazonaws.services.rds.model.InsufficientDBInstanceCapacityException
com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.services.rds.model.ProvisionedIopsNotAvailableInAZException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSecurityGroupQuotaExceededException
com.amazonaws.services.rds.model.DBSecurityGroupNotSupportedException
com.amazonaws.services.rds.model.DBSecurityGroupAlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.SourceNotFoundException
com.amazonaws.services.rds.model.SubscriptionNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException
com.amazonaws.services.rds.model.InvalidDBSecurityGroupStateException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteDBSecurityGroup(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException
com.amazonaws.services.rds.model.InvalidDBSecurityGroupStateException
com.amazonaws.services.rds.model.AuthorizationAlreadyExistsException
com.amazonaws.services.rds.model.AuthorizationQuotaExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBSecurityGroup authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Applies a pending maintenance action to a resource (for example, 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:
com.amazonaws.services.rds.model.ResourceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.services.rds.model.CertificateNotFoundException
com.amazonaws.services.rds.model.DBInstanceAlreadyExistsException
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.InvalidVPCNetworkStateException
com.amazonaws.services.rds.model.StorageTypeNotSupportedException
com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException
com.amazonaws.services.rds.model.DBUpgradeDependencyFailureException
com.amazonaws.services.rds.model.AuthorizationNotFoundException
com.amazonaws.services.rds.model.StorageQuotaExceededException
com.amazonaws.services.rds.model.InvalidDBInstanceStateException
com.amazonaws.services.rds.model.InvalidDBSecurityGroupStateException
com.amazonaws.services.rds.model.InsufficientDBInstanceCapacityException
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.services.rds.model.ProvisionedIopsNotAvailableInAZException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBInstance modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.SubscriptionNotFoundException
com.amazonaws.services.rds.model.InvalidEventSubscriptionStateException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.DBSnapshotNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public void removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.services.rds.model.DBParameterGroupQuotaExceededException
com.amazonaws.services.rds.model.DBParameterGroupAlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBParameterGroup copyDBParameterGroup(CopyDBParameterGroupRequest copyDBParameterGroupRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Creates a DB instance 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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException
com.amazonaws.services.rds.model.DBInstanceAlreadyExistsException
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.InvalidVPCNetworkStateException
com.amazonaws.services.rds.model.StorageTypeNotSupportedException
com.amazonaws.services.rds.model.InvalidDBSubnetGroupException
com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException
com.amazonaws.services.rds.model.InvalidSubnetException
com.amazonaws.services.rds.model.KMSKeyNotAccessibleException
com.amazonaws.services.rds.model.InstanceQuotaExceededException
com.amazonaws.services.rds.model.DBSubnetGroupNotAllowedException
com.amazonaws.services.rds.model.StorageQuotaExceededException
com.amazonaws.services.rds.model.InvalidDBInstanceStateException
com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException
com.amazonaws.services.rds.model.InsufficientDBInstanceCapacityException
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.services.rds.model.ProvisionedIopsNotAvailableInAZException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.InvalidDBSnapshotStateException
com.amazonaws.services.rds.model.DBSnapshotNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.InvalidDBInstanceStateException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.DBSnapshotNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.ReservedDBInstancesOfferingNotFoundException
com.amazonaws.services.rds.model.ReservedDBInstanceQuotaExceededException
com.amazonaws.services.rds.model.ReservedDBInstanceAlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.SNSTopicArnNotFoundException
com.amazonaws.services.rds.model.SNSInvalidTopicException
com.amazonaws.services.rds.model.SubscriptionCategoryNotFoundException
com.amazonaws.services.rds.model.SubscriptionNotFoundException
com.amazonaws.services.rds.model.SNSNoAuthorizationException
com.amazonaws.services.rds.model.EventSubscriptionQuotaExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
 
     public EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.InvalidDBInstanceStateException
com.amazonaws.services.rds.model.SnapshotQuotaExceededException
com.amazonaws.services.rds.model.DBSnapshotAlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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

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:
com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException
com.amazonaws.services.rds.model.DBInstanceAlreadyExistsException
com.amazonaws.services.rds.model.InvalidVPCNetworkStateException
com.amazonaws.services.rds.model.InvalidDBSnapshotStateException
com.amazonaws.services.rds.model.StorageTypeNotSupportedException
com.amazonaws.services.rds.model.InvalidSubnetException
com.amazonaws.services.rds.model.AuthorizationNotFoundException
com.amazonaws.services.rds.model.DBSnapshotNotFoundException
com.amazonaws.services.rds.model.KMSKeyNotAccessibleException
com.amazonaws.services.rds.model.InvalidRestoreException
com.amazonaws.services.rds.model.InstanceQuotaExceededException
com.amazonaws.services.rds.model.StorageQuotaExceededException
com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException
com.amazonaws.services.rds.model.InsufficientDBInstanceCapacityException
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.services.rds.model.ProvisionedIopsNotAvailableInAZException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DBInstance restoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.OptionGroupAlreadyExistsException
com.amazonaws.services.rds.model.OptionGroupQuotaExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.InvalidOptionGroupStateException
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public OptionGroup modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.SubscriptionNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException
com.amazonaws.services.rds.model.DBSubnetQuotaExceededException
com.amazonaws.services.rds.model.SubnetAlreadyInUseException
com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException
com.amazonaws.services.rds.model.InvalidSubnetException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSnapshotNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSubnetQuotaExceededException
com.amazonaws.services.rds.model.DBSubnetGroupAlreadyExistsException
com.amazonaws.services.rds.model.DBSubnetGroupQuotaExceededException
com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException
com.amazonaws.services.rds.model.InvalidSubnetException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.services.rds.model.InvalidDBParameterGroupStateException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.InvalidDBInstanceStateException
com.amazonaws.services.rds.model.SnapshotQuotaExceededException
com.amazonaws.services.rds.model.DBSnapshotAlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.SourceNotFoundException
com.amazonaws.services.rds.model.SubscriptionNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.services.rds.model.InvalidDBParameterGroupStateException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.services.rds.model.InvalidDBParameterGroupStateException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public void deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.ReservedDBInstanceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.InvalidDBInstanceStateException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DBInstance promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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 Condition statement in 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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.services.rds.model.DBSnapshotNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public void addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Downloads all or a portion of the specified log file.

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:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.SourceNotFoundException
com.amazonaws.services.rds.model.SNSTopicArnNotFoundException
com.amazonaws.services.rds.model.SNSInvalidTopicException
com.amazonaws.services.rds.model.SubscriptionCategoryNotFoundException
com.amazonaws.services.rds.model.SNSNoAuthorizationException
com.amazonaws.services.rds.model.EventSubscriptionQuotaExceededException
com.amazonaws.services.rds.model.SubscriptionAlreadyExistException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException
com.amazonaws.services.rds.model.InvalidDBSecurityGroupStateException
com.amazonaws.services.rds.model.AuthorizationNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DBSecurityGroup revokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.DBParameterGroupQuotaExceededException
com.amazonaws.services.rds.model.DBParameterGroupAlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public DBParameterGroup createDBParameterGroup(CreateDBParameterGroupRequest createDBParameterGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.CertificateNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.ReservedDBInstancesOfferingNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Deletes an existing option group.

Parameters:
deleteOptionGroupRequest Container for the necessary parameters to execute the DeleteOptionGroup service method on AmazonRDS.
Throws:
com.amazonaws.services.rds.model.InvalidOptionGroupStateException
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
    public void deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.rds.model.ResourceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

Describes the available option groups.

Returns:
The response from the DescribeOptionGroups service method, as returned by AmazonRDS.
Throws:
com.amazonaws.services.rds.model.OptionGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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

Returns:
The response from the DescribeDBInstances service method, as returned by AmazonRDS.
Throws:
com.amazonaws.services.rds.model.DBInstanceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.services.rds.model.DBParameterGroupNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.services.rds.model.SubscriptionNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

Returns information about DB snapshots. This API supports pagination.

Returns:
The response from the DescribeDBSnapshots service method, as returned by AmazonRDS.
Throws:
com.amazonaws.services.rds.model.DBSnapshotNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

Returns a list of the available DB engines.

Returns:
The response from the DescribeDBEngineVersions service method, as returned by AmazonRDS.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.services.rds.model.ReservedDBInstanceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.services.rds.model.CertificateNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

Lists available reserved DB instance offerings.

Returns:
The response from the DescribeReservedDBInstancesOfferings service method, as returned by AmazonRDS.
Throws:
com.amazonaws.services.rds.model.ReservedDBInstancesOfferingNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.
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.
    public void shutdown();
    
    
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.
}
        
New to GrepCode? Check out our FAQ X