AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
 

Classes

NameDescription
Class AccountQuota Describes a quota for an AWS account, for example, the number of DB instances allowed.
Class AddSourceIdentifierToSubscriptionRequest Container for the parameters to the AddSourceIdentifierToSubscription operation. Adds a source identifier to an existing RDS event notification subscription.
Class AddSourceIdentifierToSubscriptionResponse Configuration for accessing Amazon AddSourceIdentifierToSubscription service
Class AddSourceIdentifierToSubscriptionResult
Class AddTagsToResourceRequest Container for the parameters to the AddTagsToResource operation. Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

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

Class AddTagsToResourceResponse
Class ApplyPendingMaintenanceActionRequest Container for the parameters to the ApplyPendingMaintenanceAction operation. Applies a pending maintenance action to a resource (for example, to a DB instance).
Class ApplyPendingMaintenanceActionResponse Configuration for accessing Amazon ApplyPendingMaintenanceAction service
Class ApplyPendingMaintenanceActionResult
Class AuthorizationAlreadyExistsException RDS exception
Class AuthorizationNotFoundException RDS exception
Class AuthorizationQuotaExceededException RDS exception
Class AuthorizeDBSecurityGroupIngressRequest Container for the parameters to the AuthorizeDBSecurityGroupIngress operation. 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). 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.

Class AuthorizeDBSecurityGroupIngressResponse Configuration for accessing Amazon AuthorizeDBSecurityGroupIngress service
Class AuthorizeDBSecurityGroupIngressResult
Class AvailabilityZone Contains Availability Zone information.

This data type is used as an element in the following data type:

Class Certificate A CA certificate for an AWS account.
Class CertificateNotFoundException RDS exception
Class CharacterSet This data type is used as a response element in the action DescribeDBEngineVersions.
Class CopyDBClusterSnapshotRequest Container for the parameters to the CopyDBClusterSnapshot operation. Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class CopyDBClusterSnapshotResponse Configuration for accessing Amazon CopyDBClusterSnapshot service
Class CopyDBClusterSnapshotResult
Class CopyDBParameterGroupRequest Container for the parameters to the CopyDBParameterGroup operation. Copies the specified DB parameter group.
Class CopyDBParameterGroupResponse Configuration for accessing Amazon CopyDBParameterGroup service
Class CopyDBParameterGroupResult
Class CopyDBSnapshotRequest Container for the parameters to the CopyDBSnapshot operation. Copies the specified DBSnapshot. The source DB snapshot must be in the "available" state.

If you are copying from a shared manual DB snapshot, the SourceDBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Class CopyDBSnapshotResponse Configuration for accessing Amazon CopyDBSnapshot service
Class CopyDBSnapshotResult
Class CopyOptionGroupRequest Container for the parameters to the CopyOptionGroup operation. Copies the specified option group.
Class CopyOptionGroupResponse Configuration for accessing Amazon CopyOptionGroup service
Class CopyOptionGroupResult
Class CreateDBClusterParameterGroupRequest Container for the parameters to the CreateDBClusterParameterGroup operation. Creates a new DB cluster parameter group.

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

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

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class CreateDBClusterParameterGroupResponse Configuration for accessing Amazon CreateDBClusterParameterGroup service
Class CreateDBClusterParameterGroupResult
Class CreateDBClusterRequest Container for the parameters to the CreateDBCluster operation. Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class CreateDBClusterResponse Configuration for accessing Amazon CreateDBCluster service
Class CreateDBClusterResult
Class CreateDBClusterSnapshotRequest Container for the parameters to the CreateDBClusterSnapshot operation. Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class CreateDBClusterSnapshotResponse Configuration for accessing Amazon CreateDBClusterSnapshot service
Class CreateDBClusterSnapshotResult
Class CreateDBInstanceReadReplicaRequest Container for the parameters to the CreateDBInstanceReadReplica operation. Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.

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

The source DB instance must have backup retention enabled.

Class CreateDBInstanceReadReplicaResponse Configuration for accessing Amazon CreateDBInstanceReadReplica service
Class CreateDBInstanceReadReplicaResult
Class CreateDBInstanceRequest Container for the parameters to the CreateDBInstance operation. Creates a new DB instance.
Class CreateDBInstanceResponse Configuration for accessing Amazon CreateDBInstance service
Class CreateDBInstanceResult
Class CreateDBParameterGroupRequest Container for the parameters to the CreateDBParameterGroup operation. Creates a new DB parameter group.

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

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

Class CreateDBParameterGroupResponse Configuration for accessing Amazon CreateDBParameterGroup service
Class CreateDBParameterGroupResult
Class CreateDBSecurityGroupRequest Container for the parameters to the CreateDBSecurityGroup operation. Creates a new DB security group. DB security groups control access to a DB instance.
Class CreateDBSecurityGroupResponse Configuration for accessing Amazon CreateDBSecurityGroup service
Class CreateDBSecurityGroupResult
Class CreateDBSnapshotRequest Container for the parameters to the CreateDBSnapshot operation. Creates a DBSnapshot. The source DBInstance must be in "available" state.
Class CreateDBSnapshotResponse Configuration for accessing Amazon CreateDBSnapshot service
Class CreateDBSnapshotResult
Class CreateDBSubnetGroupRequest Container for the parameters to the CreateDBSubnetGroup operation. Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
Class CreateDBSubnetGroupResponse Configuration for accessing Amazon CreateDBSubnetGroup service
Class CreateDBSubnetGroupResult
Class CreateEventSubscriptionRequest Container for the parameters to the CreateEventSubscription operation. 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.

Class CreateEventSubscriptionResponse Configuration for accessing Amazon CreateEventSubscription service
Class CreateEventSubscriptionResult
Class CreateOptionGroupRequest Container for the parameters to the CreateOptionGroup operation. Creates a new option group. You can create up to 20 option groups.
Class CreateOptionGroupResponse Configuration for accessing Amazon CreateOptionGroup service
Class CreateOptionGroupResult
Class DBCluster Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBClusters action.

Class DBClusterAlreadyExistsException RDS exception
Class DBClusterMember Contains information about an instance that is part of a DB cluster.
Class DBClusterNotFoundException RDS exception
Class DBClusterOptionGroupStatus Contains status information for a DB cluster option group.
Class DBClusterParameterGroup Contains the result of a successful invocation of the CreateDBClusterParameterGroup action.

This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.

Class DBClusterParameterGroupNotFoundException RDS exception
Class DBClusterQuotaExceededException RDS exception
Class DBClusterSnapshot Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBClusterSnapshots action.

Class DBClusterSnapshotAlreadyExistsException RDS exception
Class DBClusterSnapshotNotFoundException RDS exception
Class DBEngineVersion This data type is used as a response element in the action DescribeDBEngineVersions.
Class DBInstance Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

Class DBInstanceAlreadyExistsException RDS exception
Class DBInstanceNotFoundException RDS exception
Class DBInstanceStatusInfo Provides a list of status information for a DB instance.
Class DBLogFileNotFoundException RDS exception
Class DBParameterGroup Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

Class DBParameterGroupAlreadyExistsException RDS exception
Class DBParameterGroupNotFoundException RDS exception
Class DBParameterGroupQuotaExceededException RDS exception
Class DBParameterGroupStatus The status of the DB parameter group.

This data type is used as a response element in the following actions:

Class DBSecurityGroup Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

Class DBSecurityGroupAlreadyExistsException RDS exception
Class DBSecurityGroupMembership This data type is used as a response element in the following actions:
Class DBSecurityGroupNotFoundException RDS exception
Class DBSecurityGroupNotSupportedException RDS exception
Class DBSecurityGroupQuotaExceededException RDS exception
Class DBSnapshot Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

Class DBSnapshotAlreadyExistsException RDS exception
Class DBSnapshotAttribute Contains the name and values of a manual DB snapshot attribute

Manual DB snapshot attributes are used to authorize other AWS accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

Class DBSnapshotAttributesResult Contains the results of a successful call to the DescribeDBSnapshotAttributes API.

Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

Class DBSnapshotNotFoundException RDS exception
Class DBSubnetGroup Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

Class DBSubnetGroupAlreadyExistsException RDS exception
Class DBSubnetGroupDoesNotCoverEnoughAZsException RDS exception
Class DBSubnetGroupNotAllowedException RDS exception
Class DBSubnetGroupNotFoundException RDS exception
Class DBSubnetGroupQuotaExceededException RDS exception
Class DBSubnetQuotaExceededException RDS exception
Class DBUpgradeDependencyFailureException RDS exception
Class DeleteDBClusterParameterGroupRequest Container for the parameters to the DeleteDBClusterParameterGroup operation. Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class DeleteDBClusterParameterGroupResponse
Class DeleteDBClusterRequest Container for the parameters to the DeleteDBCluster operation. The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class DeleteDBClusterResponse Configuration for accessing Amazon DeleteDBCluster service
Class DeleteDBClusterResult
Class DeleteDBClusterSnapshotRequest Container for the parameters to the DeleteDBClusterSnapshot operation. Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class DeleteDBClusterSnapshotResponse Configuration for accessing Amazon DeleteDBClusterSnapshot service
Class DeleteDBClusterSnapshotResult
Class DeleteDBInstanceRequest Container for the parameters to the DeleteDBInstance operation. The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

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

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

Class DeleteDBInstanceResponse Configuration for accessing Amazon DeleteDBInstance service
Class DeleteDBInstanceResult
Class DeleteDBParameterGroupRequest Container for the parameters to the DeleteDBParameterGroup operation. Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
Class DeleteDBParameterGroupResponse
Class DeleteDBSecurityGroupRequest Container for the parameters to the DeleteDBSecurityGroup operation. Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
Class DeleteDBSecurityGroupResponse
Class DeleteDBSnapshotRequest Container for the parameters to the DeleteDBSnapshot operation. Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated. The DBSnapshot must be in the available state to be deleted.
Class DeleteDBSnapshotResponse Configuration for accessing Amazon DeleteDBSnapshot service
Class DeleteDBSnapshotResult
Class DeleteDBSubnetGroupRequest Container for the parameters to the DeleteDBSubnetGroup operation. Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
Class DeleteDBSubnetGroupResponse
Class DeleteEventSubscriptionRequest Container for the parameters to the DeleteEventSubscription operation. Deletes an RDS event notification subscription.
Class DeleteEventSubscriptionResponse Configuration for accessing Amazon DeleteEventSubscription service
Class DeleteEventSubscriptionResult
Class DeleteOptionGroupRequest Container for the parameters to the DeleteOptionGroup operation. Deletes an existing option group.
Class DeleteOptionGroupResponse
Class DescribeAccountAttributesRequest Container for the parameters to the DescribeAccountAttributes operation. Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command does not take any parameters.

Class DescribeAccountAttributesResponse Configuration for accessing Amazon DescribeAccountAttributes service
Class DescribeAccountAttributesResult Data returned by the DescribeAccountAttributes action.
Class DescribeCertificatesRequest Container for the parameters to the DescribeCertificates operation. Lists the set of CA certificates provided by Amazon RDS for this AWS account.
Class DescribeCertificatesResponse Configuration for accessing Amazon DescribeCertificates service
Class DescribeCertificatesResult Data returned by the DescribeCertificates action.
Class DescribeDBClusterParameterGroupsRequest Container for the parameters to the DescribeDBClusterParameterGroups operation. Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class DescribeDBClusterParameterGroupsResponse Configuration for accessing Amazon DescribeDBClusterParameterGroups service
Class DescribeDBClusterParameterGroupsResult
Class DescribeDBClusterParametersRequest Container for the parameters to the DescribeDBClusterParameters operation. Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class DescribeDBClusterParametersResponse Configuration for accessing Amazon DescribeDBClusterParameters service
Class DescribeDBClusterParametersResult Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
Class DescribeDBClusterSnapshotsRequest Container for the parameters to the DescribeDBClusterSnapshots operation. Returns information about DB cluster snapshots. This API supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class DescribeDBClusterSnapshotsResponse Configuration for accessing Amazon DescribeDBClusterSnapshots service
Class DescribeDBClusterSnapshotsResult Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
Class DescribeDBClustersRequest Container for the parameters to the DescribeDBClusters operation. Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class DescribeDBClustersResponse Configuration for accessing Amazon DescribeDBClusters service
Class DescribeDBClustersResult Contains the result of a successful invocation of the DescribeDBClusters action.
Class DescribeDBEngineVersionsRequest Container for the parameters to the DescribeDBEngineVersions operation. Returns a list of the available DB engines.
Class DescribeDBEngineVersionsResponse Configuration for accessing Amazon DescribeDBEngineVersions service
Class DescribeDBEngineVersionsResult Contains the result of a successful invocation of the DescribeDBEngineVersions action.
Class DescribeDBInstancesRequest Container for the parameters to the DescribeDBInstances operation. Returns information about provisioned RDS instances. This API supports pagination.
Class DescribeDBInstancesResponse Configuration for accessing Amazon DescribeDBInstances service
Class DescribeDBInstancesResult Contains the result of a successful invocation of the DescribeDBInstances action.
Class DescribeDBLogFilesDetails This data type is used as a response element to DescribeDBLogFiles.
Class DescribeDBLogFilesRequest Container for the parameters to the DescribeDBLogFiles operation. Returns a list of DB log files for the DB instance.
Class DescribeDBLogFilesResponse Configuration for accessing Amazon DescribeDBLogFiles service
Class DescribeDBLogFilesResult The response from a call to DescribeDBLogFiles.
Class DescribeDBParameterGroupsRequest Container for the parameters to the DescribeDBParameterGroups operation. Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Class DescribeDBParameterGroupsResponse Configuration for accessing Amazon DescribeDBParameterGroups service
Class DescribeDBParameterGroupsResult Contains the result of a successful invocation of the DescribeDBParameterGroups action.
Class DescribeDBParametersRequest Container for the parameters to the DescribeDBParameters operation. Returns the detailed parameter list for a particular DB parameter group.
Class DescribeDBParametersResponse Configuration for accessing Amazon DescribeDBParameters service
Class DescribeDBParametersResult Contains the result of a successful invocation of the DescribeDBParameters action.
Class DescribeDBSecurityGroupsRequest Container for the parameters to the DescribeDBSecurityGroups operation. Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
Class DescribeDBSecurityGroupsResponse Configuration for accessing Amazon DescribeDBSecurityGroups service
Class DescribeDBSecurityGroupsResult Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
Class DescribeDBSnapshotAttributesRequest Container for the parameters to the DescribeDBSnapshotAttributes operation. Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of the AWS account ids that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API.

Class DescribeDBSnapshotAttributesResponse Configuration for accessing Amazon DescribeDBSnapshotAttributes service
Class DescribeDBSnapshotAttributesResult
Class DescribeDBSnapshotsRequest Container for the parameters to the DescribeDBSnapshots operation. Returns information about DB snapshots. This API supports pagination.
Class DescribeDBSnapshotsResponse Configuration for accessing Amazon DescribeDBSnapshots service
Class DescribeDBSnapshotsResult Contains the result of a successful invocation of the DescribeDBSnapshots action.
Class DescribeDBSubnetGroupsRequest Container for the parameters to the DescribeDBSubnetGroups operation. 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.

Class DescribeDBSubnetGroupsResponse Configuration for accessing Amazon DescribeDBSubnetGroups service
Class DescribeDBSubnetGroupsResult Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
Class DescribeEngineDefaultClusterParametersRequest Container for the parameters to the DescribeEngineDefaultClusterParameters operation. Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class DescribeEngineDefaultClusterParametersResponse Configuration for accessing Amazon DescribeEngineDefaultClusterParameters service
Class DescribeEngineDefaultClusterParametersResult
Class DescribeEngineDefaultParametersRequest Container for the parameters to the DescribeEngineDefaultParameters operation. Returns the default engine and system parameter information for the specified database engine.
Class DescribeEngineDefaultParametersResponse Configuration for accessing Amazon DescribeEngineDefaultParameters service
Class DescribeEngineDefaultParametersResult
Class DescribeEventCategoriesRequest Container for the parameters to the DescribeEventCategories operation. 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.
Class DescribeEventCategoriesResponse Configuration for accessing Amazon DescribeEventCategories service
Class DescribeEventCategoriesResult Data returned from the DescribeEventCategories action.
Class DescribeEventsRequest Container for the parameters to the DescribeEvents operation. 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.
Class DescribeEventsResponse Configuration for accessing Amazon DescribeEvents service
Class DescribeEventsResult Contains the result of a successful invocation of the DescribeEvents action.
Class DescribeEventSubscriptionsRequest Container for the parameters to the DescribeEventSubscriptions operation. 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.

Class DescribeEventSubscriptionsResponse Configuration for accessing Amazon DescribeEventSubscriptions service
Class DescribeEventSubscriptionsResult Data returned by the DescribeEventSubscriptions action.
Class DescribeOptionGroupOptionsRequest Container for the parameters to the DescribeOptionGroupOptions operation. Describes all available options.
Class DescribeOptionGroupOptionsResponse Configuration for accessing Amazon DescribeOptionGroupOptions service
Class DescribeOptionGroupOptionsResult
Class DescribeOptionGroupsRequest Container for the parameters to the DescribeOptionGroups operation. Describes the available option groups.
Class DescribeOptionGroupsResponse Configuration for accessing Amazon DescribeOptionGroups service
Class DescribeOptionGroupsResult List of option groups.
Class DescribeOrderableDBInstanceOptionsRequest Container for the parameters to the DescribeOrderableDBInstanceOptions operation. Returns a list of orderable DB instance options for the specified engine.
Class DescribeOrderableDBInstanceOptionsResponse Configuration for accessing Amazon DescribeOrderableDBInstanceOptions service
Class DescribeOrderableDBInstanceOptionsResult Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
Class DescribePendingMaintenanceActionsRequest Container for the parameters to the DescribePendingMaintenanceActions operation. Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
Class DescribePendingMaintenanceActionsResponse Configuration for accessing Amazon DescribePendingMaintenanceActions service
Class DescribePendingMaintenanceActionsResult Data returned from the DescribePendingMaintenanceActions action.
Class DescribeReservedDBInstancesOfferingsRequest Container for the parameters to the DescribeReservedDBInstancesOfferings operation. Lists available reserved DB instance offerings.
Class DescribeReservedDBInstancesOfferingsResponse Configuration for accessing Amazon DescribeReservedDBInstancesOfferings service
Class DescribeReservedDBInstancesOfferingsResult Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
Class DescribeReservedDBInstancesRequest Container for the parameters to the DescribeReservedDBInstances operation. Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
Class DescribeReservedDBInstancesResponse Configuration for accessing Amazon DescribeReservedDBInstances service
Class DescribeReservedDBInstancesResult Contains the result of a successful invocation of the DescribeReservedDBInstances action.
Class DownloadDBLogFilePortionRequest Container for the parameters to the DownloadDBLogFilePortion operation. Downloads all or a portion of the specified log file, up to 1 MB in size.
Class DownloadDBLogFilePortionResponse Configuration for accessing Amazon DownloadDBLogFilePortion service
Class DownloadDBLogFilePortionResult This data type is used as a response element to DownloadDBLogFilePortion.
Class EC2SecurityGroup This data type is used as a response element in the following actions:
Class Endpoint This data type is used as a response element in the following actions:
Class EngineDefaults Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
Class Event This data type is used as a response element in the DescribeEvents action.
Class EventCategoriesMap Contains the results of a successful invocation of the DescribeEventCategories action.
Class EventSubscription Contains the results of a successful invocation of the DescribeEventSubscriptions action.
Class EventSubscriptionQuotaExceededException RDS exception
Class FailoverDBClusterRequest Container for the parameters to the FailoverDBCluster operation. Forces a failover for a DB cluster.

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

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class FailoverDBClusterResponse Configuration for accessing Amazon FailoverDBCluster service
Class FailoverDBClusterResult
Class Filter
Class InstanceQuotaExceededException RDS exception
Class InsufficientDBClusterCapacityException RDS exception
Class InsufficientDBInstanceCapacityException RDS exception
Class InsufficientStorageClusterCapacityException RDS exception
Class InvalidDBClusterSnapshotStateException RDS exception
Class InvalidDBClusterStateException RDS exception
Class InvalidDBInstanceStateException RDS exception
Class InvalidDBParameterGroupStateException RDS exception
Class InvalidDBSecurityGroupStateException RDS exception
Class InvalidDBSnapshotStateException RDS exception
Class InvalidDBSubnetGroupException RDS exception
Class InvalidDBSubnetGroupStateException RDS exception
Class InvalidDBSubnetStateException RDS exception
Class InvalidEventSubscriptionStateException RDS exception
Class InvalidOptionGroupStateException RDS exception
Class InvalidRestoreException RDS exception
Class InvalidSubnetException RDS exception
Class InvalidVPCNetworkStateException RDS exception
Class IPRange This data type is used as a response element in the DescribeDBSecurityGroups action.
Class KMSKeyNotAccessibleException RDS exception
Class ListTagsForResourceRequest Container for the parameters to the ListTagsForResource operation. Lists all tags on an Amazon RDS resource.

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

Class ListTagsForResourceResponse Configuration for accessing Amazon ListTagsForResource service
Class ListTagsForResourceResult
Class ModifyDBClusterParameterGroupRequest Container for the parameters to the ModifyDBClusterParameterGroup operation. Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

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

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

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

Class ModifyDBClusterParameterGroupResponse Configuration for accessing Amazon ModifyDBClusterParameterGroup service
Class ModifyDBClusterParameterGroupResult
Class ModifyDBClusterRequest Container for the parameters to the ModifyDBCluster operation. Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class ModifyDBClusterResponse Configuration for accessing Amazon ModifyDBCluster service
Class ModifyDBClusterResult
Class ModifyDBInstanceRequest Container for the parameters to the ModifyDBInstance operation. 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.
Class ModifyDBInstanceResponse Configuration for accessing Amazon ModifyDBInstance service
Class ModifyDBInstanceResult
Class ModifyDBParameterGroupRequest Container for the parameters to the ModifyDBParameterGroup operation. Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

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

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

Class ModifyDBParameterGroupResponse Configuration for accessing Amazon ModifyDBParameterGroup service
Class ModifyDBParameterGroupResult Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
Class ModifyDBSnapshotAttributeRequest Container for the parameters to the ModifyDBSnapshotAttribute operation. Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.

To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of the AWS account ids that are authorized to retore the manual DB snapshot. Uses the value all to make the manual DB snapshot public and can by copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you do not want to be available to all AWS accounts.

To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API.

If the manual DB snapshot is encrypted, it cannot be shared.

Class ModifyDBSnapshotAttributeResponse Configuration for accessing Amazon ModifyDBSnapshotAttribute service
Class ModifyDBSnapshotAttributeResult
Class ModifyDBSubnetGroupRequest Container for the parameters to the ModifyDBSubnetGroup operation. Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
Class ModifyDBSubnetGroupResponse Configuration for accessing Amazon ModifyDBSubnetGroup service
Class ModifyDBSubnetGroupResult
Class ModifyEventSubscriptionRequest Container for the parameters to the ModifyEventSubscription operation. 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.

Class ModifyEventSubscriptionResponse Configuration for accessing Amazon ModifyEventSubscription service
Class ModifyEventSubscriptionResult
Class ModifyOptionGroupRequest Container for the parameters to the ModifyOptionGroup operation. Modifies an existing option group.
Class ModifyOptionGroupResponse Configuration for accessing Amazon ModifyOptionGroup service
Class ModifyOptionGroupResult
Class Option Option details.
Class OptionConfiguration A list of all available options
Class OptionGroup
Class OptionGroupAlreadyExistsException RDS exception
Class OptionGroupMembership Provides information on the option groups the DB instance is a member of.
Class OptionGroupNotFoundException RDS exception
Class OptionGroupOption Available option.
Class OptionGroupOptionSetting Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
Class OptionGroupQuotaExceededException RDS exception
Class OptionSetting Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
Class OrderableDBInstanceOption Contains a list of available options for a DB instance

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

Class Parameter This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

Class PendingMaintenanceAction Provides information about a pending maintenance action for a resource.
Class PendingModifiedValues This data type is used as a response element in the ModifyDBInstance action.
Class PointInTimeRestoreNotEnabledException RDS exception
Class PromoteReadReplicaRequest Container for the parameters to the PromoteReadReplica operation. Promotes a Read Replica DB instance to a standalone DB instance.

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

Class PromoteReadReplicaResponse Configuration for accessing Amazon PromoteReadReplica service
Class PromoteReadReplicaResult
Class ProvisionedIopsNotAvailableInAZException RDS exception
Class PurchaseReservedDBInstancesOfferingRequest Container for the parameters to the PurchaseReservedDBInstancesOffering operation. Purchases a reserved DB instance offering.
Class PurchaseReservedDBInstancesOfferingResponse Configuration for accessing Amazon PurchaseReservedDBInstancesOffering service
Class PurchaseReservedDBInstancesOfferingResult
Class RebootDBInstanceRequest Container for the parameters to the RebootDBInstance operation. Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

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

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

Class RebootDBInstanceResponse Configuration for accessing Amazon RebootDBInstance service
Class RebootDBInstanceResult
Class RecurringCharge This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
Class RemoveSourceIdentifierFromSubscriptionRequest Container for the parameters to the RemoveSourceIdentifierFromSubscription operation. Removes a source identifier from an existing RDS event notification subscription.
Class RemoveSourceIdentifierFromSubscriptionResponse Configuration for accessing Amazon RemoveSourceIdentifierFromSubscription service
Class RemoveSourceIdentifierFromSubscriptionResult
Class RemoveTagsFromResourceRequest Container for the parameters to the RemoveTagsFromResource operation. Removes metadata tags from an Amazon RDS resource.

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

Class RemoveTagsFromResourceResponse
Class ReservedDBInstance This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
Class ReservedDBInstanceAlreadyExistsException RDS exception
Class ReservedDBInstanceNotFoundException RDS exception
Class ReservedDBInstanceQuotaExceededException RDS exception
Class ReservedDBInstancesOffering This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
Class ReservedDBInstancesOfferingNotFoundException RDS exception
Class ResetDBClusterParameterGroupRequest Container for the parameters to the ResetDBClusterParameterGroup operation. Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class ResetDBClusterParameterGroupResponse Configuration for accessing Amazon ResetDBClusterParameterGroup service
Class ResetDBClusterParameterGroupResult
Class ResetDBParameterGroupRequest Container for the parameters to the ResetDBParameterGroup operation. Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
Class ResetDBParameterGroupResponse Configuration for accessing Amazon ResetDBParameterGroup service
Class ResetDBParameterGroupResult Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
Class ResourceNotFoundException RDS exception
Class ResourcePendingMaintenanceActions Describes the pending maintenance actions for a resource.
Class RestoreDBClusterFromSnapshotRequest Container for the parameters to the RestoreDBClusterFromSnapshot operation. Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class RestoreDBClusterFromSnapshotResponse Configuration for accessing Amazon RestoreDBClusterFromSnapshot service
Class RestoreDBClusterFromSnapshotResult
Class RestoreDBClusterToPointInTimeRequest Container for the parameters to the RestoreDBClusterToPointInTime operation. Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
Class RestoreDBClusterToPointInTimeResponse Configuration for accessing Amazon RestoreDBClusterToPointInTime service
Class RestoreDBClusterToPointInTimeResult
Class RestoreDBInstanceFromDBSnapshotRequest Container for the parameters to the RestoreDBInstanceFromDBSnapshot operation. Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

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

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Class RestoreDBInstanceFromDBSnapshotResponse Configuration for accessing Amazon RestoreDBInstanceFromDBSnapshot service
Class RestoreDBInstanceFromDBSnapshotResult
Class RestoreDBInstanceToPointInTimeRequest Container for the parameters to the RestoreDBInstanceToPointInTime operation. Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

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

Class RestoreDBInstanceToPointInTimeResponse Configuration for accessing Amazon RestoreDBInstanceToPointInTime service
Class RestoreDBInstanceToPointInTimeResult
Class RevokeDBSecurityGroupIngressRequest Container for the parameters to the RevokeDBSecurityGroupIngress operation. 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).
Class RevokeDBSecurityGroupIngressResponse Configuration for accessing Amazon RevokeDBSecurityGroupIngress service
Class RevokeDBSecurityGroupIngressResult
Class SharedSnapshotQuotaExceededException RDS exception
Class SnapshotQuotaExceededException RDS exception
Class SNSInvalidTopicException RDS exception
Class SNSNoAuthorizationException RDS exception
Class SNSTopicArnNotFoundException RDS exception
Class SourceNotFoundException RDS exception
Class StorageQuotaExceededException RDS exception
Class StorageTypeNotSupportedException RDS exception
Class Subnet This data type is used as a response element in the DescribeDBSubnetGroups action.
Class SubnetAlreadyInUseException RDS exception
Class SubscriptionAlreadyExistException RDS exception
Class SubscriptionCategoryNotFoundException RDS exception
Class SubscriptionNotFoundException RDS exception
Class Tag Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Class UpgradeTarget The version of the database engine that a DB instance can be upgraded to.
Class VpcSecurityGroupMembership This data type is used as a response element for queries on VPC security group membership.