C# (CSharp) Amazon.RDS.Model Пространство имен

Пространства имен

Amazon.RDS.Model.Internal

Классы

Имя Описание
AddRoleToDBClusterRequest Container for the parameters to the AddRoleToDBCluster operation. Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
AddSourceIdentifierToSubscriptionRequest Container for the parameters to the AddSourceIdentifierToSubscription operation.

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

AddSourceIdentifierToSubscriptionResponse Contains the results of a successful invocation of the DescribeEventSubscriptions action.
AddSourceIdentifierToSubscriptionResult The results from the AddSourceIdentifierToSubscription action.
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 Condition statement in IAM policy for Amazon RDS.

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

ApplyPendingMaintenanceActionRequest Container for the parameters to the ApplyPendingMaintenanceAction operation. Applies a pending maintenance action to a resource (for example, to a DB instance).
ApplyPendingMaintenanceActionResponse This is the response object from the ApplyPendingMaintenanceAction operation.
AuthorizationAlreadyExistsException
AuthorizationNotFoundException
AuthorizationQuotaExceededException
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).

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

AuthorizeDBSecurityGroupIngressResponse
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:

Certificate A CA certificate for an AWS account.
CertificateNotFoundException
CharacterSet

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

CopyDBClusterParameterGroupRequest Container for the parameters to the CopyDBClusterParameterGroup operation. Copies the specified DB cluster parameter group.
CopyDBClusterParameterGroupResponse This is the response object from the CopyDBClusterParameterGroup operation.
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.
CopyDBClusterSnapshotResponse Contains the result of a successful invocation of the following actions:

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

CopyDBParameterGroupRequest Container for the parameters to the CopyDBParameterGroup operation. Copies the specified DB parameter group.
CopyDBParameterGroupResponse 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.

CopyDBSnapshotRequest
CopyDBSnapshotResponse Contains the result of a successful invocation of the following actions:

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

CopyDBSnapshotResult The results from the CopyDBSnapshot action.
CopyOptionGroupRequest Container for the parameters to the CopyOptionGroup operation. Copies the specified option group.
CopyOptionGroupResponse This is the response object from the CopyOptionGroup operation.
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.

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

CreateDBClusterRequest Container for the parameters to the CreateDBCluster operation. Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster.

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

CreateDBClusterResponse This is the response object from the CreateDBCluster operation.
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.
CreateDBClusterSnapshotResponse Contains the result of a successful invocation of the following actions:

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

CreateDBInstanceReadReplicaRequest Container for the parameters to the CreateDBInstanceReadReplica operation.
CreateDBInstanceReadReplicaResponse Returns information about the CreateDBInstanceReadReplica response and response metadata.
CreateDBInstanceReadReplicaResult Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances 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 Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances 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
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 This is the response object from the CreateDBSecurityGroup operation.
CreateDBSecurityGroupResult Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups 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 at least two AZs in the region.
CreateDBSubnetGroupResponse This is the response object from the CreateDBSubnetGroup operation.
CreateDBSubnetGroupResult The results from the CreateDBSubnetGroup action.
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.

CreateEventSubscriptionResponse Contains the results of a successful invocation of the DescribeEventSubscriptions action.
CreateEventSubscriptionResult The results from the CreateEventSubscription action.
CreateOptionGroupRequest Container for the parameters to the CreateOptionGroup operation. Creates a new option group. You can create up to 20 option groups.
CreateOptionGroupResponse
CreateOptionGroupResult The results from the CreateOptionGroup action.
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.

DBClusterAlreadyExistsException
DBClusterMember Contains information about an instance that is part of a DB cluster.
DBClusterNotFoundException
DBClusterParameterGroup Contains the result of a successful invocation of the CreateDBClusterParameterGroup or CopyDBClusterParameterGroup action.

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

DBClusterParameterGroupNotFoundException
DBClusterQuotaExceededException
DBClusterRole Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
DBClusterRoleAlreadyExistsException
DBClusterRoleNotFoundException
DBClusterRoleQuotaExceededException
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.

DBClusterSnapshotAlreadyExistsException
DBClusterSnapshotAttribute Contains the name and values of a manual DB cluster snapshot attribute.

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

DBClusterSnapshotAttributesResult Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

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

DBClusterSnapshotNotFoundException
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:

  • CreateDBInstance
  • DeleteDBInstance
  • ModifyDBInstance

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

DBInstanceAlreadyExistsException
DBInstanceNotFoundException
DBInstanceStatusInfo

Provides a list of status information for a DB instance.

DBLogFileNotFoundException
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
DBParameterGroupNotFoundException
DBParameterGroupQuotaExceededException
DBParameterGroupStatus

The status of the DP Parameter Group.

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
DBSecurityGroupMembership This data type is used as a response element in the following actions:
DBSecurityGroupNotFoundException
DBSecurityGroupNotSupportedException
DBSecurityGroupQuotaExceededException
DBSnapshot
DBSnapshotAlreadyExistsException
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.

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

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

DBSnapshotNotFoundException
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
DBSubnetGroupDoesNotCoverEnoughAZsException
DBSubnetGroupNotAllowedException
DBSubnetGroupNotFoundException
DBSubnetGroupQuotaExceededException
DBSubnetQuotaExceededException
DBUpgradeDependencyFailureException
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.

DeleteDBClusterRequest Container for the parameters to the DeleteDBCluster operation. The DeleteDBCluster action deletes a previously provisioned DB cluster. 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 specified DB cluster are not deleted.

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

DeleteDBClusterResponse Contains the result of a successful invocation of the following actions:

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

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.

DeleteDBClusterSnapshotResponse Contains the result of a successful invocation of the following actions:

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

DeleteDBInstanceRequest
DeleteDBInstanceResponse Returns information about the DeleteDBInstance response and response metadata.
DeleteDBInstanceResult
DeleteDBParameterGroupRequest
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.

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.

DeleteDBSnapshotResponse
DeleteDBSnapshotResult
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.

DeleteEventSubscriptionRequest Container for the parameters to the DeleteEventSubscription operation.

Deletes an RDS event notification subscription.

DeleteEventSubscriptionResponse Returns information about the DeleteEventSubscription response and response metadata.
DeleteEventSubscriptionResult The results from the DeleteEventSubscription action.
DeleteOptionGroupRequest Container for the parameters to the DeleteOptionGroup operation.

Deletes an existing option group.

DescribeCertificatesRequest Container for the parameters to the DescribeCertificates operation. Lists the set of CA certificates provided by Amazon RDS for this AWS account.
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.

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.

DescribeDBClusterSnapshotAttributesRequest Container for the parameters to the DescribeDBClusterSnapshotAttributes operation. Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster 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 cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

DescribeDBClusterSnapshotAttributesResponse This is the response object from the DescribeDBClusterSnapshotAttributes operation.
DescribeDBClusterSnapshotsRequest Container for the parameters to the DescribeDBClusterSnapshots operation. Returns information about DB cluster snapshots. This API action supports pagination.

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

DescribeDBClusterSnapshotsResponse Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
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.

DescribeDBEngineVersionsRequest Container for the parameters to the DescribeDBEngineVersions operation.

Returns a list of the available DB engines.

DescribeDBEngineVersionsResponse Returns information about the DescribeDBEngineVersions 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
DescribeDBInstancesResult Contains the result of a successful invocation of the DescribeDBInstances action.
DescribeDBLogFilesDetails

This data type is used as a response element to DescribeDBLogFiles.

DescribeDBLogFilesRequest Container for the parameters to the DescribeDBLogFiles operation. Returns a list of DB log files for the DB instance.
DescribeDBLogFilesResponse Returns information about the DescribeDBLogFiles response and response metadata.
DescribeDBLogFilesResult The response from a call to DescribeDBLogFiles.
DescribeDBParameterGroupsRequest
DescribeDBParameterGroupsResponse
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 DB parameter group.
DescribeDBParametersResponse Returns information about the DescribeDBParametersResult response and response metadata.
DescribeDBParametersResult

Contains the result of a successful invocation of the DescribeDBParameters action.

DescribeDBSecurityGroupsRequest
DescribeDBSecurityGroupsResponse Returns information about the DescribeDBSecurityGroups response and response metadata.
DescribeDBSecurityGroupsResult

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

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 IDs for the AWS accounts 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 action.

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

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

DescribeEngineDefaultClusterParametersResponse This is the response object from the DescribeEngineDefaultClusterParameters operation.
DescribeEngineDefaultParametersRequest
DescribeEngineDefaultParametersResponse Returns information about the DescribeEngineDefaultParameters response and response metadata.
DescribeEngineDefaultParametersResult Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
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.
DescribeEventCategoriesResponse Returns information about the DescribeEventCategories response and response metadata.
DescribeEventCategoriesResult Data returned from the DescribeEventCategories action.
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.

DescribeEventSubscriptionsResponse Returns information about the DescribeEventSubscriptionsResult response and response metadata.
DescribeEventSubscriptionsResult

Data returned by the DescribeEventSubscriptions 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
DescribeEventsResult

Contains the result of a successful invocation of the DescribeEvents action.

DescribeOptionGroupOptionsRequest Container for the parameters to the DescribeOptionGroupOptions operation.

Describes all available options.

DescribeOptionGroupOptionsResponse Returns information about the DescribeOptionGroupOptionsResult response and response metadata.
DescribeOptionGroupOptionsResult

DescribeOptionGroupsRequest Container for the parameters to the DescribeOptionGroups operation.

Describes the available option groups.

DescribeOptionGroupsResponse Returns information about the DescribeOptionGroupsResult response and response metadata.
DescribeOptionGroupsResult

List of option groups.

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 DescribeOrderableDBInstanceOptions response and response metadata.
DescribeOrderableDBInstanceOptionsResult

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

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.
DescribeReservedDBInstancesOfferingsRequest Container for the parameters to the DescribeReservedDBInstancesOfferings operation. Lists available reserved DB instance offerings.
DescribeReservedDBInstancesOfferingsResponse Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
DescribeReservedDBInstancesOfferingsResult Describe Reserved D B Instances Offerings Result
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 Contains the result of a successful invocation of the DescribeReservedDBInstances action.
DescribeReservedDBInstancesResult

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

DescribeSourceRegionsRequest Container for the parameters to the DescribeSourceRegions operation. Returns a list of the source AWS regions where the current AWS region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
DescribeSourceRegionsResponse Contains the result of a successful invocation of the DescribeSourceRegions action.
DomainMembership An Active Directory Domain membership record associated with the DB instance.
DomainNotFoundException
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.
DownloadDBLogFilePortionResponse Returns information about the DownloadDBLogFilePortionResult response and response metadata.
DownloadDBLogFilePortionResult

This data type is used as a response element to DownloadDBLogFilePortion.

EC2SecurityGroup This data type is used as a response element in the following actions:
Endpoint
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.

EventCategoriesMap Contains the results of a successful invocation of the DescribeEventCategories action.
EventSubscription

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

EventSubscriptionQuotaExceededException
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 Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary 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.

FailoverDBClusterResponse This is the response object from the FailoverDBCluster operation.
Filter This type is not currently supported.
IPRange

InstanceQuotaExceededException
InsufficientDBClusterCapacityException
InsufficientDBInstanceCapacityException
InsufficientStorageClusterCapacityException
InvalidDBClusterSnapshotStateException
InvalidDBClusterStateException
InvalidDBInstanceStateException
InvalidDBParameterGroupStateException
InvalidDBSecurityGroupStateException
InvalidDBSnapshotStateException
InvalidDBSubnetGroupException
InvalidDBSubnetGroupStateException
InvalidDBSubnetStateException AmazonRDS exception
InvalidEventSubscriptionStateException
InvalidOptionGroupStateException
InvalidRestoreException
InvalidS3BucketException
InvalidSubnetException
InvalidVPCNetworkStateException
KMSKeyNotAccessibleException
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.

ListTagsForResourceResponse
ListTagsForResourceResult
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.

ModifyDBClusterParameterGroupResponse
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.
ModifyDBClusterResponse Contains the result of a successful invocation of the following actions:

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

ModifyDBClusterSnapshotAttributeRequest Container for the parameters to the ModifyDBClusterSnapshotAttribute operation. Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.

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

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

ModifyDBInstanceRequest Container for the parameters to the ModifyDBInstance operation.

This API is used to change RDS Instance settings. Users call the ModifyDBInstance API to change one or more database configuration parameters by specifying these parameters and the new values in the request.

ModifyDBInstanceResponse
ModifyDBInstanceResult
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.

ModifyDBParameterGroupResponse Returns information about the ModifyDBParameterGroupResult response and response metadata.
ModifyDBParameterGroupResult Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
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 IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want 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 action.

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

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

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.
ModifyDBSubnetGroupResponse Returns information about the ModifyDBSubnetGroup response and response metadata.
ModifyDBSubnetGroupResult The results from the ModifyDBSubnetGroup action.
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.

ModifyEventSubscriptionResponse Returns information about the ModifyEventSubscription response and response metadata.
ModifyEventSubscriptionResult Contains the results of a successful invocation of the DescribeEventSubscriptions action.
ModifyOptionGroupRequest Container for the parameters to the ModifyOptionGroup operation.

Modifies an existing option group.

ModifyOptionGroupResponse Returns information about the ModifyOptionGroup response and response metadata.
ModifyOptionGroupResult
Option Option details.
OptionConfiguration

A list of all available options

OptionGroup

OptionGroupAlreadyExistsException
OptionGroupMembership

Provides information on the option groups the DB instance is a member of.

OptionGroupNotFoundException
OptionGroupOption

Available option.

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.

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

OptionVersion The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions 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
PromoteReadReplicaDBClusterRequest Container for the parameters to the PromoteReadReplicaDBCluster operation. Promotes a Read Replica DB cluster to a standalone DB cluster.
PromoteReadReplicaDBClusterResponse This is the response object from the PromoteReadReplicaDBCluster operation.
PromoteReadReplicaRequest Container for the parameters to the PromoteReadReplica operation.

Promotes a read replica DB instance to a standalone DB instance.

PromoteReadReplicaResponse Returns information about the PromoteReadReplica response and response metadata.
PromoteReadReplicaResult The results from the PromoteReadReplica action.
ProvisionedIopsNotAvailableInAZException
PurchaseReservedDBInstancesOfferingRequest Container for the parameters to the PurchaseReservedDBInstancesOffering operation.
PurchaseReservedDBInstancesOfferingResponse Returns information about the PurchaseReservedDBInstancesOffering response and response metadata.
PurchaseReservedDBInstancesOfferingResult The results from the PurchaseReservedDBInstancesOffering action.
RebootDBInstanceRequest
RebootDBInstanceResponse Returns information about the RebootDBInstance response and response metadata.
RebootDBInstanceResult
RecurringCharge

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

RemoveRoleFromDBClusterRequest Container for the parameters to the RemoveRoleFromDBCluster operation. Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.
RemoveSourceIdentifierFromSubscriptionRequest Container for the parameters to the RemoveSourceIdentifierFromSubscription operation. Removes a source identifier from an existing RDS event notification subscription.
RemoveSourceIdentifierFromSubscriptionResponse Returns information about the RemoveSourceIdentifierFromSubscription response and response metadata.
RemoveSourceIdentifierFromSubscriptionResult Contains the results of a successful invocation of the DescribeEventSubscriptions action.
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.

ReservedDBInstance

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

ReservedDBInstanceAlreadyExistsException
ReservedDBInstanceNotFoundException
ReservedDBInstanceQuotaExceededException
ReservedDBInstancesOffering

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

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

ResetDBClusterParameterGroupResponse
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.
ResetDBParameterGroupResponse
ResetDBParameterGroupResult

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

ResourceNotFoundException
RestoreDBClusterFromS3Request Container for the parameters to the RestoreDBClusterFromS3 operation. Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket.
RestoreDBClusterFromS3Response This is the response object from the RestoreDBClusterFromS3 operation.
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.

RestoreDBClusterFromSnapshotResponse This is the response object from the RestoreDBClusterFromSnapshot operation.
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.

RestoreDBClusterToPointInTimeResponse Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBClusters 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
RestoreDBInstanceFromDBSnapshotResult Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances 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
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
RevokeDBSecurityGroupIngressResult
SNSInvalidTopicException
SNSNoAuthorizationException
SNSTopicArnNotFoundException
SharedSnapshotQuotaExceededException
SnapshotQuotaExceededException
SourceNotFoundException
SourceRegion Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.
StorageQuotaExceededException
StorageTypeNotSupportedException
Subnet This data type is used as a response element in the DescribeDBSubnetGroups action.
SubnetAlreadyInUseException AmazonRDS exception
SubscriptionAlreadyExistException
SubscriptionCategoryNotFoundException
SubscriptionNotFoundException
Tag Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Timezone A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.
UpgradeTarget The version of the database engine that a DB instance can be upgraded to.
VpcSecurityGroupMembership This data type is used as a response element for queries on VPC security group membership.