@aws-sdk/client-database-migration-service 3.1097.0 → 3.1099.0

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

@@ -26,6 +26,10 @@ declare const DescribeDataProvidersCommand_base: {
 /**
  * <p>Returns a paginated list of data providers for your account in the current
  *          region.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:ListDataProviders</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -186,20 +190,18 @@ declare const DescribeDataProvidersCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Describe Data Providers
+ * @example Describe data providers with a filter
  * ```javascript
- * //
+ * // The following example retrieves the details of a data provider identified by its ARN.
  * const input = {
  *   Filters: [
  *     {
  *       Name: "data-provider-identifier",
  *       Values: [
- *         "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
+ *         "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS"
  *       ]
  *     }
- *   ],
- *   Marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
- *   MaxRecords: 20
+ *   ]
  * };
  * const command = new DescribeDataProvidersCommand(input);
  * const response = await client.send(command);
@@ -207,21 +209,22 @@ declare const DescribeDataProvidersCommand_base: {
  * {
  *   DataProviders: [
  *     {
- *       DataProviderArn: "arn:aws:dms:us-east-1:012345678901:data-provider:my-target-data-provider",
- *       DataProviderCreationTime: "2023-05-12T10:50:41.988561Z",
- *       DataProviderName: "my-target-data-provider",
- *       Engine: "postgres",
+ *       DataProviderArn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       DataProviderCreationTime: "2026-01-09T12:30:00.000000Z",
+ *       DataProviderName: "example-data-provider",
+ *       Description: "Example data provider for documentation",
+ *       Engine: "sqlserver",
  *       Settings: {
- *         PostgreSqlSettings: {
- *           DatabaseName: "target",
- *           Port: 5432,
- *           ServerName: "postrgesql.0a1b2c3d4e5f.us-east-1.rds.amazonaws.com",
- *           SslMode: "none"
+ *         MicrosoftSqlServerSettings: {
+ *           CertificateArn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *           DatabaseName: "ExampleDatabase",
+ *           Port: 1433,
+ *           ServerName: "example-source-server.us-east-1.rds.amazonaws.com",
+ *           SslMode: "verify-full"
  *         }
  *       }
  *     }
- *   ],
- *   Marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
+ *   ]
  * }
  * *\/
  * ```

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

@@ -24,9 +24,13 @@ declare const DescribeExtensionPackAssociationsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a paginated list of extension pack associations for the specified migration
- *          project. An extension pack is an add-on module that emulates functions present in a source
- *          database that are required when converting objects to the target database.</p>
+ * <p>Returns a paginated list of extension pack installation requests for a migration
+ *          project, initiated by
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartExtensionPackAssociation.html">StartExtensionPackAssociation</a>.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:ListExtensionPacks</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -92,32 +96,50 @@ declare const DescribeExtensionPackAssociationsCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Describe Extension Pack Associations
+ * @example Retrieve the status of extension pack associations
  * ```javascript
- * // Returns a paginated list of extension pack associations for the specified migration project.
+ * // The following example retrieves the status of operations that apply an extension pack to the target database, identified by their request IDs.
  * const input = {
  *   Filters: [
  *     {
- *       Name: "instance-profile-identifier",
+ *       Name: "request-id",
  *       Values: [
- *         "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
  *       ]
  *     }
  *   ],
- *   Marker: "0123456789abcdefghijklmnopqrs",
- *   MaxRecords: 20,
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
  * };
  * const command = new DescribeExtensionPackAssociationsCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   Marker: "0123456789abcdefghijklmnopqrs",
  *   Requests: [
  *     {
- *       MigrationProjectArn: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
- *       RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef",
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
  *       Status: "SUCCESS"
+ *     },
+ *     {
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       Progress: {
+ *         ProgressPercent: 50.0,
+ *         ProgressStep: "IN_PROGRESS"
+ *       },
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       Status: "IN_PROGRESS"
+ *     },
+ *     {
+ *       Error: {
+ *         defaultErrorDetails: {
+ *           Message: "The database user in your target secret does not have sufficient privileges. Grant the required privileges and try again."
+ *         }
+ *       },
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
+ *       Status: "FAILED"
  *     }
  *   ]
  * }

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

@@ -26,6 +26,10 @@ declare const DescribeInstanceProfilesCommand_base: {
 /**
  * <p>Returns a paginated list of instance profiles for your account in the current
  *          region.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:ListInstanceProfiles</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -90,20 +94,18 @@ declare const DescribeInstanceProfilesCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Describe Instance Profiles
+ * @example Describe instance profiles with a filter
  * ```javascript
- * // Returns a paginated list of instance profiles for your account in the current region.
+ * // The following example retrieves the details of an instance profile identified by its ARN.
  * const input = {
  *   Filters: [
  *     {
  *       Name: "instance-profile-identifier",
  *       Values: [
- *         "arn:aws:dms:us-east-1:012345678901:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
+ *         "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS"
  *       ]
  *     }
- *   ],
- *   Marker: "0123456789abcdefghijklmnopqrs",
- *   MaxRecords: 20
+ *   ]
  * };
  * const command = new DescribeInstanceProfilesCommand(input);
  * const response = await client.send(command);
@@ -111,15 +113,19 @@ declare const DescribeInstanceProfilesCommand_base: {
  * {
  *   InstanceProfiles: [
  *     {
- *       InstanceProfileArn: "arn:aws:dms:us-east-1:012345678901:instance-profile:my-instance-profile",
- *       InstanceProfileCreationTime: "2022-12-16T09:44:43.543246Z",
- *       InstanceProfileName: "my-instance-profile",
- *       KmsKeyArn: "arn:aws:kms:us-east-1:012345678901:key/01234567-89ab-cdef-0123-456789abcdef",
- *       PubliclyAccessible: true,
- *       SubnetGroupIdentifier: "public-subnets"
+ *       Description: "Example instance profile for documentation",
+ *       InstanceProfileArn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       InstanceProfileCreationTime: "2026-01-09T12:30:00.000000Z",
+ *       InstanceProfileName: "example-instance-profile",
+ *       KmsKeyArn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *       NetworkType: "IPV4",
+ *       PubliclyAccessible: false,
+ *       SubnetGroupIdentifier: "example-replication-subnet-group",
+ *       VpcSecurityGroups: [
+ *         "sg-0123456789abcdef0"
+ *       ]
  *     }
- *   ],
- *   Marker: "0123456789abcdefghijklmnopqrs"
+ *   ]
  * }
  * *\/
  * ```

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

@@ -24,8 +24,13 @@ declare const DescribeMetadataModelAssessmentsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a paginated list of metadata model assessments for your account in the current
- *          region.</p>
+ * <p>Returns a paginated list of metadata model assessment requests for a migration
+ *          project, initiated by
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelAssessment.html">StartMetadataModelAssessment</a>.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:ListMetadataModelAssessments</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -94,32 +99,56 @@ declare const DescribeMetadataModelAssessmentsCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Describe Metadata Model Assessments
+ * @example Retrieve the status of metadata model assessments
  * ```javascript
- * // Returns a paginated list of metadata model assessments for your account in the current region.
+ * // The following example retrieves the status of metadata model assessment operations identified by their request IDs.
  * const input = {
  *   Filters: [
  *     {
- *       Name: "my-migration-project",
+ *       Name: "request-id",
  *       Values: [
- *         "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
  *       ]
  *     }
  *   ],
- *   Marker: "0123456789abcdefghijklmnopqrs",
- *   MaxRecords: 20,
- *   MigrationProjectIdentifier: ""
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
  * };
  * const command = new DescribeMetadataModelAssessmentsCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   Marker: "ASDLKJASDJKHDFHGDNBGDASKJHGFK",
  *   Requests: [
  *     {
- *       MigrationProjectArn: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
- *       RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef",
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
  *       Status: "SUCCESS"
+ *     },
+ *     {
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       Progress: {
+ *         ProcessedObject: {
+ *           EndpointType: "SOURCE",
+ *           Name: "ExampleTable",
+ *           Type: "table"
+ *         },
+ *         ProgressPercent: 50.0,
+ *         ProgressStep: "ANALYZING",
+ *         TotalObjects: 100
+ *       },
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       Status: "IN_PROGRESS"
+ *     },
+ *     {
+ *       Error: {
+ *         defaultErrorDetails: {
+ *           Message: "No objects were found according to the specified selection rules. Please review your selection rules and try again."
+ *         }
+ *       },
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
+ *       Status: "FAILED"
  *     }
  *   ]
  * }

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

@@ -25,6 +25,10 @@ declare const DescribeMetadataModelChildrenCommand_base: {
 };
 /**
  * <p>Gets a list of child metadata models for the specified metadata model in the database hierarchy.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:DescribeMetadataModelChildren</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -71,6 +75,40 @@ declare const DescribeMetadataModelChildrenCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
+ * @example Retrieve children of a schema
+ * ```javascript
+ * // The following example retrieves the child metadata models of the ExampleSchema schema from the source metadata tree.
+ * const input = {
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *   Origin: "SOURCE",
+ *   SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema"}, "rule-action": "explicit"}]}`
+ * };
+ * const command = new DescribeMetadataModelChildrenCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   MetadataModelChildren: [
+ *     {
+ *       MetadataModelName: "Tables",
+ *       SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema", "category-name": "Tables"}, "rule-action": "explicit"}]}`
+ *     },
+ *     {
+ *       MetadataModelName: "Views",
+ *       SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "2", "rule-name": "2", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema", "category-name": "Views"}, "rule-action": "explicit"}]}`
+ *     },
+ *     {
+ *       MetadataModelName: "Functions",
+ *       SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "3", "rule-name": "3", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema", "category-name": "Functions"}, "rule-action": "explicit"}]}`
+ *     },
+ *     {
+ *       MetadataModelName: "Sequences",
+ *       SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "4", "rule-name": "4", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema", "category-name": "Sequences"}, "rule-action": "explicit"}]}`
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DescribeMetadataModelChildrenCommand extends DescribeMetadataModelChildrenCommand_base {

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

@@ -25,6 +25,10 @@ declare const DescribeMetadataModelCommand_base: {
 };
 /**
  * <p>Gets detailed information about the specified metadata model, including its definition and corresponding converted objects in the target database if applicable.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:DescribeMetadataModel</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -71,6 +75,31 @@ declare const DescribeMetadataModelCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
+ * @example Retrieve a source table metadata model
+ * ```javascript
+ * // The following example retrieves detailed information about the ExampleTable table in the ExampleSchema schema from the source metadata tree, including its SQL definition and references to the corresponding converted metadata models in the target database.
+ * const input = {
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *   Origin: "SOURCE",
+ *   SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-source-server.us-east-1.rds.amazonaws.com", "schema-name": "ExampleSchema", "table-name": "ExampleTable"}, "rule-action": "explicit"}]}`
+ * };
+ * const command = new DescribeMetadataModelCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Definition: "CREATE TABLE ExampleTable (ExampleColumn INTEGER NOT NULL);",
+ *   MetadataModelName: "ExampleTable",
+ *   MetadataModelType: "table",
+ *   TargetMetadataModels: [
+ *     {
+ *       MetadataModelName: "exampletable",
+ *       SelectionRules: `{"rules": [{"rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": {"server-name": "example-target-server.us-east-1.rds.amazonaws.com", "schema-name": "exampleschema", "table-name": "exampletable"}, "rule-action": "explicit"}]}`
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DescribeMetadataModelCommand extends DescribeMetadataModelCommand_base {

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

@@ -24,7 +24,15 @@ declare const DescribeMetadataModelConversionsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a paginated list of metadata model conversions for a migration project.</p>
+ * <p>Returns a paginated list of metadata model conversion requests for a migration
+ *          project, initiated by
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelConversion.html">StartMetadataModelConversion</a>.</p>
+ *          <p>To cancel a queued or in-progress request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CancelMetadataModelConversion.html">CancelMetadataModelConversion</a>.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:ListMetadataModelConversions</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -93,32 +101,56 @@ declare const DescribeMetadataModelConversionsCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Describe Metadata Model Conversions
+ * @example Retrieve the status of metadata model conversions
  * ```javascript
- * // Returns a paginated list of metadata model conversions for a migration project.
+ * // The following example retrieves the status of metadata model conversion operations identified by their request IDs.
  * const input = {
  *   Filters: [
  *     {
  *       Name: "request-id",
  *       Values: [
- *         "01234567-89ab-cdef-0123-456789abcdef"
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
  *       ]
  *     }
  *   ],
- *   Marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456",
- *   MaxRecords: 123,
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
  * };
  * const command = new DescribeMetadataModelConversionsCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   Marker: "0123456789abcdefghijklmnopqrs",
  *   Requests: [
  *     {
- *       MigrationProjectArn: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
- *       RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef",
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
  *       Status: "SUCCESS"
+ *     },
+ *     {
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       Progress: {
+ *         ProcessedObject: {
+ *           EndpointType: "SOURCE",
+ *           Name: "ExampleTable",
+ *           Type: "table"
+ *         },
+ *         ProgressPercent: 50.0,
+ *         ProgressStep: "CONVERTING",
+ *         TotalObjects: 100
+ *       },
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       Status: "IN_PROGRESS"
+ *     },
+ *     {
+ *       Error: {
+ *         defaultErrorDetails: {
+ *           Message: "No objects were found according to the specified selection rules. Please review your selection rules and try again."
+ *         }
+ *       },
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
+ *       Status: "FAILED"
  *     }
  *   ]
  * }

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

@@ -24,7 +24,15 @@ declare const DescribeMetadataModelCreationsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a paginated list of metadata model creation requests for a migration project.</p>
+ * <p>Returns a paginated list of metadata model creation requests for a migration
+ *          project, initiated by
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelCreation.html">StartMetadataModelCreation</a>.</p>
+ *          <p>To cancel a queued or in-progress request, call
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CancelMetadataModelCreation.html">CancelMetadataModelCreation</a>.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:DescribeMetadataModelCreations</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -97,6 +105,52 @@ declare const DescribeMetadataModelCreationsCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
+ * @example Retrieve the status of metadata model creations
+ * ```javascript
+ * // The following example retrieves the status of metadata model creation operations identified by their request IDs.
+ * const input = {
+ *   Filters: [
+ *     {
+ *       Name: "request-id",
+ *       Values: [
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
+ *       ]
+ *     }
+ *   ],
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
+ * };
+ * const command = new DescribeMetadataModelCreationsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Requests: [
+ *     {
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *       Status: "SUCCESS"
+ *     },
+ *     {
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       Status: "IN_PROGRESS"
+ *     },
+ *     {
+ *       Error: {
+ *         defaultErrorDetails: {
+ *           Message: "No objects were found according to the specified selection rules. Please review your selection rules and try again."
+ *         }
+ *       },
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
+ *       Status: "FAILED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DescribeMetadataModelCreationsCommand extends DescribeMetadataModelCreationsCommand_base {

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

@@ -24,7 +24,13 @@ declare const DescribeMetadataModelExportsAsScriptCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a paginated list of metadata model exports.</p>
+ * <p>Returns a paginated list of metadata model export requests for a migration
+ *          project, initiated by
+ *          <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelExportAsScript.html">StartMetadataModelExportAsScript</a>.</p>
+ *          <p>
+ *             <b>Required permissions:</b>
+ *             <code>dms:ListMetadataModelExports</code>. For more information, see
+ *          <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -93,32 +99,58 @@ declare const DescribeMetadataModelExportsAsScriptCommand_base: {
  * <p>Base exception class for all service exceptions from DatabaseMigrationService service.</p>
  *
  *
- * @example Describe Metadata Model Exports As Script
+ * @example Retrieve the status of metadata model exports as script
  * ```javascript
- * // Returns a paginated list of metadata model exports.
+ * // The following example retrieves the status of operations that export metadata models as data definition language (DDL) scripts, identified by their request IDs.
  * const input = {
  *   Filters: [
  *     {
  *       Name: "request-id",
  *       Values: [
- *         "01234567-89ab-cdef-0123-456789abcdef"
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *         "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
  *       ]
  *     }
  *   ],
- *   Marker: "0123456789abcdefghijklmnopqrs",
- *   MaxRecords: 20,
- *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012"
+ *   MigrationProjectIdentifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
  * };
  * const command = new DescribeMetadataModelExportsAsScriptCommand(input);
  * const response = await client.send(command);
  * /* response is
  * {
- *   Marker: "0123456789abcdefghijklmnopqrs",
  *   Requests: [
  *     {
- *       MigrationProjectArn: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
- *       RequestIdentifier: "01234567-89ab-cdef-0123-456789abcdef",
+ *       ExportSqlDetails: {
+ *         ObjectURL: "https://amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com/example-migration-project/ExampleScript.zip",
+ *         S3ObjectKey: "s3://amzn-s3-demo-bucket/example-migration-project/ExampleScript.zip"
+ *       },
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
  *       Status: "SUCCESS"
+ *     },
+ *     {
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       Progress: {
+ *         ProcessedObject: {
+ *           EndpointType: "TARGET"
+ *         },
+ *         ProgressPercent: 50.0,
+ *         ProgressStep: "IN_PROGRESS",
+ *         TotalObjects: 100
+ *       },
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
+ *       Status: "IN_PROGRESS"
+ *     },
+ *     {
+ *       Error: {
+ *         defaultErrorDetails: {
+ *           Message: "No objects were found according to the specified selection rules. Please review your selection rules and try again."
+ *         }
+ *       },
+ *       MigrationProjectArn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
+ *       RequestIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
+ *       Status: "FAILED"
  *     }
  *   ]
  * }