@aws-sdk/client-rds 3.321.1 → 3.326.0

package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts

@@ -37,6 +37,38 @@ export interface DeleteBlueGreenDeploymentCommandOutput extends DeleteBlueGreenD
  * };
  * const command = new DeleteBlueGreenDeploymentCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteBlueGreenDeploymentResponse
+ * //   BlueGreenDeployment: { // BlueGreenDeployment
+ * //     BlueGreenDeploymentIdentifier: "STRING_VALUE",
+ * //     BlueGreenDeploymentName: "STRING_VALUE",
+ * //     Source: "STRING_VALUE",
+ * //     Target: "STRING_VALUE",
+ * //     SwitchoverDetails: [ // SwitchoverDetailList
+ * //       { // SwitchoverDetail
+ * //         SourceMember: "STRING_VALUE",
+ * //         TargetMember: "STRING_VALUE",
+ * //         Status: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     Tasks: [ // BlueGreenDeploymentTaskList
+ * //       { // BlueGreenDeploymentTask
+ * //         Name: "STRING_VALUE",
+ * //         Status: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     Status: "STRING_VALUE",
+ * //     StatusDetails: "STRING_VALUE",
+ * //     CreateTime: new Date("TIMESTAMP"),
+ * //     DeleteTime: new Date("TIMESTAMP"),
+ * //     TagList: [ // TagList
+ * //       { // Tag
+ * //         Key: "STRING_VALUE",
+ * //         Value: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DeleteBlueGreenDeploymentCommandInput - {@link DeleteBlueGreenDeploymentCommandInput}
@@ -53,6 +85,8 @@ export interface DeleteBlueGreenDeploymentCommandOutput extends DeleteBlueGreenD
  *  <p>The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
  *             the green environment.</p>
  *
+ * @throws {@link RDSServiceException}
+ * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  * @example To delete resources in green environment for an RDS for MySQL DB instance
  * ```javascript

package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts

@@ -52,6 +52,87 @@ export interface DeleteCustomDBEngineVersionCommandOutput extends DBEngineVersio
  * };
  * const command = new DeleteCustomDBEngineVersionCommand(input);
  * const response = await client.send(command);
+ * // { // DBEngineVersion
+ * //   Engine: "STRING_VALUE",
+ * //   EngineVersion: "STRING_VALUE",
+ * //   DBParameterGroupFamily: "STRING_VALUE",
+ * //   DBEngineDescription: "STRING_VALUE",
+ * //   DBEngineVersionDescription: "STRING_VALUE",
+ * //   DefaultCharacterSet: { // CharacterSet
+ * //     CharacterSetName: "STRING_VALUE",
+ * //     CharacterSetDescription: "STRING_VALUE",
+ * //   },
+ * //   Image: { // CustomDBEngineVersionAMI
+ * //     ImageId: "STRING_VALUE",
+ * //     Status: "STRING_VALUE",
+ * //   },
+ * //   DBEngineMediaType: "STRING_VALUE",
+ * //   SupportedCharacterSets: [ // SupportedCharacterSetsList
+ * //     {
+ * //       CharacterSetName: "STRING_VALUE",
+ * //       CharacterSetDescription: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   SupportedNcharCharacterSets: [
+ * //     {
+ * //       CharacterSetName: "STRING_VALUE",
+ * //       CharacterSetDescription: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   ValidUpgradeTarget: [ // ValidUpgradeTargetList
+ * //     { // UpgradeTarget
+ * //       Engine: "STRING_VALUE",
+ * //       EngineVersion: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       AutoUpgrade: true || false,
+ * //       IsMajorVersionUpgrade: true || false,
+ * //       SupportedEngineModes: [ // EngineModeList
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       SupportsParallelQuery: true || false,
+ * //       SupportsGlobalDatabases: true || false,
+ * //       SupportsBabelfish: true || false,
+ * //     },
+ * //   ],
+ * //   SupportedTimezones: [ // SupportedTimezonesList
+ * //     { // Timezone
+ * //       TimezoneName: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   ExportableLogTypes: [ // LogTypeList
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   SupportsLogExportsToCloudwatchLogs: true || false,
+ * //   SupportsReadReplica: true || false,
+ * //   SupportedEngineModes: [
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   SupportedFeatureNames: [ // FeatureNameList
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   Status: "STRING_VALUE",
+ * //   SupportsParallelQuery: true || false,
+ * //   SupportsGlobalDatabases: true || false,
+ * //   MajorEngineVersion: "STRING_VALUE",
+ * //   DatabaseInstallationFilesS3BucketName: "STRING_VALUE",
+ * //   DatabaseInstallationFilesS3Prefix: "STRING_VALUE",
+ * //   DBEngineVersionArn: "STRING_VALUE",
+ * //   KMSKeyId: "STRING_VALUE",
+ * //   CreateTime: new Date("TIMESTAMP"),
+ * //   TagList: [ // TagList
+ * //     { // Tag
+ * //       Key: "STRING_VALUE",
+ * //       Value: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   SupportsBabelfish: true || false,
+ * //   CustomDBEngineVersionManifest: "STRING_VALUE",
+ * //   SupportsCertificateRotationWithoutRestart: true || false,
+ * //   SupportedCACertificateIdentifiers: [ // CACertificateIdentifiersList
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param DeleteCustomDBEngineVersionCommandInput - {@link DeleteCustomDBEngineVersionCommandInput}
@@ -66,6 +147,8 @@ export interface DeleteCustomDBEngineVersionCommandOutput extends DBEngineVersio
  * @throws {@link InvalidCustomDBEngineVersionStateFault} (client fault)
  *  <p>You can't delete the CEV.</p>
  *
+ * @throws {@link RDSServiceException}
+ * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  */
 export declare class DeleteCustomDBEngineVersionCommand extends $Command<DeleteCustomDBEngineVersionCommandInput, DeleteCustomDBEngineVersionCommandOutput, RDSClientResolvedConfig> {

package/dist-types/commands/DeleteDBClusterCommand.d.ts

@@ -43,6 +43,155 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
  * };
  * const command = new DeleteDBClusterCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteDBClusterResult
+ * //   DBCluster: { // DBCluster
+ * //     AllocatedStorage: Number("int"),
+ * //     AvailabilityZones: [ // AvailabilityZones
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     BackupRetentionPeriod: Number("int"),
+ * //     CharacterSetName: "STRING_VALUE",
+ * //     DatabaseName: "STRING_VALUE",
+ * //     DBClusterIdentifier: "STRING_VALUE",
+ * //     DBClusterParameterGroup: "STRING_VALUE",
+ * //     DBSubnetGroup: "STRING_VALUE",
+ * //     Status: "STRING_VALUE",
+ * //     AutomaticRestartTime: new Date("TIMESTAMP"),
+ * //     PercentProgress: "STRING_VALUE",
+ * //     EarliestRestorableTime: new Date("TIMESTAMP"),
+ * //     Endpoint: "STRING_VALUE",
+ * //     ReaderEndpoint: "STRING_VALUE",
+ * //     CustomEndpoints: [ // StringList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     MultiAZ: true || false,
+ * //     Engine: "STRING_VALUE",
+ * //     EngineVersion: "STRING_VALUE",
+ * //     LatestRestorableTime: new Date("TIMESTAMP"),
+ * //     Port: Number("int"),
+ * //     MasterUsername: "STRING_VALUE",
+ * //     DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships
+ * //       { // DBClusterOptionGroupStatus
+ * //         DBClusterOptionGroupName: "STRING_VALUE",
+ * //         Status: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     PreferredBackupWindow: "STRING_VALUE",
+ * //     PreferredMaintenanceWindow: "STRING_VALUE",
+ * //     ReplicationSourceIdentifier: "STRING_VALUE",
+ * //     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     DBClusterMembers: [ // DBClusterMemberList
+ * //       { // DBClusterMember
+ * //         DBInstanceIdentifier: "STRING_VALUE",
+ * //         IsClusterWriter: true || false,
+ * //         DBClusterParameterGroupStatus: "STRING_VALUE",
+ * //         PromotionTier: Number("int"),
+ * //       },
+ * //     ],
+ * //     VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
+ * //       { // VpcSecurityGroupMembership
+ * //         VpcSecurityGroupId: "STRING_VALUE",
+ * //         Status: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     HostedZoneId: "STRING_VALUE",
+ * //     StorageEncrypted: true || false,
+ * //     KmsKeyId: "STRING_VALUE",
+ * //     DbClusterResourceId: "STRING_VALUE",
+ * //     DBClusterArn: "STRING_VALUE",
+ * //     AssociatedRoles: [ // DBClusterRoles
+ * //       { // DBClusterRole
+ * //         RoleArn: "STRING_VALUE",
+ * //         Status: "STRING_VALUE",
+ * //         FeatureName: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     IAMDatabaseAuthenticationEnabled: true || false,
+ * //     CloneGroupId: "STRING_VALUE",
+ * //     ClusterCreateTime: new Date("TIMESTAMP"),
+ * //     EarliestBacktrackTime: new Date("TIMESTAMP"),
+ * //     BacktrackWindow: Number("long"),
+ * //     BacktrackConsumedChangeRecords: Number("long"),
+ * //     EnabledCloudwatchLogsExports: [ // LogTypeList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     Capacity: Number("int"),
+ * //     EngineMode: "STRING_VALUE",
+ * //     ScalingConfigurationInfo: { // ScalingConfigurationInfo
+ * //       MinCapacity: Number("int"),
+ * //       MaxCapacity: Number("int"),
+ * //       AutoPause: true || false,
+ * //       SecondsUntilAutoPause: Number("int"),
+ * //       TimeoutAction: "STRING_VALUE",
+ * //       SecondsBeforeTimeout: Number("int"),
+ * //     },
+ * //     DeletionProtection: true || false,
+ * //     HttpEndpointEnabled: true || false,
+ * //     ActivityStreamMode: "sync" || "async",
+ * //     ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
+ * //     ActivityStreamKmsKeyId: "STRING_VALUE",
+ * //     ActivityStreamKinesisStreamName: "STRING_VALUE",
+ * //     CopyTagsToSnapshot: true || false,
+ * //     CrossAccountClone: true || false,
+ * //     DomainMemberships: [ // DomainMembershipList
+ * //       { // DomainMembership
+ * //         Domain: "STRING_VALUE",
+ * //         Status: "STRING_VALUE",
+ * //         FQDN: "STRING_VALUE",
+ * //         IAMRoleName: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     TagList: [ // TagList
+ * //       { // Tag
+ * //         Key: "STRING_VALUE",
+ * //         Value: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
+ * //     GlobalWriteForwardingRequested: true || false,
+ * //     PendingModifiedValues: { // ClusterPendingModifiedValues
+ * //       PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
+ * //         LogTypesToEnable: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         LogTypesToDisable: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       DBClusterIdentifier: "STRING_VALUE",
+ * //       MasterUserPassword: "STRING_VALUE",
+ * //       IAMDatabaseAuthenticationEnabled: true || false,
+ * //       EngineVersion: "STRING_VALUE",
+ * //       BackupRetentionPeriod: Number("int"),
+ * //       AllocatedStorage: Number("int"),
+ * //       Iops: Number("int"),
+ * //     },
+ * //     DBClusterInstanceClass: "STRING_VALUE",
+ * //     StorageType: "STRING_VALUE",
+ * //     Iops: Number("int"),
+ * //     PubliclyAccessible: true || false,
+ * //     AutoMinorVersionUpgrade: true || false,
+ * //     MonitoringInterval: Number("int"),
+ * //     MonitoringRoleArn: "STRING_VALUE",
+ * //     PerformanceInsightsEnabled: true || false,
+ * //     PerformanceInsightsKMSKeyId: "STRING_VALUE",
+ * //     PerformanceInsightsRetentionPeriod: Number("int"),
+ * //     ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
+ * //       MinCapacity: Number("double"),
+ * //       MaxCapacity: Number("double"),
+ * //     },
+ * //     NetworkType: "STRING_VALUE",
+ * //     DBSystemId: "STRING_VALUE",
+ * //     MasterUserSecret: { // MasterUserSecret
+ * //       SecretArn: "STRING_VALUE",
+ * //       SecretStatus: "STRING_VALUE",
+ * //       KmsKeyId: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DeleteDBClusterCommandInput - {@link DeleteDBClusterCommandInput}
@@ -68,6 +217,8 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
  *  <p>The request would result in the user exceeding the allowed number of DB
  *             snapshots.</p>
  *
+ * @throws {@link RDSServiceException}
+ * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  * @example To delete a DB cluster
  * ```javascript

package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts

@@ -34,6 +34,23 @@ export interface DeleteDBClusterEndpointCommandOutput extends DBClusterEndpoint,
  * };
  * const command = new DeleteDBClusterEndpointCommand(input);
  * const response = await client.send(command);
+ * // { // DBClusterEndpoint
+ * //   DBClusterEndpointIdentifier: "STRING_VALUE",
+ * //   DBClusterIdentifier: "STRING_VALUE",
+ * //   DBClusterEndpointResourceIdentifier: "STRING_VALUE",
+ * //   Endpoint: "STRING_VALUE",
+ * //   Status: "STRING_VALUE",
+ * //   EndpointType: "STRING_VALUE",
+ * //   CustomEndpointType: "STRING_VALUE",
+ * //   StaticMembers: [ // StringList
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   ExcludedMembers: [
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   DBClusterEndpointArn: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DeleteDBClusterEndpointCommandInput - {@link DeleteDBClusterEndpointCommandInput}
@@ -51,6 +68,8 @@ export interface DeleteDBClusterEndpointCommandOutput extends DBClusterEndpoint,
  * @throws {@link InvalidDBClusterStateFault} (client fault)
  *  <p>The requested operation can't be performed while the cluster is in this state.</p>
  *
+ * @throws {@link RDSServiceException}
+ * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  * @example To delete a custom DB cluster endpoint
  * ```javascript

package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts

@@ -37,6 +37,8 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
  * };
  * const command = new DeleteDBClusterParameterGroupCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DeleteDBClusterParameterGroupCommandInput - {@link DeleteDBClusterParameterGroupCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
  *             to delete the parameter group, you can't delete it when the parameter group is in
  *             this state.</p>
  *
+ * @throws {@link RDSServiceException}
+ * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  * @example To delete a DB cluster parameter group
  * ```javascript

package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts

@@ -41,6 +41,41 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
  * };
  * const command = new DeleteDBClusterSnapshotCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteDBClusterSnapshotResult
+ * //   DBClusterSnapshot: { // DBClusterSnapshot
+ * //     AvailabilityZones: [ // AvailabilityZones
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     DBClusterSnapshotIdentifier: "STRING_VALUE",
+ * //     DBClusterIdentifier: "STRING_VALUE",
+ * //     SnapshotCreateTime: new Date("TIMESTAMP"),
+ * //     Engine: "STRING_VALUE",
+ * //     EngineMode: "STRING_VALUE",
+ * //     AllocatedStorage: Number("int"),
+ * //     Status: "STRING_VALUE",
+ * //     Port: Number("int"),
+ * //     VpcId: "STRING_VALUE",
+ * //     ClusterCreateTime: new Date("TIMESTAMP"),
+ * //     MasterUsername: "STRING_VALUE",
+ * //     EngineVersion: "STRING_VALUE",
+ * //     LicenseModel: "STRING_VALUE",
+ * //     SnapshotType: "STRING_VALUE",
+ * //     PercentProgress: Number("int"),
+ * //     StorageEncrypted: true || false,
+ * //     KmsKeyId: "STRING_VALUE",
+ * //     DBClusterSnapshotArn: "STRING_VALUE",
+ * //     SourceDBClusterSnapshotArn: "STRING_VALUE",
+ * //     IAMDatabaseAuthenticationEnabled: true || false,
+ * //     TagList: [ // TagList
+ * //       { // Tag
+ * //         Key: "STRING_VALUE",
+ * //         Value: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     DBSystemId: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DeleteDBClusterSnapshotCommandInput - {@link DeleteDBClusterSnapshotCommandInput}
@@ -56,6 +91,8 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
  * @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
  *  <p>The supplied value isn't a valid DB cluster snapshot state.</p>
  *
+ * @throws {@link RDSServiceException}
+ * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  * @example To delete a DB cluster snapshot
  * ```javascript

package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts

@@ -32,6 +32,46 @@ export interface DeleteDBInstanceAutomatedBackupCommandOutput extends DeleteDBIn
  * };
  * const command = new DeleteDBInstanceAutomatedBackupCommand(input);
  * const response = await client.send(command);
+ * // { // DeleteDBInstanceAutomatedBackupResult
+ * //   DBInstanceAutomatedBackup: { // DBInstanceAutomatedBackup
+ * //     DBInstanceArn: "STRING_VALUE",
+ * //     DbiResourceId: "STRING_VALUE",
+ * //     Region: "STRING_VALUE",
+ * //     DBInstanceIdentifier: "STRING_VALUE",
+ * //     RestoreWindow: { // RestoreWindow
+ * //       EarliestTime: new Date("TIMESTAMP"),
+ * //       LatestTime: new Date("TIMESTAMP"),
+ * //     },
+ * //     AllocatedStorage: Number("int"),
+ * //     Status: "STRING_VALUE",
+ * //     Port: Number("int"),
+ * //     AvailabilityZone: "STRING_VALUE",
+ * //     VpcId: "STRING_VALUE",
+ * //     InstanceCreateTime: new Date("TIMESTAMP"),
+ * //     MasterUsername: "STRING_VALUE",
+ * //     Engine: "STRING_VALUE",
+ * //     EngineVersion: "STRING_VALUE",
+ * //     LicenseModel: "STRING_VALUE",
+ * //     Iops: Number("int"),
+ * //     OptionGroupName: "STRING_VALUE",
+ * //     TdeCredentialArn: "STRING_VALUE",
+ * //     Encrypted: true || false,
+ * //     StorageType: "STRING_VALUE",
+ * //     KmsKeyId: "STRING_VALUE",
+ * //     Timezone: "STRING_VALUE",
+ * //     IAMDatabaseAuthenticationEnabled: true || false,
+ * //     BackupRetentionPeriod: Number("int"),
+ * //     DBInstanceAutomatedBackupsArn: "STRING_VALUE",
+ * //     DBInstanceAutomatedBackupsReplications: [ // DBInstanceAutomatedBackupsReplicationList
+ * //       { // DBInstanceAutomatedBackupsReplication
+ * //         DBInstanceAutomatedBackupsArn: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     BackupTarget: "STRING_VALUE",
+ * //     StorageThroughput: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DeleteDBInstanceAutomatedBackupCommandInput - {@link DeleteDBInstanceAutomatedBackupCommandInput}
@@ -47,6 +87,8 @@ export interface DeleteDBInstanceAutomatedBackupCommandOutput extends DeleteDBIn
  *  <p>The automated backup is in an invalid state.
  *             For example, this automated backup is associated with an active instance.</p>
  *
+ * @throws {@link RDSServiceException}
+ * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  * @example To delete a replicated automated backup from a Region
  * ```javascript