com.amazonaws.services.rds
Class AmazonRDSClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.rds.AmazonRDSClient

All Implemented Interfaces:

AmazonRDS

Direct Known Subclasses:

AmazonRDSAsyncClient

public class AmazonRDSClient
extends AmazonWebServiceClient
implements AmazonRDS

Client for accessing AmazonRDS. All service calls made using this client are blocking, and will not return until the service call completes.

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 familiar MySQL or Oracle database server. This means the code, applications, and tools you already use today with your existing MySQL or Oracle 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 the Amazon RDS API Reference . It contains a comprehensive description of all Amazon RDS Query APIs and data types. Note that this API is asynchronous and some actions may require polling to determine when an action has been applied. See the parameter description to determine if a change is applied immediately or on the next instance reboot or during the maintenance window. To get started with Amazon RDS, go to the Amazon RDS Getting Started Guide . For more information on Amazon RDS concepts and usage scenarios, go to the Amazon RDS User Guide .

Constructor Summary

AmazonRDSClient()
Constructs a new client to invoke service methods on AmazonRDS.

AmazonRDSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials.

AmazonRDSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials and client configuration options.

AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials provider.

AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials provider and client configuration options.

AmazonRDSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AmazonRDS.

Method Summary

EventSubscription	addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing RDS event notification subscription.
void	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to a DB Instance.
DBSecurityGroup	authorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization.
DBSnapshot	copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest) Copies the specified DBSnapshot.
DBInstance	createDBInstance(CreateDBInstanceRequest createDBInstanceRequest) Creates a new DB instance.
DBInstance	createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest) Creates a DB Instance 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.
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.
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() Returns a list of DB log files for the DB instance.
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 DBParameterGroup.
DescribeDBSecurityGroupsResult	describeDBSecurityGroups() Returns a list of DBSecurityGroup descriptions.
DescribeDBSecurityGroupsResult	describeDBSecurityGroups(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest) Returns a list of DBSecurityGroup descriptions.
DescribeDBSnapshotsResult	describeDBSnapshots() Returns information about DBSnapshots.
DescribeDBSnapshotsResult	describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) Returns information about DBSnapshots.
DescribeDBSubnetGroupsResult	describeDBSubnetGroups() Returns a list of DBSubnetGroup descriptions.
DescribeDBSubnetGroupsResult	describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.
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.
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() Downloads the last line of the specified log file.
DownloadDBLogFilePortionResult	downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest) Downloads the last line of the specified log file.
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 a DB Instance.
DBInstance	modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest) Modify settings for a DB Instance.
ModifyDBParameterGroupResult	modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) Modifies the parameters of a DBParameterGroup.
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) Reboots a previously provisioned RDS instance.
EventSubscription	removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing RDS event notification subscription.
void	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from a DB Instance.
ResetDBParameterGroupResult	resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest) Modifies the parameters of a DBParameterGroup to the engine/system default value.
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(String endpoint, String serviceName, String regionId) Overrides the default endpoint for this client ("https://rds.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.rds.AmazonRDS

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonRDSClient

public AmazonRDSClient()

Constructs a new client to invoke service methods on AmazonRDS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProvider

AmazonRDSClient

public AmazonRDSClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonRDS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonRDS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProvider

AmazonRDSClient

public AmazonRDSClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonRDSClient

public AmazonRDSClient(AWSCredentials awsCredentials,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonRDS (ex: proxy settings, retry counts, etc.).

AmazonRDSClient

public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonRDSClient

public AmazonRDSClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonRDS using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonRDS (ex: proxy settings, retry counts, etc.).

Method Detail

revokeDBSecurityGroupIngress

public 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).

Specified by:

revokeDBSecurityGroupIngress in interface AmazonRDS

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.

describeReservedDBInstancesOfferings

public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

Lists available reserved DB Instance offerings.

Specified by:

describeReservedDBInstancesOfferings in interface AmazonRDS

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.

describeDBInstances

public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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

Specified by:

describeDBInstances in interface AmazonRDS

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.

describeDBEngineVersions

public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns a list of the available DB engines.

Specified by:

describeDBEngineVersions in interface AmazonRDS

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.

describeOptionGroups

public DescribeOptionGroupsResult describeOptionGroups(DescribeOptionGroupsRequest describeOptionGroupsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Describes the available option groups.

Specified by:

describeOptionGroups in interface AmazonRDS

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.

describeDBSecurityGroups

public 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 DBSecurityGroup.

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

Specified by:

describeDBSecurityGroups in interface AmazonRDS

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.

copyDBSnapshot

public DBSnapshot copyDBSnapshot(CopyDBSnapshotRequest copyDBSnapshotRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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

Specified by:

copyDBSnapshot in interface AmazonRDS

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.

describeOrderableDBInstanceOptions

public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

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

Specified by:

describeOrderableDBInstanceOptions in interface AmazonRDS

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.

promoteReadReplica

public DBInstance promoteReadReplica(PromoteReadReplicaRequest promoteReadReplicaRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

Specified by:

promoteReadReplica in interface AmazonRDS

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.

modifyDBInstance

public 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.

Specified by:

modifyDBInstance in interface AmazonRDS

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

DBInstanceAlreadyExistsException

DBInstanceNotFoundException

StorageQuotaExceededException

InvalidVPCNetworkStateException

InvalidDBInstanceStateException

DBSecurityGroupNotFoundException

InvalidDBSecurityGroupStateException

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.

deleteDBInstance

public 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 DBSnapshot is requested the status of the RDS instance will be "deleting" until the DBSnapshot is created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.

Specified by:

deleteDBInstance in interface AmazonRDS

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.

describeDBParameterGroups

public 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 DBParameterGroup.

Specified by:

describeDBParameterGroups in interface AmazonRDS

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.

purchaseReservedDBInstancesOffering

public ReservedDBInstance purchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Purchases a reserved DB Instance offering.

Specified by:

purchaseReservedDBInstancesOffering in interface AmazonRDS

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.

deleteDBParameterGroup

public void deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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

NOTE: The specified DB Parameter Group cannot be associated with any DB Instances.

Specified by:

deleteDBParameterGroup in interface AmazonRDS

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.

deleteEventSubscription

public EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Deletes an RDS event notification subscription.

Specified by:

deleteEventSubscription in interface AmazonRDS

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.

createEventSubscription

public 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.

Specified by:

createEventSubscription in interface AmazonRDS

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.

resetDBParameterGroup

public ResetDBParameterGroupResult resetDBParameterGroup(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup 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.

Specified by:

resetDBParameterGroup in interface AmazonRDS

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.

createDBSnapshot

public DBSnapshot createDBSnapshot(CreateDBSnapshotRequest createDBSnapshotRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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

Specified by:

createDBSnapshot in interface AmazonRDS

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.

deleteDBSnapshot

public DBSnapshot deleteDBSnapshot(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes a DBSnapshot.

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

Specified by:

deleteDBSnapshot in interface AmazonRDS

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.

downloadDBLogFilePortion

public DownloadDBLogFilePortionResult downloadDBLogFilePortion(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Downloads the last line of the specified log file.

Specified by:

downloadDBLogFilePortion in interface AmazonRDS

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:

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.

createDBSubnetGroup

public 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.

Specified by:

createDBSubnetGroup in interface AmazonRDS

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.

modifyEventSubscription

public 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.

Specified by:

modifyEventSubscription in interface AmazonRDS

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.

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Lists all tags on a DB Instance.

For an overview on tagging DB Instances, see DB Instance Tags.

Specified by:

listTagsForResource in interface AmazonRDS

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.

modifyOptionGroup

public OptionGroup modifyOptionGroup(ModifyOptionGroupRequest modifyOptionGroupRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Modifies an existing Option Group.

Specified by:

modifyOptionGroup in interface AmazonRDS

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.

describeEventSubscriptions

public 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.

Specified by:

describeEventSubscriptions in interface AmazonRDS

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.

createOptionGroup

public OptionGroup createOptionGroup(CreateOptionGroupRequest createOptionGroupRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

Specified by:

createOptionGroup in interface AmazonRDS

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.

describeDBLogFiles

public DescribeDBLogFilesResult describeDBLogFiles(DescribeDBLogFilesRequest describeDBLogFilesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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

Specified by:

describeDBLogFiles in interface AmazonRDS

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.

modifyDBSubnetGroup

public 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.

Specified by:

modifyDBSubnetGroup in interface AmazonRDS

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.

describeReservedDBInstances

public DescribeReservedDBInstancesResult describeReservedDBInstances(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.

Specified by:

describeReservedDBInstances in interface AmazonRDS

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.

removeSourceIdentifierFromSubscription

public EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

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

Specified by:

removeSourceIdentifierFromSubscription in interface AmazonRDS

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.

createDBInstanceReadReplica

public DBInstance createDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

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.

Specified by:

createDBInstanceReadReplica in interface AmazonRDS

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

DBSecurityGroupNotFoundException

InvalidSubnetException

InstanceQuotaExceededException

StorageQuotaExceededException

InvalidDBInstanceStateException

InsufficientDBInstanceCapacityException

DBSubnetGroupDoesNotCoverEnoughAZsException

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.

describeEventCategories

public 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.

Specified by:

describeEventCategories in interface AmazonRDS

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.

deleteOptionGroup

public void deleteOptionGroup(DeleteOptionGroupRequest deleteOptionGroupRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Deletes an existing Option Group.

Specified by:

deleteOptionGroup in interface AmazonRDS

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.

authorizeDBSecurityGroupIngress

public 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 .

Specified by:

authorizeDBSecurityGroupIngress in interface AmazonRDS

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.

describeEvents

public 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.

Specified by:

describeEvents in interface AmazonRDS

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.

describeDBParameters

public DescribeDBParametersResult describeDBParameters(DescribeDBParametersRequest describeDBParametersRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns the detailed parameter list for a particular DBParameterGroup.

Specified by:

describeDBParameters in interface AmazonRDS

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.

describeEngineDefaultParameters

public EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

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

Specified by:

describeEngineDefaultParameters in interface AmazonRDS

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.

createDBSecurityGroup

public DBSecurityGroup createDBSecurityGroup(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Creates a new DB Security Group. DB Security Groups control access to a DB Instance.

Specified by:

createDBSecurityGroup in interface AmazonRDS

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.

describeDBSubnetGroups

public 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 .

Specified by:

describeDBSubnetGroups in interface AmazonRDS

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.

describeDBSnapshots

public DescribeDBSnapshotsResult describeDBSnapshots(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about DBSnapshots. This API supports pagination.

Specified by:

describeDBSnapshots in interface AmazonRDS

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.

rebootDBInstance

public DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS 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. A DBInstance event is created when the reboot is completed.

Specified by:

rebootDBInstance in interface AmazonRDS

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.

deleteDBSecurityGroup

public 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.

Specified by:

deleteDBSecurityGroup in interface AmazonRDS

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.

createDBParameterGroup

public 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 for the new DB Parameter Group and associated settings to take effect.

Specified by:

createDBParameterGroup in interface AmazonRDS

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.

restoreDBInstanceFromDBSnapshot

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

Specified by:

restoreDBInstanceFromDBSnapshot in interface AmazonRDS

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

InvalidSubnetException

DBSnapshotNotFoundException

InvalidRestoreException

InstanceQuotaExceededException

StorageQuotaExceededException

InsufficientDBInstanceCapacityException

DBSubnetGroupDoesNotCoverEnoughAZsException

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.

restoreDBInstanceToPointInTime

public 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 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.

Specified by:

restoreDBInstanceToPointInTime in interface AmazonRDS

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

InvalidSubnetException

InvalidRestoreException

InstanceQuotaExceededException

StorageQuotaExceededException

InvalidDBInstanceStateException

InsufficientDBInstanceCapacityException

DBSubnetGroupDoesNotCoverEnoughAZsException

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.

removeTagsFromResource

public void removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Removes metadata tags from a DB Instance.

For an overview on tagging DB Instances, see DB Instance Tags.

Specified by:

removeTagsFromResource in interface AmazonRDS

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.

describeOptionGroupOptions

public DescribeOptionGroupOptionsResult describeOptionGroupOptions(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Describes all available options.

Specified by:

describeOptionGroupOptions in interface AmazonRDS

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.

modifyDBParameterGroup

public ModifyDBParameterGroupResult modifyDBParameterGroup(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Modifies the parameters of a DBParameterGroup. 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: The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB Instances for either dynamic or static parameters. For Microsoft SQL Server DB Instances, the pending-reboot method can be used only for static parameters.

Specified by:

modifyDBParameterGroup in interface AmazonRDS

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.

addSourceIdentifierToSubscription

public EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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

Specified by:

addSourceIdentifierToSubscription in interface AmazonRDS

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.

createDBInstance

public DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Creates a new DB instance.

Specified by:

createDBInstance in interface AmazonRDS

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

InstanceQuotaExceededException

DBSubnetGroupNotFoundException

DBInstanceAlreadyExistsException

StorageQuotaExceededException

InvalidVPCNetworkStateException

DBSecurityGroupNotFoundException

InsufficientDBInstanceCapacityException

DBSubnetGroupDoesNotCoverEnoughAZsException

InvalidSubnetException

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.

deleteDBSubnetGroup

public 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.

Specified by:

deleteDBSubnetGroup in interface AmazonRDS

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.

addTagsToResource

public void addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Adds metadata tags to a DB Instance. These tags can also be used with cost allocation reporting to track cost associated with a DB Instance.

For an overview on tagging DB Instances, see DB Instance Tags.

Specified by:

addTagsToResource in interface AmazonRDS

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.

describeReservedDBInstancesOfferings

public DescribeReservedDBInstancesOfferingsResult describeReservedDBInstancesOfferings()
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

Lists available reserved DB Instance offerings.

Specified by:

describeReservedDBInstancesOfferings in interface 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.

describeDBInstances

public DescribeDBInstancesResult describeDBInstances()
                                              throws AmazonServiceException,
                                                     AmazonClientException

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

Specified by:

describeDBInstances in interface 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.

describeDBEngineVersions

public DescribeDBEngineVersionsResult describeDBEngineVersions()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Returns a list of the available DB engines.

Specified by:

describeDBEngineVersions in interface 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.

describeOptionGroups

public DescribeOptionGroupsResult describeOptionGroups()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Describes the available option groups.

Specified by:

describeOptionGroups in interface 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.

describeDBSecurityGroups

public 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 DBSecurityGroup.

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

Specified by:

describeDBSecurityGroups in interface 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.

describeDBParameterGroups

public 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 DBParameterGroup.

Specified by:

describeDBParameterGroups in interface 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.

downloadDBLogFilePortion

public DownloadDBLogFilePortionResult downloadDBLogFilePortion()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Downloads the last line of the specified log file.

Specified by:

downloadDBLogFilePortion in interface AmazonRDS

Returns:

The response from the DownloadDBLogFilePortion 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.

describeEventSubscriptions

public 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.

Specified by:

describeEventSubscriptions in interface 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.

describeDBLogFiles

public DescribeDBLogFilesResult describeDBLogFiles()
                                            throws AmazonServiceException,
                                                   AmazonClientException

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

Specified by:

describeDBLogFiles in interface 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

public DescribeReservedDBInstancesResult describeReservedDBInstances()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.

Specified by:

describeReservedDBInstances in interface 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.

describeEventCategories

public 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.

Specified by:

describeEventCategories in interface 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.

describeEvents

public 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.

Specified by:

describeEvents in interface 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.

describeDBSubnetGroups

public 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 .

Specified by:

describeDBSubnetGroups in interface 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.

describeDBSnapshots

public DescribeDBSnapshotsResult describeDBSnapshots()
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about DBSnapshots. This API supports pagination.

Specified by:

describeDBSnapshots in interface 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.

setEndpoint

public void setEndpoint(String endpoint,
                        String serviceName,
                        String regionId)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://rds.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

This method is not threadsafe. Endpoints 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.

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

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.

serviceName - The name of the AWS service to use when signing requests.

regionId - The ID of the region in which this service resides.

Throws:

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonRDS

Parameters:

request - The originally executed request

Returns:

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