Types
| All Types | Classes  |
| Name | Description | |
|---|---|---|
| AuthorizationAlreadyExistsException |
AmazonRDS exception
|
| AuthorizationNotFoundException |
AmazonRDS exception
|
| AuthorizationQuotaExceededException |
AmazonRDS exception
|
| 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). 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. |
| AuthorizeDBSecurityGroupIngressResponse |
Returns information about the AuthorizeDBSecurityGroupIngress response and response metadata.
|
| AuthorizeDBSecurityGroupIngressResult |
The results from the AuthorizeDBSecurityGroupIngress action.
|
| AvailabilityZone | Contains Availability Zone information. This data type is used as an element in the following data type:
|
| CopyDBSnapshotRequest |
Container for the parameters to the CopyDBSnapshot operation.
Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state. |
| CopyDBSnapshotResponse |
Returns information about the CopyDBSnapshot response and response metadata.
|
| CopyDBSnapshotResult |
The results from the CopyDBSnapshot action.
|
| CreateDBInstanceReadReplicaRequest |
Container for the parameters to the CreateDBInstanceReadReplica operation.
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. |
| CreateDBInstanceReadReplicaResponse |
Returns information about the CreateDBInstanceReadReplica response and response metadata.
|
| CreateDBInstanceReadReplicaResult |
The results from the CreateDBInstanceReadReplica action.
|
| CreateDBInstanceRequest |
Container for the parameters to the CreateDBInstance operation.
Creates a new DB instance. |
| CreateDBInstanceResponse |
Returns information about the CreateDBInstance response and response metadata.
|
| CreateDBInstanceResult |
The results from the CreateDBInstance action.
|
| 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 for the new DB Parameter Group and associated settings to take effect. |
| CreateDBParameterGroupResponse |
Returns information about the CreateDBParameterGroup response and response metadata.
|
| CreateDBParameterGroupResult |
The results from the CreateDBParameterGroup action.
|
| CreateDBSecurityGroupRequest |
Container for the parameters to the CreateDBSecurityGroup operation.
Creates a new DB Security Group. DB Security Groups control access to a DB Instance. |
| CreateDBSecurityGroupResponse |
Returns information about the CreateDBSecurityGroup response and response metadata.
|
| CreateDBSecurityGroupResult |
The results from the CreateDBSecurityGroup action.
|
| CreateDBSnapshotRequest |
Container for the parameters to the CreateDBSnapshot operation.
Creates a DBSnapshot. The source DBInstance must be in "available" state. |
| CreateDBSnapshotResponse |
Returns information about the CreateDBSnapshot response and response metadata.
|
| CreateDBSnapshotResult |
The results from the CreateDBSnapshot action.
|
| 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 each AZ in the region. |
| CreateDBSubnetGroupResponse |
Returns information about the CreateDBSubnetGroup response and response metadata.
|
| CreateDBSubnetGroupResult |
The results from the CreateDBSubnetGroup action.
|
| DBEngineVersion | This data type is used as a response element in the action DescribeDBEngineVersions. |
| 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. |
| DBInstanceAlreadyExistsException |
AmazonRDS exception
|
| DBInstanceNotFoundException |
AmazonRDS exception
|
| 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. |
| DBParameterGroupAlreadyExistsException |
AmazonRDS exception
|
| DBParameterGroupNotFoundException |
AmazonRDS exception
|
| DBParameterGroupQuotaExceededException |
AmazonRDS exception
|
| DBParameterGroupStatus | The status of the DB Parameter Group. This data type is used as a response element in the following actions:
|
| 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. |
| DBSecurityGroupAlreadyExistsException |
AmazonRDS exception
|
| DBSecurityGroupMembership | This data type is used as a response element in the following actions:
|
| DBSecurityGroupNotFoundException |
AmazonRDS exception
|
| DBSecurityGroupQuotaExceededException |
AmazonRDS exception
|
| 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. |
| DBSnapshotAlreadyExistsException |
AmazonRDS exception
|
| DBSnapshotNotFoundException |
AmazonRDS exception
|
| 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. |
| DBSubnetGroupAlreadyExistsException |
AmazonRDS exception
|
| DBSubnetGroupListDoesNotCoverAllAzException |
AmazonRDS exception
|
| DBSubnetGroupNotFoundException |
AmazonRDS exception
|
| DBSubnetGroupQuotaExceededException |
AmazonRDS exception
|
| DBSubnetQuotaExceededException |
AmazonRDS exception
|
| DeleteDBInstanceRequest |
Container for the parameters to the DeleteDBInstance operation.
The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the request was received correctly. 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. |
| DeleteDBInstanceResponse |
Returns information about the DeleteDBInstance response and response metadata.
|
| DeleteDBInstanceResult |
The results from the DeleteDBInstance action.
|
| DeleteDBParameterGroupRequest |
Container for the parameters to the DeleteDBParameterGroup operation.
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. |
| DeleteDBParameterGroupResponse |
Returns information about the DeleteDBParameterGroup response metadata.
The DeleteDBParameterGroup operation has a void result type.
|
| DeleteDBSecurityGroupRequest |
Container for the parameters to the DeleteDBSecurityGroup operation.
Deletes a DB Security Group. NOTE:The specified DB Security Group must not be associated with any DB Instances. |
| DeleteDBSecurityGroupResponse |
Returns information about the DeleteDBSecurityGroup response metadata.
The DeleteDBSecurityGroup operation has a void result type.
|
| DeleteDBSnapshotRequest |
Container for the parameters to the DeleteDBSnapshot operation.
Deletes a DBSnapshot. NOTE:The DBSnapshot must be in the available state to be deleted. |
| DeleteDBSnapshotResponse |
Returns information about the DeleteDBSnapshot response and response metadata.
|
| DeleteDBSnapshotResult |
The results from the DeleteDBSnapshot action.
|
| DeleteDBSubnetGroupRequest |
Container for the parameters to the DeleteDBSubnetGroup operation.
Deletes a DB subnet group. NOTE:The specified database subnet group must not be associated with any DB instances. |
| DeleteDBSubnetGroupResponse |
Returns information about the DeleteDBSubnetGroup response metadata.
The DeleteDBSubnetGroup operation has a void result type.
|
| DescribeDBEngineVersionsRequest |
Container for the parameters to the DescribeDBEngineVersions operation.
Returns a list of the available DB engines. |
| DescribeDBEngineVersionsResponse |
Returns information about the DescribeDBEngineVersionsResult response and response metadata.
|
| DescribeDBEngineVersionsResult | Contains the result of a successful invocation of the DescribeDBEngineVersions action. |
| DescribeDBInstancesRequest |
Container for the parameters to the DescribeDBInstances operation.
Returns information about provisioned RDS instances. This API supports pagination. |
| DescribeDBInstancesResponse |
Returns information about the DescribeDBInstancesResult response and response metadata.
|
| DescribeDBInstancesResult | Contains the result of a successful invocation of the DescribeDBInstances action. |
| 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 DBParameterGroup. |
| DescribeDBParameterGroupsResponse |
Returns information about the DescribeDBParameterGroupsResult response and response metadata.
|
| DescribeDBParameterGroupsResult | Contains the result of a successful invocation of the DescribeDBParameterGroups action. |
| DescribeDBParametersRequest |
Container for the parameters to the DescribeDBParameters operation.
Returns the detailed parameter list for a particular DBParameterGroup. |
| DescribeDBParametersResponse |
Returns information about the DescribeDBParametersResult response and response metadata.
|
| DescribeDBParametersResult | Contains the result of a successful invocation of the DescribeDBParameters action. |
| 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 DBSecurityGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. |
| DescribeDBSecurityGroupsResponse |
Returns information about the DescribeDBSecurityGroupsResult response and response metadata.
|
| DescribeDBSecurityGroupsResult | Contains the result of a successful invocation of the DescribeDBSecurityGroups action. |
| DescribeDBSnapshotsRequest |
Container for the parameters to the DescribeDBSnapshots operation.
Returns information about DBSnapshots. This API supports pagination. |
| DescribeDBSnapshotsResponse |
Returns information about the DescribeDBSnapshotsResult response and response metadata.
|
| DescribeDBSnapshotsResult | Contains the result of a successful invocation of the DescribeDBSnapshots action. |
| 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. |
| DescribeDBSubnetGroupsResponse |
Returns information about the DescribeDBSubnetGroupsResult response and response metadata.
|
| DescribeDBSubnetGroupsResult | Contains the result of a successful invocation of the DescribeDBSubnetGroups action. |
| DescribeEngineDefaultParametersRequest |
Container for the parameters to the DescribeEngineDefaultParameters operation.
Returns the default engine and system parameter information for the specified database engine. |
| DescribeEngineDefaultParametersResponse |
Returns information about the DescribeEngineDefaultParameters response and response metadata.
|
| DescribeEngineDefaultParametersResult |
The results from the DescribeEngineDefaultParameters action.
|
| 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. |
| DescribeEventsResponse |
Returns information about the DescribeEventsResult response and response metadata.
|
| DescribeEventsResult | Contains the result of a successful invocation of the DescribeEvents action. |
| DescribeOrderableDBInstanceOptionsRequest |
Container for the parameters to the DescribeOrderableDBInstanceOptions operation.
Returns a list of orderable DB Instance options for the specified engine. |
| DescribeOrderableDBInstanceOptionsResponse |
Returns information about the DescribeOrderableDBInstanceOptionsResult response and response metadata.
|
| DescribeOrderableDBInstanceOptionsResult | Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action. |
| DescribeReservedDBInstancesOfferingsRequest |
Container for the parameters to the DescribeReservedDBInstancesOfferings operation.
Lists available reserved DB Instance offerings. |
| DescribeReservedDBInstancesOfferingsResponse |
Returns information about the DescribeReservedDBInstancesOfferingsResult response and response metadata.
|
| DescribeReservedDBInstancesOfferingsResult | Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action. |
| 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. |
| DescribeReservedDBInstancesResponse |
Returns information about the DescribeReservedDBInstancesResult response and response metadata.
|
| DescribeReservedDBInstancesResult | Contains the result of a successful invocation of the DescribeReservedDBInstances action. |
| EC2SecurityGroup | This data type is used as a response element in the following actions:
|
| Endpoint | This data type is used as a response element in the following actions:
|
| EngineDefaults | Contains the result of a successful invocation of the DescribeEngineDefaultParameters action. |
| Event | This data type is used as a response element in the DescribeEvents action. |
| InstanceQuotaExceededException |
AmazonRDS exception
|
| InsufficientDBInstanceCapacityException |
AmazonRDS exception
|
| InvalidDBInstanceStateException |
AmazonRDS exception
|
| InvalidDBParameterGroupStateException |
AmazonRDS exception
|
| InvalidDBSecurityGroupStateException |
AmazonRDS exception
|
| InvalidDBSnapshotStateException |
AmazonRDS exception
|
| InvalidDBSubnetGroupStateException |
AmazonRDS exception
|
| InvalidDBSubnetStateException |
AmazonRDS exception
|
| InvalidRestoreException |
AmazonRDS exception
|
| InvalidSubnetException |
AmazonRDS exception
|
| InvalidVPCNetworkStateException |
AmazonRDS exception
|
| IPRange | This data type is used as a response element in the DescribeDBSecurityGroups action. |
| 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. |
| ModifyDBInstanceResponse |
Returns information about the ModifyDBInstance response and response metadata.
|
| ModifyDBInstanceResult |
The results from the ModifyDBInstance action.
|
| ModifyDBParameterGroupRequest |
Container for the parameters to the ModifyDBParameterGroup operation.
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 only be used for dynamic parameters; the pending-reboot method can be used for either dynamic or static parameters. |
| ModifyDBParameterGroupResponse |
Returns information about the ModifyDBParameterGroupResult response and response metadata.
|
| ModifyDBParameterGroupResult | Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action. |
| 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 each AZ in the region. |
| ModifyDBSubnetGroupResponse |
Returns information about the ModifyDBSubnetGroup response and response metadata.
|
| ModifyDBSubnetGroupResult |
The results from the ModifyDBSubnetGroup action.
|
| OrderableDBInstanceOption | Contains a list of available options for a DB Instance This data type is used as a response element in the DescribeOrderableDBInstanceOptions action. |
| 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. |
| PendingModifiedValues | This data type is used as a response element in the ModifyDBInstance action. |
| PointInTimeRestoreNotEnabledException |
AmazonRDS exception
|
| PurchaseReservedDBInstancesOfferingRequest |
Container for the parameters to the PurchaseReservedDBInstancesOffering operation.
Purchases a reserved DB Instance offering. |
| PurchaseReservedDBInstancesOfferingResponse |
Returns information about the PurchaseReservedDBInstancesOffering response and response metadata.
|
| PurchaseReservedDBInstancesOfferingResult |
The results from the PurchaseReservedDBInstancesOffering action.
|
| RebootDBInstanceRequest |
Container for the parameters to the RebootDBInstance operation.
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. A DBInstance event is created when the reboot is completed. |
| RebootDBInstanceResponse |
Returns information about the RebootDBInstance response and response metadata.
|
| RebootDBInstanceResult |
The results from the RebootDBInstance action.
|
| RecurringCharge | This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions. |
| ReservedDBInstance | This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions. |
| ReservedDBInstanceAlreadyExistsException |
AmazonRDS exception
|
| ReservedDBInstanceNotFoundException |
AmazonRDS exception
|
| ReservedDBInstanceQuotaExceededException |
AmazonRDS exception
|
| ReservedDBInstancesOffering | This data type is used as a response element in the DescribeReservedDBInstancesOfferings action. |
| ReservedDBInstancesOfferingNotFoundException |
AmazonRDS exception
|
| ResetDBParameterGroupRequest |
Container for the parameters to the ResetDBParameterGroup operation.
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. |
| ResetDBParameterGroupResponse |
Returns information about the ResetDBParameterGroupResult response and response metadata.
|
| ResetDBParameterGroupResult | Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action. |
| 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 same configuration as the original source database, except that the new RDS instance is created with the default security group. |
| RestoreDBInstanceFromDBSnapshotResponse |
Returns information about the RestoreDBInstanceFromDBSnapshot response and response metadata.
|
| RestoreDBInstanceFromDBSnapshotResult |
The results from the RestoreDBInstanceFromDBSnapshot action.
|
| RestoreDBInstanceToPointInTimeRequest |
Container for the parameters to the RestoreDBInstanceToPointInTime operation.
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. |
| RestoreDBInstanceToPointInTimeResponse |
Returns information about the RestoreDBInstanceToPointInTime response and response metadata.
|
| RestoreDBInstanceToPointInTimeResult |
The results from the RestoreDBInstanceToPointInTime action.
|
| 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). |
| RevokeDBSecurityGroupIngressResponse |
Returns information about the RevokeDBSecurityGroupIngress response and response metadata.
|
| RevokeDBSecurityGroupIngressResult |
The results from the RevokeDBSecurityGroupIngress action.
|
| SnapshotQuotaExceededException |
AmazonRDS exception
|
| StorageQuotaExceededException |
AmazonRDS exception
|
| Subnet | This data type is used as a response element in the DescribeDBSubnetGroups action. |
| SubnetAlreadyInUseException |
AmazonRDS exception
|
