Package-level declarations
Types
Describes a quota for an Amazon Web Services account.
The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.
The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.
The DB security group authorization quota has been reached.
Contains Availability Zone information.
Contains the available processor feature information for the DB instance class of a DB instance.
This data type is used as a response element in the DescribeDBClusterBacktracks
action.
Details about a blue/green deployment.
A blue/green deployment with the specified name already exists.
BlueGreenDeploymentIdentifier
doesn't refer to an existing blue/green deployment.
Details about a task for a blue/green deployment.
Contains the details of a snapshot or cluster export to Amazon S3.
A CA certificate for an Amazon Web Services account.
The details of the DB instance’s server certificate.
CertificateIdentifier
doesn't refer to an existing certificate.
This data type is used as a response element in the action DescribeDBEngineVersions
.
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
This data type is used as a response element in the ModifyDBCluster
operation and contains changes that will be applied during the next maintenance window.
Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup
.
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget
.
The additional attributes of RecommendedAction
data type.
An error occurred while trying to create the CEV.
This data type is used as a response element in the action DescribeDBEngineVersions
.
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
Contains the details for an Amazon RDS DB shard group.
A zero-ETL integration with Amazon Redshift.
CustomAvailabilityZoneId
doesn't refer to an existing custom Availability Zone identifier.
A CEV with the specified name already exists.
A value that indicates the AMI information.
The specified CEV was not found.
You have exceeded your CEV quota.
The user already has a DB cluster with the given identifier.
An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
No automated backup for this DB cluster was found.
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.
This data type is used as a response element in the DescribeDBClusterBacktracks
action.
BacktrackIdentifier
doesn't refer to an existing backtrack.
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
The specified custom endpoint can't be created because it already exists.
The specified custom endpoint doesn't exist.
The cluster already has the maximum number of custom endpoints.
Contains information about an instance that is part of a DB cluster.
DBClusterIdentifier
doesn't refer to an existing DB cluster.
Contains status information for a DB cluster option group.
Contains the details of an Amazon RDS DB cluster parameter group.
DBClusterParameterGroupName
doesn't refer to an existing DB cluster parameter group.
The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.
You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
Contains the details for an Amazon RDS DB cluster snapshot
The user already has a DB cluster snapshot with the given identifier.
Contains the name and values of a manual DB cluster snapshot attribute.
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes
API action.
DBClusterSnapshotIdentifier
doesn't refer to an existing DB cluster snapshot.
Reserved for future use.
This data type is used as a response element in the action DescribeDBEngineVersions
.
Contains the details of an Amazon RDS DB instance.
The user already has a DB instance with the given identifier.
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
No automated backup for this DB instance was found.
The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceIdentifier
doesn't refer to an existing DB instance.
An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.
Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
The specified RoleArn
or FeatureName
value is already associated with the DB instance.
The specified RoleArn
value doesn't match the specified feature for the DB instance.
You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.
Provides a list of status information for a DB instance.
LogFileName
doesn't refer to an existing DB log file.
This data type is used as a response element in the operation DescribeDBMajorEngineVersions
.
Contains the details of an Amazon RDS DB parameter group.
A DB parameter group with the same name exists.
DBParameterGroupName
doesn't refer to an existing DB parameter group.
The request would result in the user exceeding the allowed number of DB parameter groups.
The status of the DB parameter group.
The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.
The DB proxy endpoint doesn't exist.
The DB proxy already has the maximum number of endpoints.
The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
Your Amazon Web Services account already has the maximum number of proxies in the specified Amazon Web Services Region.
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
The proxy is already associated with the specified RDS DB instance or Aurora DB cluster.
Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.
The recommendation for your DB instances, DB clusters, and DB parameter groups.
Contains the details for an Amazon RDS DB security group.
A DB security group with the name specified in DBSecurityGroupName
already exists.
This data type is used as a response element in the following actions:
DBSecurityGroupName
doesn't refer to an existing DB security group.
A DB security group isn't allowed for this action.
The request would result in the user exceeding the allowed number of DB security groups.
Contains the details for an Amazon RDS DB shard group.
The specified DB shard group name must be unique in your Amazon Web Services account in the specified Amazon Web Services Region.
The specified DB shard group name wasn't found.
Contains the details of an Amazon RDS DB snapshot.
DBSnapshotIdentifier
is already used by an existing snapshot.
Contains the name and values of a manual DB snapshot attribute
Contains the results of a successful call to the DescribeDBSnapshotAttributes
API action.
DBSnapshotIdentifier
doesn't refer to an existing DB snapshot.
Contains the details of a tenant database in a snapshot of a DB instance.
The specified snapshot tenant database wasn't found.
Contains the details of an Amazon RDS DB subnet group.
DBSubnetGroupName
is already used by an existing DB subnet group.
Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.
DBSubnetGroupName
doesn't refer to an existing DB subnet group.
The request would result in the user exceeding the allowed number of DB subnet groups.
The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.
The DB upgrade failed because a resource the DB depends on can't be modified.
This data type is used as a response element in the action DescribeDBEngineVersions
.
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
Parameter input for the DeleteDBInstanceAutomatedBackup
operation.
Contains the details for an Amazon RDS DB shard group.
A zero-ETL integration with Amazon Redshift.
Data returned by the DescribeAccountAttributes action.
Data returned by the DescribeCertificates action.
Contains the result of a successful invocation of the DescribeDBClusterBacktracks
action.
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots
action.
Contains the result of a successful invocation of the DescribeDBClusters
action.
Contains the result of a successful invocation of the DescribeDBEngineVersions
action.
Parameter input for DescribeDBInstanceAutomatedBackups.
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups
action.
Contains the result of a successful invocation of the DescribeDBInstances
action.
This data type is used as a response element to DescribeDBLogFiles
.
The response from a call to DescribeDBLogFiles
.
Contains the result of a successful invocation of the DescribeDBParameterGroups
action.
Contains the result of a successful invocation of the DescribeDBParameters
action.
Contains the result of a successful invocation of the DescribeDBSecurityGroups
action.
Contains the result of a successful invocation of the DescribeDBSnapshots
action.
Contains the result of a successful invocation of the DescribeDBSubnetGroups
action.
Data returned from the DescribeEventCategories
operation.
Contains the result of a successful invocation of the DescribeEvents
action.
Data returned by the DescribeEventSubscriptions action.
List of option groups.
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions
action.
Data returned from the DescribePendingMaintenanceActions action.
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings
action.
Contains the result of a successful invocation of the DescribeReservedDBInstances
action.
Contains the result of a successful invocation of the DescribeSourceRegions
action.
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain
doesn't refer to an existing Active Directory domain.
A range of double values.
This data type is used as a response element to DownloadDBLogFilePortion
.
The AMI configuration prerequisite has not been met.
This data type is used as a response element in the following actions:
Contains the result of a successful invocation of the DescribeEngineDefaultParameters
action.
This data type is used as a response element in the DescribeEvents action.
Contains the results of a successful invocation of the DescribeEventCategories operation.
Contains the results of a successful invocation of the DescribeEventSubscriptions
action.
You have reached the maximum number of event subscriptions.
Contains the details of a snapshot or cluster export to Amazon S3.
You can't start an export task that's already running.
The export task doesn't exist.
Contains the state of scheduled or in-process operations on a global cluster (Aurora global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Aurora global database.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
A data type representing an Aurora global database.
The GlobalClusterIdentifier
already exists. Specify a new global database identifier (unique name) to create a new global database cluster or to rename an existing one.
A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).
The GlobalClusterIdentifier
doesn't refer to an existing global database cluster.
The number of global database clusters for this account is already at the maximum allowed.
The IAM role requires additional permissions to export to an Amazon S3 bucket.
The IAM role is missing for exporting to an Amazon S3 bucket.
The request would result in the user exceeding the allowed number of DB instances.
The requested operation can't be performed because there aren't enough available IP addresses in the proxy's subnets. Add more CIDR blocks to the VPC or remove IP address that aren't required from the subnets.
The DB cluster doesn't have enough capacity for the current operation.
The specified DB instance class isn't available in the specified Availability Zone.
There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
A zero-ETL integration with Amazon Redshift.
The integration you are trying to create already exists.
A conflicting conditional operation is currently in progress against this resource. Typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
An error associated with a zero-ETL integration with Amazon Redshift.
The specified integration could not be found.
You can't crate any more zero-ETL integrations because the quota has been reached.
The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.
You can't delete the CEV.
The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.
Capacity
isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2
, 4
, 8
, 16
, 32
, 64
, 128
, and 256
.
The requested operation can't be performed on the endpoint while the endpoint is in this state.
The supplied value isn't a valid DB cluster snapshot state.
The requested operation can't be performed while the cluster is in this state.
The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.
The DB instance isn't in a valid state.
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
You can't perform this operation while the DB proxy endpoint is in a particular state.
The requested operation can't be performed while the proxy is in this state.
The state of the DB security group doesn't allow deletion.
The DB shard group must be in the available state.
The state of the DB snapshot doesn't allow deletion.
The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
The DB subnet group cannot be deleted because it's in use.
The DB subnet isn't in the available state.
This error can occur if someone else is modifying a subscription. You should retry the action.
The export is invalid for exporting to an Amazon S3 bucket.
The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.
You can't cancel an export task that has completed.
The global cluster is in an invalid state and can't perform the requested operation.
The integration is in an invalid state and can't perform the requested operation.
The option group isn't in the available state.
The operation can't be performed because another operation is in progress.
Cannot restore from VPC backup to non-VPC DB instance.
The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
The details of an issue with your DB instances, DB clusters, and DB parameter groups.
An error occurred accessing an Amazon Web Services KMS key.
Contains details for Aurora Limitless Database.
Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
The maximum number of DB shard groups for your Amazon Web Services account in the specified Amazon Web Services Region has been reached.
The query to retrieve metric data points.
The reference (threshold) for a metric.
The minimum DB engine version required for each corresponding allowed value for an option setting.
This data type is used as a response element in the action DescribeDBEngineVersions
.
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
Contains the result of a successful invocation of the ModifyDBParameterGroup
or ResetDBParameterGroup
operation.
Contains the details for an Amazon RDS DB shard group.
A zero-ETL integration with Amazon Redshift.
The network type is invalid for the DB instance. Valid nework type values are IPV4
and DUAL
.
A list of all available options for an option group.
The option group you are trying to create already exists.
Provides information on the option groups the DB instance is a member of.
The specified option group could not be found.
Available option.
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.
The quota of 20 option groups was exceeded for this Amazon Web Services account.
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.
The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions
action.
Contains a list of available options for a DB instance.
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
Provides information about a pending maintenance action for a resource.
This data type is used as a response element in the ModifyDBInstance
operation and contains changes that will be applied during the next maintenance window.
A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql
dimension group consists of the following dimensions:
A single Performance Insights metric query to process. You must provide the metric to the query. If other parameters aren't specified, Performance Insights returns all data points for the specified metric. Optionally, you can request the data points to be aggregated by dimension group (GroupBy
) and return only those data points that match your criteria (Filter
).
Details of the performance issue.
SourceDBInstanceIdentifier
refers to a DB instance with BackupRetentionPeriod
equal to 0.
Contains the processor features of a DB instance class.
Provisioned IOPS not available in the specified Availability Zone.
Reserved for future use.
Base class for all service related exceptions thrown by the Rds client
Contains the details for an Amazon RDS DB shard group.
The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.
A single parameter to use with the RecommendedAction
API operation to apply the action.
The recommended status to update for the specified recommendation action ID.
This data type is used as a response element in the DescribeReservedDBInstances
and DescribeReservedDBInstancesOfferings
actions.
The reference details of a metric.
This data type is used as a response element in the DescribeReservedDBInstances
and PurchaseReservedDBInstancesOffering
actions.
User already has a reservation with the given identifier.
The specified reserved DB Instance not found.
Request would exceed the user's DB Instance quota.
This data type is used as a response element in the DescribeReservedDBInstancesOfferings
action.
Specified offering does not exist.
Contains the result of a successful invocation of the ModifyDBParameterGroup
or ResetDBParameterGroup
operation.
The specified resource ID was not found.
Describes the pending maintenance actions for a resource.
Earliest and latest time an instance can be restored to:
The metric reference details when the reference is a scalar.
Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
The scaling configuration for an Aurora DB cluster in serverless
DB engine mode.
Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
The scaling configuration for an Aurora Serverless v2 DB cluster.
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
The request would result in the user exceeding the allowed number of DB snapshots.
SNS has responded that there is a problem with the SNS topic specified.
You do not have permission to publish to the SNS topic ARN.
The SNS topic ARN does not exist.
The source DB cluster isn't supported for a blue/green deployment.
The source DB instance isn't supported for a blue/green deployment.
The requested source could not be found.
Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions
action.
Contains the details of a snapshot or cluster export to Amazon S3.
The request would result in the user exceeding the allowed amount of storage available across all DB instances.
The aurora-iopt1
storage type isn't available, because you modified the DB cluster to use this storage type less than one month ago.
The specified StorageType
can't be associated with the DB instance.
The DB subnet is already in use in the Availability Zone.
The supplied subscription name already exists.
The supplied category does not exist.
The subscription name does not exist.
This data type is used as a response element in the operation DescribeDBMajorEngineVersions
.
Contains the details about a blue/green deployment.
Information about the connection health of an RDS Proxy target.
A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases
action.
You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.
The specified tenant database wasn't found in the DB instance.
A response element in the ModifyTenantDatabase
operation that describes changes that will be applied. Specific changes are identified by subelements.
You attempted to create more tenant databases than are permitted in your Amazon Web Services account.
The specified DB engine version isn't supported for Aurora Limitless Database.
The version of the database engine that a DB instance can be upgraded to.
Specifies the details of authentication used by a proxy to log in as a specific database user.
Returns the details of authentication used by a proxy to log in as a specific database user.
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications
action. You can use this information when you call ModifyDBInstance
.
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications
action.
This data type is used as a response element for queries on VPC security group membership.