@aws-sdk/client-database-migration-service 3.288.0 → 3.290.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/dist-types/commands/AddTagsToResourceCommand.d.ts +21 -0
  2. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +4 -0
  3. package/dist-types/commands/BatchStartRecommendationsCommand.d.ts +11 -0
  4. package/dist-types/commands/CancelReplicationTaskAssessmentRunCommand.d.ts +11 -0
  5. package/dist-types/commands/CreateEndpointCommand.d.ts +66 -0
  6. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +31 -0
  7. package/dist-types/commands/CreateFleetAdvisorCollectorCommand.d.ts +18 -0
  8. package/dist-types/commands/CreateReplicationInstanceCommand.d.ts +113 -0
  9. package/dist-types/commands/CreateReplicationSubnetGroupCommand.d.ts +47 -0
  10. package/dist-types/commands/CreateReplicationTaskCommand.d.ts +60 -0
  11. package/dist-types/commands/DeleteCertificateCommand.d.ts +23 -0
  12. package/dist-types/commands/DeleteConnectionCommand.d.ts +28 -0
  13. package/dist-types/commands/DeleteEndpointCommand.d.ts +34 -0
  14. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +7 -0
  15. package/dist-types/commands/DeleteFleetAdvisorCollectorCommand.d.ts +7 -0
  16. package/dist-types/commands/DeleteFleetAdvisorDatabasesCommand.d.ts +7 -0
  17. package/dist-types/commands/DeleteReplicationInstanceCommand.d.ts +73 -0
  18. package/dist-types/commands/DeleteReplicationSubnetGroupCommand.d.ts +18 -0
  19. package/dist-types/commands/DeleteReplicationTaskAssessmentRunCommand.d.ts +11 -0
  20. package/dist-types/commands/DeleteReplicationTaskCommand.d.ts +34 -0
  21. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +31 -0
  22. package/dist-types/commands/DescribeApplicableIndividualAssessmentsCommand.d.ts +11 -0
  23. package/dist-types/commands/DescribeCertificatesCommand.d.ts +31 -0
  24. package/dist-types/commands/DescribeConnectionsCommand.d.ts +39 -0
  25. package/dist-types/commands/DescribeEndpointSettingsCommand.d.ts +1 -0
  26. package/dist-types/commands/DescribeEndpointTypesCommand.d.ts +28 -0
  27. package/dist-types/commands/DescribeEndpointsCommand.d.ts +31 -0
  28. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +1 -0
  29. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +4 -0
  30. package/dist-types/commands/DescribeEventsCommand.d.ts +1 -0
  31. package/dist-types/commands/DescribeFleetAdvisorCollectorsCommand.d.ts +4 -0
  32. package/dist-types/commands/DescribeFleetAdvisorDatabasesCommand.d.ts +4 -0
  33. package/dist-types/commands/DescribeFleetAdvisorLsaAnalysisCommand.d.ts +4 -0
  34. package/dist-types/commands/DescribeFleetAdvisorSchemaObjectSummaryCommand.d.ts +4 -0
  35. package/dist-types/commands/DescribeFleetAdvisorSchemasCommand.d.ts +4 -0
  36. package/dist-types/commands/DescribeOrderableReplicationInstancesCommand.d.ts +19 -0
  37. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +4 -0
  38. package/dist-types/commands/DescribeRecommendationLimitationsCommand.d.ts +8 -0
  39. package/dist-types/commands/DescribeRecommendationsCommand.d.ts +8 -0
  40. package/dist-types/commands/DescribeRefreshSchemasStatusCommand.d.ts +23 -0
  41. package/dist-types/commands/DescribeReplicationInstanceTaskLogsCommand.d.ts +7 -0
  42. package/dist-types/commands/DescribeReplicationInstancesCommand.d.ts +31 -0
  43. package/dist-types/commands/DescribeReplicationSubnetGroupsCommand.d.ts +31 -0
  44. package/dist-types/commands/DescribeReplicationTaskAssessmentResultsCommand.d.ts +4 -0
  45. package/dist-types/commands/DescribeReplicationTaskAssessmentRunsCommand.d.ts +4 -0
  46. package/dist-types/commands/DescribeReplicationTaskIndividualAssessmentsCommand.d.ts +4 -0
  47. package/dist-types/commands/DescribeReplicationTasksCommand.d.ts +31 -0
  48. package/dist-types/commands/DescribeSchemasCommand.d.ts +26 -0
  49. package/dist-types/commands/DescribeTableStatisticsCommand.d.ts +27 -0
  50. package/dist-types/commands/ImportCertificateCommand.d.ts +27 -0
  51. package/dist-types/commands/ListTagsForResourceCommand.d.ts +20 -0
  52. package/dist-types/commands/ModifyEndpointCommand.d.ts +44 -0
  53. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +28 -0
  54. package/dist-types/commands/ModifyReplicationInstanceCommand.d.ts +97 -0
  55. package/dist-types/commands/ModifyReplicationSubnetGroupCommand.d.ts +38 -0
  56. package/dist-types/commands/ModifyReplicationTaskCommand.d.ts +13 -0
  57. package/dist-types/commands/MoveReplicationTaskCommand.d.ts +17 -0
  58. package/dist-types/commands/RebootReplicationInstanceCommand.d.ts +7 -0
  59. package/dist-types/commands/RefreshSchemasCommand.d.ts +30 -0
  60. package/dist-types/commands/ReloadTablesCommand.d.ts +7 -0
  61. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +16 -0
  62. package/dist-types/commands/RunFleetAdvisorLsaAnalysisCommand.d.ts +7 -0
  63. package/dist-types/commands/StartRecommendationsCommand.d.ts +11 -0
  64. package/dist-types/commands/StartReplicationTaskAssessmentCommand.d.ts +7 -0
  65. package/dist-types/commands/StartReplicationTaskAssessmentRunCommand.d.ts +39 -0
  66. package/dist-types/commands/StartReplicationTaskCommand.d.ts +40 -0
  67. package/dist-types/commands/StopReplicationTaskCommand.d.ts +34 -0
  68. package/dist-types/commands/TestConnectionCommand.d.ts +34 -0
  69. package/dist-types/commands/UpdateSubscriptionsToEventBridgeCommand.d.ts +8 -0
  70. package/package.json +30 -30
@@ -34,6 +34,79 @@ export interface DeleteReplicationInstanceCommandOutput extends DeleteReplicatio
34
34
  * @see {@link DeleteReplicationInstanceCommandOutput} for command's `response` shape.
35
35
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
36
36
  *
37
+ * @throws {@link InvalidResourceStateFault} (client fault)
38
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
39
+ *
40
+ * @throws {@link ResourceNotFoundFault} (client fault)
41
+ * <p>The resource could not be found.</p>
42
+ *
43
+ *
44
+ * @example Delete Replication Instance
45
+ * ```javascript
46
+ * // Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.
47
+ * //
48
+ * //
49
+ * const input = {
50
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
51
+ * };
52
+ * const command = new DeleteReplicationInstanceCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "ReplicationInstance": {
57
+ * "AllocatedStorage": 5,
58
+ * "AutoMinorVersionUpgrade": true,
59
+ * "EngineVersion": "1.5.0",
60
+ * "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd",
61
+ * "PendingModifiedValues": {},
62
+ * "PreferredMaintenanceWindow": "sun:06:00-sun:14:00",
63
+ * "PubliclyAccessible": true,
64
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
65
+ * "ReplicationInstanceClass": "dms.t2.micro",
66
+ * "ReplicationInstanceIdentifier": "test-rep-1",
67
+ * "ReplicationInstanceStatus": "creating",
68
+ * "ReplicationSubnetGroup": {
69
+ * "ReplicationSubnetGroupDescription": "default",
70
+ * "ReplicationSubnetGroupIdentifier": "default",
71
+ * "SubnetGroupStatus": "Complete",
72
+ * "Subnets": [
73
+ * {
74
+ * "SubnetAvailabilityZone": {
75
+ * "Name": "us-east-1d"
76
+ * },
77
+ * "SubnetIdentifier": "subnet-f6dd91af",
78
+ * "SubnetStatus": "Active"
79
+ * },
80
+ * {
81
+ * "SubnetAvailabilityZone": {
82
+ * "Name": "us-east-1b"
83
+ * },
84
+ * "SubnetIdentifier": "subnet-3605751d",
85
+ * "SubnetStatus": "Active"
86
+ * },
87
+ * {
88
+ * "SubnetAvailabilityZone": {
89
+ * "Name": "us-east-1c"
90
+ * },
91
+ * "SubnetIdentifier": "subnet-c2daefb5",
92
+ * "SubnetStatus": "Active"
93
+ * },
94
+ * {
95
+ * "SubnetAvailabilityZone": {
96
+ * "Name": "us-east-1e"
97
+ * },
98
+ * "SubnetIdentifier": "subnet-85e90cb8",
99
+ * "SubnetStatus": "Active"
100
+ * }
101
+ * ],
102
+ * "VpcId": "vpc-6741a603"
103
+ * }
104
+ * }
105
+ * }
106
+ * *\/
107
+ * // example id: delete-replication-instance-1481752552839
108
+ * ```
109
+ *
37
110
  */
38
111
  export declare class DeleteReplicationInstanceCommand extends $Command<DeleteReplicationInstanceCommandInput, DeleteReplicationInstanceCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
39
112
  readonly input: DeleteReplicationInstanceCommandInput;
@@ -29,6 +29,24 @@ export interface DeleteReplicationSubnetGroupCommandOutput extends DeleteReplica
29
29
  * @see {@link DeleteReplicationSubnetGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidResourceStateFault} (client fault)
33
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
34
+ *
35
+ * @throws {@link ResourceNotFoundFault} (client fault)
36
+ * <p>The resource could not be found.</p>
37
+ *
38
+ *
39
+ * @example Delete Replication Subnet Group
40
+ * ```javascript
41
+ * // Deletes a replication subnet group.
42
+ * const input = {
43
+ * "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366"
44
+ * };
45
+ * const command = new DeleteReplicationSubnetGroupCommand(input);
46
+ * await client.send(command);
47
+ * // example id: delete-replication-subnet-group-1481752728597
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class DeleteReplicationSubnetGroupCommand extends $Command<DeleteReplicationSubnetGroupCommandInput, DeleteReplicationSubnetGroupCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
52
  readonly input: DeleteReplicationSubnetGroupCommandInput;
@@ -32,6 +32,17 @@ export interface DeleteReplicationTaskAssessmentRunCommandOutput extends DeleteR
32
32
  * @see {@link DeleteReplicationTaskAssessmentRunCommandOutput} for command's `response` shape.
33
33
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
34
34
  *
35
+ * @throws {@link AccessDeniedFault} (client fault)
36
+ * <p>DMS was denied access to the endpoint. Check that the
37
+ * role is correctly configured.</p>
38
+ *
39
+ * @throws {@link InvalidResourceStateFault} (client fault)
40
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
41
+ *
42
+ * @throws {@link ResourceNotFoundFault} (client fault)
43
+ * <p>The resource could not be found.</p>
44
+ *
45
+ *
35
46
  */
36
47
  export declare class DeleteReplicationTaskAssessmentRunCommand extends $Command<DeleteReplicationTaskAssessmentRunCommandInput, DeleteReplicationTaskAssessmentRunCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
37
48
  readonly input: DeleteReplicationTaskAssessmentRunCommandInput;
@@ -29,6 +29,40 @@ export interface DeleteReplicationTaskCommandOutput extends DeleteReplicationTas
29
29
  * @see {@link DeleteReplicationTaskCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidResourceStateFault} (client fault)
33
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
34
+ *
35
+ * @throws {@link ResourceNotFoundFault} (client fault)
36
+ * <p>The resource could not be found.</p>
37
+ *
38
+ *
39
+ * @example Delete Replication Task
40
+ * ```javascript
41
+ * // Deletes the specified replication task.
42
+ * const input = {
43
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ"
44
+ * };
45
+ * const command = new DeleteReplicationTaskCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "ReplicationTask": {
50
+ * "MigrationType": "full-load",
51
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
52
+ * "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM",
53
+ * "ReplicationTaskCreationDate": "2016-12-14T18:25:43Z",
54
+ * "ReplicationTaskIdentifier": "task1",
55
+ * "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}",
56
+ * "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
57
+ * "Status": "creating",
58
+ * "TableMappings": "file://mappingfile.json",
59
+ * "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E"
60
+ * }
61
+ * }
62
+ * *\/
63
+ * // example id: delete-replication-task-1481752903506
64
+ * ```
65
+ *
32
66
  */
33
67
  export declare class DeleteReplicationTaskCommand extends $Command<DeleteReplicationTaskCommandInput, DeleteReplicationTaskCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
68
  readonly input: DeleteReplicationTaskCommandInput;
@@ -35,6 +35,37 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA
35
35
  * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape.
36
36
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
37
37
  *
38
+ *
39
+ * @example Describe acount attributes
40
+ * ```javascript
41
+ * // Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.
42
+ * const input = {};
43
+ * const command = new DescribeAccountAttributesCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "AccountQuotas": [
48
+ * {
49
+ * "AccountQuotaName": "ReplicationInstances",
50
+ * "Max": 20,
51
+ * "Used": 0
52
+ * },
53
+ * {
54
+ * "AccountQuotaName": "AllocatedStorage",
55
+ * "Max": 20,
56
+ * "Used": 0
57
+ * },
58
+ * {
59
+ * "AccountQuotaName": "Endpoints",
60
+ * "Max": 20,
61
+ * "Used": 0
62
+ * }
63
+ * ]
64
+ * }
65
+ * *\/
66
+ * // example id: describe-acount-attributes-1481753085663
67
+ * ```
68
+ *
38
69
  */
39
70
  export declare class DescribeAccountAttributesCommand extends $Command<DescribeAccountAttributesCommandInput, DescribeAccountAttributesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
40
71
  readonly input: DescribeAccountAttributesCommandInput;
@@ -43,6 +43,17 @@ export interface DescribeApplicableIndividualAssessmentsCommandOutput extends De
43
43
  * @see {@link DescribeApplicableIndividualAssessmentsCommandOutput} for command's `response` shape.
44
44
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
45
45
  *
46
+ * @throws {@link AccessDeniedFault} (client fault)
47
+ * <p>DMS was denied access to the endpoint. Check that the
48
+ * role is correctly configured.</p>
49
+ *
50
+ * @throws {@link InvalidResourceStateFault} (client fault)
51
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
52
+ *
53
+ * @throws {@link ResourceNotFoundFault} (client fault)
54
+ * <p>The resource could not be found.</p>
55
+ *
56
+ *
46
57
  */
47
58
  export declare class DescribeApplicableIndividualAssessmentsCommand extends $Command<DescribeApplicableIndividualAssessmentsCommandInput, DescribeApplicableIndividualAssessmentsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
48
59
  readonly input: DescribeApplicableIndividualAssessmentsCommandInput;
@@ -29,6 +29,37 @@ export interface DescribeCertificatesCommandOutput extends DescribeCertificatesR
29
29
  * @see {@link DescribeCertificatesCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link ResourceNotFoundFault} (client fault)
33
+ * <p>The resource could not be found.</p>
34
+ *
35
+ *
36
+ * @example Describe certificates
37
+ * ```javascript
38
+ * // Provides a description of the certificate.
39
+ * const input = {
40
+ * "Filters": [
41
+ * {
42
+ * "Name": "string",
43
+ * "Values": [
44
+ * "string",
45
+ * "string"
46
+ * ]
47
+ * }
48
+ * ],
49
+ * "Marker": "",
50
+ * "MaxRecords": 123
51
+ * };
52
+ * const command = new DescribeCertificatesCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "Certificates": [],
57
+ * "Marker": ""
58
+ * }
59
+ * *\/
60
+ * // example id: describe-certificates-1481753186244
61
+ * ```
62
+ *
32
63
  */
33
64
  export declare class DescribeCertificatesCommand extends $Command<DescribeCertificatesCommandInput, DescribeCertificatesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
65
  readonly input: DescribeCertificatesCommandInput;
@@ -30,6 +30,45 @@ export interface DescribeConnectionsCommandOutput extends DescribeConnectionsRes
30
30
  * @see {@link DescribeConnectionsCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @throws {@link ResourceNotFoundFault} (client fault)
34
+ * <p>The resource could not be found.</p>
35
+ *
36
+ *
37
+ * @example Describe connections
38
+ * ```javascript
39
+ * // Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
40
+ * const input = {
41
+ * "Filters": [
42
+ * {
43
+ * "Name": "string",
44
+ * "Values": [
45
+ * "string",
46
+ * "string"
47
+ * ]
48
+ * }
49
+ * ],
50
+ * "Marker": "",
51
+ * "MaxRecords": 123
52
+ * };
53
+ * const command = new DescribeConnectionsCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "Connections": [
58
+ * {
59
+ * "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE",
60
+ * "EndpointIdentifier": "testsrc1",
61
+ * "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ",
62
+ * "ReplicationInstanceIdentifier": "test",
63
+ * "Status": "successful"
64
+ * }
65
+ * ],
66
+ * "Marker": ""
67
+ * }
68
+ * *\/
69
+ * // example id: describe-connections-1481754477953
70
+ * ```
71
+ *
33
72
  */
34
73
  export declare class DescribeConnectionsCommand extends $Command<DescribeConnectionsCommandInput, DescribeConnectionsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
74
  readonly input: DescribeConnectionsCommandInput;
@@ -30,6 +30,7 @@ export interface DescribeEndpointSettingsCommandOutput extends DescribeEndpointS
30
30
  * @see {@link DescribeEndpointSettingsCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ *
33
34
  */
34
35
  export declare class DescribeEndpointSettingsCommand extends $Command<DescribeEndpointSettingsCommandInput, DescribeEndpointSettingsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
36
  readonly input: DescribeEndpointSettingsCommandInput;
@@ -29,6 +29,34 @@ export interface DescribeEndpointTypesCommandOutput extends DescribeEndpointType
29
29
  * @see {@link DescribeEndpointTypesCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ *
33
+ * @example Describe endpoint types
34
+ * ```javascript
35
+ * // Returns information about the type of endpoints available.
36
+ * const input = {
37
+ * "Filters": [
38
+ * {
39
+ * "Name": "string",
40
+ * "Values": [
41
+ * "string",
42
+ * "string"
43
+ * ]
44
+ * }
45
+ * ],
46
+ * "Marker": "",
47
+ * "MaxRecords": 123
48
+ * };
49
+ * const command = new DescribeEndpointTypesCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "Marker": "",
54
+ * "SupportedEndpointTypes": []
55
+ * }
56
+ * *\/
57
+ * // example id: describe-endpoint-types-1481754742591
58
+ * ```
59
+ *
32
60
  */
33
61
  export declare class DescribeEndpointTypesCommand extends $Command<DescribeEndpointTypesCommandInput, DescribeEndpointTypesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
62
  readonly input: DescribeEndpointTypesCommandInput;
@@ -29,6 +29,37 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
29
29
  * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link ResourceNotFoundFault} (client fault)
33
+ * <p>The resource could not be found.</p>
34
+ *
35
+ *
36
+ * @example Describe endpoints
37
+ * ```javascript
38
+ * // Returns information about the endpoints for your account in the current region.
39
+ * const input = {
40
+ * "Filters": [
41
+ * {
42
+ * "Name": "string",
43
+ * "Values": [
44
+ * "string",
45
+ * "string"
46
+ * ]
47
+ * }
48
+ * ],
49
+ * "Marker": "",
50
+ * "MaxRecords": 123
51
+ * };
52
+ * const command = new DescribeEndpointsCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "Endpoints": [],
57
+ * "Marker": ""
58
+ * }
59
+ * *\/
60
+ * // example id: describe-endpoints-1481754926060
61
+ * ```
62
+ *
32
63
  */
33
64
  export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
65
  readonly input: DescribeEndpointsCommandInput;
@@ -33,6 +33,7 @@ export interface DescribeEventCategoriesCommandOutput extends DescribeEventCateg
33
33
  * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape.
34
34
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
35
35
  *
36
+ *
36
37
  */
37
38
  export declare class DescribeEventCategoriesCommand extends $Command<DescribeEventCategoriesCommandInput, DescribeEventCategoriesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
38
39
  readonly input: DescribeEventCategoriesCommandInput;
@@ -34,6 +34,10 @@ export interface DescribeEventSubscriptionsCommandOutput extends DescribeEventSu
34
34
  * @see {@link DescribeEventSubscriptionsCommandOutput} for command's `response` shape.
35
35
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
36
36
  *
37
+ * @throws {@link ResourceNotFoundFault} (client fault)
38
+ * <p>The resource could not be found.</p>
39
+ *
40
+ *
37
41
  */
38
42
  export declare class DescribeEventSubscriptionsCommand extends $Command<DescribeEventSubscriptionsCommandInput, DescribeEventSubscriptionsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
39
43
  readonly input: DescribeEventSubscriptionsCommandInput;
@@ -33,6 +33,7 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M
33
33
  * @see {@link DescribeEventsCommandOutput} for command's `response` shape.
34
34
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
35
35
  *
36
+ *
36
37
  */
37
38
  export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
38
39
  readonly input: DescribeEventsCommandInput;
@@ -29,6 +29,10 @@ export interface DescribeFleetAdvisorCollectorsCommandOutput extends DescribeFle
29
29
  * @see {@link DescribeFleetAdvisorCollectorsCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidResourceStateFault} (client fault)
33
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
34
+ *
35
+ *
32
36
  */
33
37
  export declare class DescribeFleetAdvisorCollectorsCommand extends $Command<DescribeFleetAdvisorCollectorsCommandInput, DescribeFleetAdvisorCollectorsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
38
  readonly input: DescribeFleetAdvisorCollectorsCommandInput;
@@ -29,6 +29,10 @@ export interface DescribeFleetAdvisorDatabasesCommandOutput extends DescribeFlee
29
29
  * @see {@link DescribeFleetAdvisorDatabasesCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidResourceStateFault} (client fault)
33
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
34
+ *
35
+ *
32
36
  */
33
37
  export declare class DescribeFleetAdvisorDatabasesCommand extends $Command<DescribeFleetAdvisorDatabasesCommandInput, DescribeFleetAdvisorDatabasesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
38
  readonly input: DescribeFleetAdvisorDatabasesCommandInput;
@@ -30,6 +30,10 @@ export interface DescribeFleetAdvisorLsaAnalysisCommandOutput extends DescribeFl
30
30
  * @see {@link DescribeFleetAdvisorLsaAnalysisCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @throws {@link InvalidResourceStateFault} (client fault)
34
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
35
+ *
36
+ *
33
37
  */
34
38
  export declare class DescribeFleetAdvisorLsaAnalysisCommand extends $Command<DescribeFleetAdvisorLsaAnalysisCommandInput, DescribeFleetAdvisorLsaAnalysisCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
39
  readonly input: DescribeFleetAdvisorLsaAnalysisCommandInput;
@@ -30,6 +30,10 @@ export interface DescribeFleetAdvisorSchemaObjectSummaryCommandOutput extends De
30
30
  * @see {@link DescribeFleetAdvisorSchemaObjectSummaryCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @throws {@link InvalidResourceStateFault} (client fault)
34
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
35
+ *
36
+ *
33
37
  */
34
38
  export declare class DescribeFleetAdvisorSchemaObjectSummaryCommand extends $Command<DescribeFleetAdvisorSchemaObjectSummaryCommandInput, DescribeFleetAdvisorSchemaObjectSummaryCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
39
  readonly input: DescribeFleetAdvisorSchemaObjectSummaryCommandInput;
@@ -29,6 +29,10 @@ export interface DescribeFleetAdvisorSchemasCommandOutput extends DescribeFleetA
29
29
  * @see {@link DescribeFleetAdvisorSchemasCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidResourceStateFault} (client fault)
33
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
34
+ *
35
+ *
32
36
  */
33
37
  export declare class DescribeFleetAdvisorSchemasCommand extends $Command<DescribeFleetAdvisorSchemasCommandInput, DescribeFleetAdvisorSchemasCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
38
  readonly input: DescribeFleetAdvisorSchemasCommandInput;
@@ -30,6 +30,25 @@ export interface DescribeOrderableReplicationInstancesCommandOutput extends Desc
30
30
  * @see {@link DescribeOrderableReplicationInstancesCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ *
34
+ * @example Describe orderable replication instances
35
+ * ```javascript
36
+ * // Returns information about the replication instance types that can be created in the specified region.
37
+ * const input = {
38
+ * "Marker": "",
39
+ * "MaxRecords": 123
40
+ * };
41
+ * const command = new DescribeOrderableReplicationInstancesCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "Marker": "",
46
+ * "OrderableReplicationInstances": []
47
+ * }
48
+ * *\/
49
+ * // example id: describe-orderable-replication-instances-1481755123669
50
+ * ```
51
+ *
33
52
  */
34
53
  export declare class DescribeOrderableReplicationInstancesCommand extends $Command<DescribeOrderableReplicationInstancesCommandInput, DescribeOrderableReplicationInstancesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
54
  readonly input: DescribeOrderableReplicationInstancesCommandInput;
@@ -29,6 +29,10 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends Describe
29
29
  * @see {@link DescribePendingMaintenanceActionsCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link ResourceNotFoundFault} (client fault)
33
+ * <p>The resource could not be found.</p>
34
+ *
35
+ *
32
36
  */
33
37
  export declare class DescribePendingMaintenanceActionsCommand extends $Command<DescribePendingMaintenanceActionsCommandInput, DescribePendingMaintenanceActionsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
38
  readonly input: DescribePendingMaintenanceActionsCommandInput;
@@ -30,6 +30,14 @@ export interface DescribeRecommendationLimitationsCommandOutput extends Describe
30
30
  * @see {@link DescribeRecommendationLimitationsCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @throws {@link AccessDeniedFault} (client fault)
34
+ * <p>DMS was denied access to the endpoint. Check that the
35
+ * role is correctly configured.</p>
36
+ *
37
+ * @throws {@link InvalidResourceStateFault} (client fault)
38
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
39
+ *
40
+ *
33
41
  */
34
42
  export declare class DescribeRecommendationLimitationsCommand extends $Command<DescribeRecommendationLimitationsCommandInput, DescribeRecommendationLimitationsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
43
  readonly input: DescribeRecommendationLimitationsCommandInput;
@@ -30,6 +30,14 @@ export interface DescribeRecommendationsCommandOutput extends DescribeRecommenda
30
30
  * @see {@link DescribeRecommendationsCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @throws {@link AccessDeniedFault} (client fault)
34
+ * <p>DMS was denied access to the endpoint. Check that the
35
+ * role is correctly configured.</p>
36
+ *
37
+ * @throws {@link InvalidResourceStateFault} (client fault)
38
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
39
+ *
40
+ *
33
41
  */
34
42
  export declare class DescribeRecommendationsCommand extends $Command<DescribeRecommendationsCommandInput, DescribeRecommendationsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
43
  readonly input: DescribeRecommendationsCommandInput;
@@ -29,6 +29,29 @@ export interface DescribeRefreshSchemasStatusCommandOutput extends DescribeRefre
29
29
  * @see {@link DescribeRefreshSchemasStatusCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidResourceStateFault} (client fault)
33
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
34
+ *
35
+ * @throws {@link ResourceNotFoundFault} (client fault)
36
+ * <p>The resource could not be found.</p>
37
+ *
38
+ *
39
+ * @example Describe refresh schema status
40
+ * ```javascript
41
+ * // Returns the status of the refresh-schemas operation.
42
+ * const input = {
43
+ * "EndpointArn": ""
44
+ * };
45
+ * const command = new DescribeRefreshSchemasStatusCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "RefreshSchemasStatus": {}
50
+ * }
51
+ * *\/
52
+ * // example id: describe-refresh-schema-status-1481755303497
53
+ * ```
54
+ *
32
55
  */
33
56
  export declare class DescribeRefreshSchemasStatusCommand extends $Command<DescribeRefreshSchemasStatusCommandInput, DescribeRefreshSchemasStatusCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
57
  readonly input: DescribeRefreshSchemasStatusCommandInput;
@@ -29,6 +29,13 @@ export interface DescribeReplicationInstanceTaskLogsCommandOutput extends Descri
29
29
  * @see {@link DescribeReplicationInstanceTaskLogsCommandOutput} for command's `response` shape.
30
30
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidResourceStateFault} (client fault)
33
+ * <p>The resource is in a state that prevents it from being used for database migration.</p>
34
+ *
35
+ * @throws {@link ResourceNotFoundFault} (client fault)
36
+ * <p>The resource could not be found.</p>
37
+ *
38
+ *
32
39
  */
33
40
  export declare class DescribeReplicationInstanceTaskLogsCommand extends $Command<DescribeReplicationInstanceTaskLogsCommandInput, DescribeReplicationInstanceTaskLogsCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
34
41
  readonly input: DescribeReplicationInstanceTaskLogsCommandInput;
@@ -30,6 +30,37 @@ export interface DescribeReplicationInstancesCommandOutput extends DescribeRepli
30
30
  * @see {@link DescribeReplicationInstancesCommandOutput} for command's `response` shape.
31
31
  * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for DatabaseMigrationServiceClient's `config` shape.
32
32
  *
33
+ * @throws {@link ResourceNotFoundFault} (client fault)
34
+ * <p>The resource could not be found.</p>
35
+ *
36
+ *
37
+ * @example Describe replication instances
38
+ * ```javascript
39
+ * // Returns the status of the refresh-schemas operation.
40
+ * const input = {
41
+ * "Filters": [
42
+ * {
43
+ * "Name": "string",
44
+ * "Values": [
45
+ * "string",
46
+ * "string"
47
+ * ]
48
+ * }
49
+ * ],
50
+ * "Marker": "",
51
+ * "MaxRecords": 123
52
+ * };
53
+ * const command = new DescribeReplicationInstancesCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "Marker": "",
58
+ * "ReplicationInstances": []
59
+ * }
60
+ * *\/
61
+ * // example id: describe-replication-instances-1481755443952
62
+ * ```
63
+ *
33
64
  */
34
65
  export declare class DescribeReplicationInstancesCommand extends $Command<DescribeReplicationInstancesCommandInput, DescribeReplicationInstancesCommandOutput, DatabaseMigrationServiceClientResolvedConfig> {
35
66
  readonly input: DescribeReplicationInstancesCommandInput;