aws-sdk-databasemigrationservice 1.148.0 → 1.149.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-databasemigrationservice/client.rb +1429 -472
- data/lib/aws-sdk-databasemigrationservice/types.rb +471 -148
- data/lib/aws-sdk-databasemigrationservice.rb +1 -1
- metadata +1 -1
|
@@ -668,6 +668,14 @@ module Aws::DatabaseMigrationService
|
|
|
668
668
|
# Cancels a single metadata model conversion operation that was started
|
|
669
669
|
# with `StartMetadataModelConversion`.
|
|
670
670
|
#
|
|
671
|
+
# **Required permissions:** `dms:CancelMetadataModelConversion`. For
|
|
672
|
+
# more information, see [Actions, resources, and condition keys for
|
|
673
|
+
# Database Migration Service][1].
|
|
674
|
+
#
|
|
675
|
+
#
|
|
676
|
+
#
|
|
677
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
678
|
+
#
|
|
671
679
|
# @option params [required, String] :migration_project_identifier
|
|
672
680
|
# The migration project name or Amazon Resource Name (ARN).
|
|
673
681
|
#
|
|
@@ -679,6 +687,25 @@ module Aws::DatabaseMigrationService
|
|
|
679
687
|
#
|
|
680
688
|
# * {Types::CancelMetadataModelConversionResponse#request #request} => Types::SchemaConversionRequest
|
|
681
689
|
#
|
|
690
|
+
#
|
|
691
|
+
# @example Example: Cancel a metadata model conversion
|
|
692
|
+
#
|
|
693
|
+
# # The following example cancels a metadata model conversion operation.
|
|
694
|
+
#
|
|
695
|
+
# resp = client.cancel_metadata_model_conversion({
|
|
696
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
697
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
698
|
+
# })
|
|
699
|
+
#
|
|
700
|
+
# resp.to_h outputs the following:
|
|
701
|
+
# {
|
|
702
|
+
# request: {
|
|
703
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
704
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
705
|
+
# status: "CANCELING",
|
|
706
|
+
# },
|
|
707
|
+
# }
|
|
708
|
+
#
|
|
682
709
|
# @example Request syntax with placeholder values
|
|
683
710
|
#
|
|
684
711
|
# resp = client.cancel_metadata_model_conversion({
|
|
@@ -713,6 +740,14 @@ module Aws::DatabaseMigrationService
|
|
|
713
740
|
# Cancels a single metadata model creation operation that was started
|
|
714
741
|
# with `StartMetadataModelCreation`.
|
|
715
742
|
#
|
|
743
|
+
# **Required permissions:** `dms:CancelMetadataModelCreation`. For more
|
|
744
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
745
|
+
# Migration Service][1].
|
|
746
|
+
#
|
|
747
|
+
#
|
|
748
|
+
#
|
|
749
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
750
|
+
#
|
|
716
751
|
# @option params [required, String] :migration_project_identifier
|
|
717
752
|
# The migration project name or Amazon Resource Name (ARN).
|
|
718
753
|
#
|
|
@@ -724,6 +759,25 @@ module Aws::DatabaseMigrationService
|
|
|
724
759
|
#
|
|
725
760
|
# * {Types::CancelMetadataModelCreationResponse#request #request} => Types::SchemaConversionRequest
|
|
726
761
|
#
|
|
762
|
+
#
|
|
763
|
+
# @example Example: Cancel a metadata model creation
|
|
764
|
+
#
|
|
765
|
+
# # The following example cancels a metadata model creation operation.
|
|
766
|
+
#
|
|
767
|
+
# resp = client.cancel_metadata_model_creation({
|
|
768
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
769
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
770
|
+
# })
|
|
771
|
+
#
|
|
772
|
+
# resp.to_h outputs the following:
|
|
773
|
+
# {
|
|
774
|
+
# request: {
|
|
775
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
776
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
777
|
+
# status: "CANCELING",
|
|
778
|
+
# },
|
|
779
|
+
# }
|
|
780
|
+
#
|
|
727
781
|
# @example Request syntax with placeholder values
|
|
728
782
|
#
|
|
729
783
|
# resp = client.cancel_metadata_model_creation({
|
|
@@ -936,6 +990,14 @@ module Aws::DatabaseMigrationService
|
|
|
936
990
|
# Creates a data provider using the provided settings. A data provider
|
|
937
991
|
# stores a data store type and location information about your database.
|
|
938
992
|
#
|
|
993
|
+
# **Required permissions:** `dms:CreateDataProvider`. For more
|
|
994
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
995
|
+
# Migration Service][1].
|
|
996
|
+
#
|
|
997
|
+
#
|
|
998
|
+
#
|
|
999
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
1000
|
+
#
|
|
939
1001
|
# @option params [String] :data_provider_name
|
|
940
1002
|
# A user-friendly name for the data provider.
|
|
941
1003
|
#
|
|
@@ -943,10 +1005,11 @@ module Aws::DatabaseMigrationService
|
|
|
943
1005
|
# A user-friendly description of the data provider.
|
|
944
1006
|
#
|
|
945
1007
|
# @option params [required, String] :engine
|
|
946
|
-
# The type of database engine for the data provider.
|
|
947
|
-
#
|
|
948
|
-
#
|
|
949
|
-
# `
|
|
1008
|
+
# The type of database engine for the data provider.
|
|
1009
|
+
#
|
|
1010
|
+
# Valid values: `aurora`, `aurora-postgresql`, `db2`, `db2-zos`,
|
|
1011
|
+
# `docdb`, `mariadb`, `mongodb`, `mysql`, `oracle`, `postgres`,
|
|
1012
|
+
# `redshift`, `sqlserver`, and `sybase`. A value of `aurora` represents
|
|
950
1013
|
# Amazon Aurora MySQL-Compatible Edition.
|
|
951
1014
|
#
|
|
952
1015
|
# @option params [Boolean] :virtual
|
|
@@ -963,43 +1026,40 @@ module Aws::DatabaseMigrationService
|
|
|
963
1026
|
# * {Types::CreateDataProviderResponse#data_provider #data_provider} => Types::DataProvider
|
|
964
1027
|
#
|
|
965
1028
|
#
|
|
966
|
-
# @example Example: Create
|
|
1029
|
+
# @example Example: Create a Microsoft SQL Server data provider
|
|
967
1030
|
#
|
|
968
|
-
# #
|
|
1031
|
+
# # The following example creates a Microsoft SQL Server data provider.
|
|
969
1032
|
#
|
|
970
1033
|
# resp = client.create_data_provider({
|
|
971
|
-
# data_provider_name: "
|
|
972
|
-
# description: "
|
|
1034
|
+
# data_provider_name: "example-data-provider",
|
|
1035
|
+
# description: "Example data provider for documentation",
|
|
973
1036
|
# engine: "sqlserver",
|
|
974
1037
|
# settings: {
|
|
975
1038
|
# microsoft_sql_server_settings: {
|
|
976
|
-
#
|
|
977
|
-
#
|
|
978
|
-
#
|
|
979
|
-
#
|
|
1039
|
+
# certificate_arn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
1040
|
+
# database_name: "ExampleDatabase",
|
|
1041
|
+
# port: 1433,
|
|
1042
|
+
# server_name: "example-source-server.us-east-1.rds.amazonaws.com",
|
|
1043
|
+
# ssl_mode: "verify-full",
|
|
980
1044
|
# },
|
|
981
1045
|
# },
|
|
982
|
-
# tags: [
|
|
983
|
-
# {
|
|
984
|
-
# key: "access",
|
|
985
|
-
# value: "authorizedusers",
|
|
986
|
-
# },
|
|
987
|
-
# ],
|
|
988
1046
|
# })
|
|
989
1047
|
#
|
|
990
1048
|
# resp.to_h outputs the following:
|
|
991
1049
|
# {
|
|
992
1050
|
# data_provider: {
|
|
993
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
994
|
-
# data_provider_creation_time: Time.parse("
|
|
995
|
-
# data_provider_name: "
|
|
996
|
-
#
|
|
1051
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
1052
|
+
# data_provider_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
1053
|
+
# data_provider_name: "example-data-provider",
|
|
1054
|
+
# description: "Example data provider for documentation",
|
|
1055
|
+
# engine: "sqlserver",
|
|
997
1056
|
# settings: {
|
|
998
|
-
#
|
|
999
|
-
#
|
|
1000
|
-
#
|
|
1001
|
-
#
|
|
1002
|
-
#
|
|
1057
|
+
# microsoft_sql_server_settings: {
|
|
1058
|
+
# certificate_arn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
1059
|
+
# database_name: "ExampleDatabase",
|
|
1060
|
+
# port: 1433,
|
|
1061
|
+
# server_name: "example-source-server.us-east-1.rds.amazonaws.com",
|
|
1062
|
+
# ssl_mode: "verify-full",
|
|
1003
1063
|
# },
|
|
1004
1064
|
# },
|
|
1005
1065
|
# },
|
|
@@ -2410,6 +2470,14 @@ module Aws::DatabaseMigrationService
|
|
|
2410
2470
|
|
|
2411
2471
|
# Creates the instance profile using the specified parameters.
|
|
2412
2472
|
#
|
|
2473
|
+
# **Required permissions:** `dms:CreateInstanceProfile`. For more
|
|
2474
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
2475
|
+
# Migration Service][1].
|
|
2476
|
+
#
|
|
2477
|
+
#
|
|
2478
|
+
#
|
|
2479
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
2480
|
+
#
|
|
2413
2481
|
# @option params [String] :availability_zone
|
|
2414
2482
|
# The Availability Zone where the instance profile will be created. The
|
|
2415
2483
|
# default value is a random, system-chosen Availability Zone in the
|
|
@@ -2460,36 +2528,35 @@ module Aws::DatabaseMigrationService
|
|
|
2460
2528
|
# * {Types::CreateInstanceProfileResponse#instance_profile #instance_profile} => Types::InstanceProfile
|
|
2461
2529
|
#
|
|
2462
2530
|
#
|
|
2463
|
-
# @example Example: Create
|
|
2531
|
+
# @example Example: Create an instance profile
|
|
2464
2532
|
#
|
|
2465
|
-
# #
|
|
2533
|
+
# # The following example creates an instance profile.
|
|
2466
2534
|
#
|
|
2467
2535
|
# resp = client.create_instance_profile({
|
|
2468
|
-
# description: "
|
|
2469
|
-
# instance_profile_name: "
|
|
2470
|
-
# kms_key_arn: "arn:aws:kms:us-east-1:
|
|
2471
|
-
# network_type: "
|
|
2472
|
-
# publicly_accessible:
|
|
2473
|
-
# subnet_group_identifier: "
|
|
2474
|
-
#
|
|
2475
|
-
#
|
|
2476
|
-
# key: "access",
|
|
2477
|
-
# value: "authorizedusers",
|
|
2478
|
-
# },
|
|
2536
|
+
# description: "Example instance profile for documentation",
|
|
2537
|
+
# instance_profile_name: "example-instance-profile",
|
|
2538
|
+
# kms_key_arn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
2539
|
+
# network_type: "IPV4",
|
|
2540
|
+
# publicly_accessible: false,
|
|
2541
|
+
# subnet_group_identifier: "example-replication-subnet-group",
|
|
2542
|
+
# vpc_security_groups: [
|
|
2543
|
+
# "sg-0123456789abcdef0",
|
|
2479
2544
|
# ],
|
|
2480
2545
|
# })
|
|
2481
2546
|
#
|
|
2482
2547
|
# resp.to_h outputs the following:
|
|
2483
2548
|
# {
|
|
2484
2549
|
# instance_profile: {
|
|
2485
|
-
#
|
|
2486
|
-
#
|
|
2487
|
-
#
|
|
2488
|
-
#
|
|
2489
|
-
#
|
|
2490
|
-
#
|
|
2550
|
+
# description: "Example instance profile for documentation",
|
|
2551
|
+
# instance_profile_arn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
2552
|
+
# instance_profile_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
2553
|
+
# instance_profile_name: "example-instance-profile",
|
|
2554
|
+
# kms_key_arn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
2555
|
+
# network_type: "IPV4",
|
|
2556
|
+
# publicly_accessible: false,
|
|
2557
|
+
# subnet_group_identifier: "example-replication-subnet-group",
|
|
2491
2558
|
# vpc_security_groups: [
|
|
2492
|
-
# "sg-
|
|
2559
|
+
# "sg-0123456789abcdef0",
|
|
2493
2560
|
# ],
|
|
2494
2561
|
# },
|
|
2495
2562
|
# }
|
|
@@ -2543,10 +2610,15 @@ module Aws::DatabaseMigrationService
|
|
|
2543
2610
|
# data providers using [CreateInstanceProfile][1] and
|
|
2544
2611
|
# [CreateDataProvider][2].
|
|
2545
2612
|
#
|
|
2613
|
+
# **Required permissions:** `dms:CreateMigrationProject`. For more
|
|
2614
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
2615
|
+
# Migration Service][3].
|
|
2616
|
+
#
|
|
2546
2617
|
#
|
|
2547
2618
|
#
|
|
2548
2619
|
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateInstanceProfile.html
|
|
2549
2620
|
# [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateDataProvider.html
|
|
2621
|
+
# [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
2550
2622
|
#
|
|
2551
2623
|
# @option params [String] :migration_project_name
|
|
2552
2624
|
# A user-friendly name for the migration project.
|
|
@@ -2566,11 +2638,20 @@ module Aws::DatabaseMigrationService
|
|
|
2566
2638
|
# hyphens.
|
|
2567
2639
|
#
|
|
2568
2640
|
# @option params [String] :transformation_rules
|
|
2569
|
-
#
|
|
2570
|
-
#
|
|
2571
|
-
#
|
|
2572
|
-
#
|
|
2573
|
-
#
|
|
2641
|
+
# A JSON string that specifies the transformation rules for the
|
|
2642
|
+
# migration project. Transformation rules let you customize how DMS
|
|
2643
|
+
# Schema Conversion converts your source database objects, including
|
|
2644
|
+
# renaming, adding prefixes or suffixes, and changing data types. For
|
|
2645
|
+
# the transformation rule format and examples, see [Transformation rules
|
|
2646
|
+
# in DMS Schema Conversion][1].
|
|
2647
|
+
#
|
|
2648
|
+
# <note markdown="1"> Homogeneous data migrations do not support transformation rules.
|
|
2649
|
+
#
|
|
2650
|
+
# </note>
|
|
2651
|
+
#
|
|
2652
|
+
#
|
|
2653
|
+
#
|
|
2654
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-transformation-rules.html
|
|
2574
2655
|
#
|
|
2575
2656
|
# @option params [String] :description
|
|
2576
2657
|
# A user-friendly description of the migration project.
|
|
@@ -2587,69 +2668,65 @@ module Aws::DatabaseMigrationService
|
|
|
2587
2668
|
# * {Types::CreateMigrationProjectResponse#migration_project #migration_project} => Types::MigrationProject
|
|
2588
2669
|
#
|
|
2589
2670
|
#
|
|
2590
|
-
# @example Example: Create
|
|
2671
|
+
# @example Example: Create a migration project
|
|
2591
2672
|
#
|
|
2592
|
-
# #
|
|
2673
|
+
# # The following example creates a migration project.
|
|
2593
2674
|
#
|
|
2594
2675
|
# resp = client.create_migration_project({
|
|
2595
|
-
# description: "
|
|
2596
|
-
# instance_profile_identifier: "
|
|
2597
|
-
# migration_project_name: "
|
|
2676
|
+
# description: "Example migration project for documentation",
|
|
2677
|
+
# instance_profile_identifier: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
2678
|
+
# migration_project_name: "example-migration-project",
|
|
2598
2679
|
# schema_conversion_application_attributes: {
|
|
2599
|
-
# s3_bucket_path: "
|
|
2600
|
-
# s3_bucket_role_arn: "arn:aws:iam::
|
|
2680
|
+
# s3_bucket_path: "s3://amzn-s3-demo-bucket",
|
|
2681
|
+
# s3_bucket_role_arn: "arn:aws:iam::111122223333:role/example-s3-access-role",
|
|
2601
2682
|
# },
|
|
2602
2683
|
# source_data_provider_descriptors: [
|
|
2603
2684
|
# {
|
|
2604
|
-
# data_provider_identifier: "arn:aws:dms:us-east-1:
|
|
2605
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
2606
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
2607
|
-
# },
|
|
2608
|
-
# ],
|
|
2609
|
-
# tags: [
|
|
2610
|
-
# {
|
|
2611
|
-
# key: "access",
|
|
2612
|
-
# value: "authorizedusers",
|
|
2685
|
+
# data_provider_identifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
2686
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
2687
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3",
|
|
2613
2688
|
# },
|
|
2614
2689
|
# ],
|
|
2615
2690
|
# target_data_provider_descriptors: [
|
|
2616
2691
|
# {
|
|
2617
|
-
# data_provider_identifier: "arn:aws:dms:us-east-1:
|
|
2618
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
2619
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
2692
|
+
# data_provider_identifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
2693
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
2694
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3",
|
|
2620
2695
|
# },
|
|
2621
2696
|
# ],
|
|
2622
|
-
# transformation_rules: "{\"
|
|
2697
|
+
# transformation_rules: "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
|
|
2623
2698
|
# })
|
|
2624
2699
|
#
|
|
2625
2700
|
# resp.to_h outputs the following:
|
|
2626
2701
|
# {
|
|
2627
2702
|
# migration_project: {
|
|
2628
|
-
#
|
|
2629
|
-
#
|
|
2630
|
-
#
|
|
2631
|
-
#
|
|
2632
|
-
#
|
|
2703
|
+
# description: "Example migration project for documentation",
|
|
2704
|
+
# instance_profile_arn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
2705
|
+
# instance_profile_name: "example-instance-profile",
|
|
2706
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
2707
|
+
# migration_project_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
2708
|
+
# migration_project_name: "example-migration-project",
|
|
2633
2709
|
# schema_conversion_application_attributes: {
|
|
2634
|
-
# s3_bucket_path: "
|
|
2635
|
-
# s3_bucket_role_arn: "arn:aws:iam::
|
|
2710
|
+
# s3_bucket_path: "s3://amzn-s3-demo-bucket",
|
|
2711
|
+
# s3_bucket_role_arn: "arn:aws:iam::111122223333:role/example-s3-access-role",
|
|
2636
2712
|
# },
|
|
2637
2713
|
# source_data_provider_descriptors: [
|
|
2638
2714
|
# {
|
|
2639
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
2640
|
-
# data_provider_name: "
|
|
2641
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
2642
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
2715
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
2716
|
+
# data_provider_name: "example-data-provider",
|
|
2717
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
2718
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3",
|
|
2643
2719
|
# },
|
|
2644
2720
|
# ],
|
|
2645
2721
|
# target_data_provider_descriptors: [
|
|
2646
2722
|
# {
|
|
2647
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
2648
|
-
# data_provider_name: "
|
|
2649
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
2650
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
2723
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
2724
|
+
# data_provider_name: "example-data-provider",
|
|
2725
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
2726
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3",
|
|
2651
2727
|
# },
|
|
2652
2728
|
# ],
|
|
2729
|
+
# transformation_rules: "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
|
|
2653
2730
|
# },
|
|
2654
2731
|
# }
|
|
2655
2732
|
#
|
|
@@ -3697,11 +3774,19 @@ module Aws::DatabaseMigrationService
|
|
|
3697
3774
|
|
|
3698
3775
|
# Deletes the specified data provider.
|
|
3699
3776
|
#
|
|
3777
|
+
# **Required permissions:** `dms:DeleteDataProvider`. For more
|
|
3778
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
3779
|
+
# Migration Service][1].
|
|
3780
|
+
#
|
|
3700
3781
|
# <note markdown="1"> All migration projects associated with the data provider must be
|
|
3701
3782
|
# deleted or modified before you can delete the data provider.
|
|
3702
3783
|
#
|
|
3703
3784
|
# </note>
|
|
3704
3785
|
#
|
|
3786
|
+
#
|
|
3787
|
+
#
|
|
3788
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
3789
|
+
#
|
|
3705
3790
|
# @option params [required, String] :data_provider_identifier
|
|
3706
3791
|
# The identifier of the data provider to delete.
|
|
3707
3792
|
#
|
|
@@ -3710,27 +3795,29 @@ module Aws::DatabaseMigrationService
|
|
|
3710
3795
|
# * {Types::DeleteDataProviderResponse#data_provider #data_provider} => Types::DataProvider
|
|
3711
3796
|
#
|
|
3712
3797
|
#
|
|
3713
|
-
# @example Example: Delete
|
|
3798
|
+
# @example Example: Delete a data provider
|
|
3714
3799
|
#
|
|
3715
|
-
# #
|
|
3800
|
+
# # The following example deletes a data provider identified by its ARN.
|
|
3716
3801
|
#
|
|
3717
3802
|
# resp = client.delete_data_provider({
|
|
3718
|
-
# data_provider_identifier: "arn:aws:dms:us-east-1:
|
|
3803
|
+
# data_provider_identifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
3719
3804
|
# })
|
|
3720
3805
|
#
|
|
3721
3806
|
# resp.to_h outputs the following:
|
|
3722
3807
|
# {
|
|
3723
3808
|
# data_provider: {
|
|
3724
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
3725
|
-
# data_provider_creation_time: Time.parse("
|
|
3726
|
-
# data_provider_name: "
|
|
3727
|
-
#
|
|
3809
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
3810
|
+
# data_provider_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
3811
|
+
# data_provider_name: "example-data-provider",
|
|
3812
|
+
# description: "Example data provider for documentation",
|
|
3813
|
+
# engine: "sqlserver",
|
|
3728
3814
|
# settings: {
|
|
3729
|
-
#
|
|
3730
|
-
#
|
|
3731
|
-
#
|
|
3732
|
-
#
|
|
3733
|
-
#
|
|
3815
|
+
# microsoft_sql_server_settings: {
|
|
3816
|
+
# certificate_arn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
3817
|
+
# database_name: "ExampleDatabase",
|
|
3818
|
+
# port: 1433,
|
|
3819
|
+
# server_name: "example-source-server.us-east-1.rds.amazonaws.com",
|
|
3820
|
+
# ssl_mode: "verify-full",
|
|
3734
3821
|
# },
|
|
3735
3822
|
# },
|
|
3736
3823
|
# },
|
|
@@ -4330,11 +4417,19 @@ module Aws::DatabaseMigrationService
|
|
|
4330
4417
|
|
|
4331
4418
|
# Deletes the specified instance profile.
|
|
4332
4419
|
#
|
|
4420
|
+
# **Required permissions:** `dms:DeleteInstanceProfile`. For more
|
|
4421
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
4422
|
+
# Migration Service][1].
|
|
4423
|
+
#
|
|
4333
4424
|
# <note markdown="1"> All migration projects associated with the instance profile must be
|
|
4334
4425
|
# deleted or modified before you can delete the instance profile.
|
|
4335
4426
|
#
|
|
4336
4427
|
# </note>
|
|
4337
4428
|
#
|
|
4429
|
+
#
|
|
4430
|
+
#
|
|
4431
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
4432
|
+
#
|
|
4338
4433
|
# @option params [required, String] :instance_profile_identifier
|
|
4339
4434
|
# The identifier of the instance profile to delete.
|
|
4340
4435
|
#
|
|
@@ -4343,25 +4438,27 @@ module Aws::DatabaseMigrationService
|
|
|
4343
4438
|
# * {Types::DeleteInstanceProfileResponse#instance_profile #instance_profile} => Types::InstanceProfile
|
|
4344
4439
|
#
|
|
4345
4440
|
#
|
|
4346
|
-
# @example Example: Delete
|
|
4441
|
+
# @example Example: Delete an instance profile
|
|
4347
4442
|
#
|
|
4348
|
-
# #
|
|
4443
|
+
# # The following example deletes an instance profile identified by its ARN.
|
|
4349
4444
|
#
|
|
4350
4445
|
# resp = client.delete_instance_profile({
|
|
4351
|
-
# instance_profile_identifier: "arn:aws:dms:us-east-1:
|
|
4446
|
+
# instance_profile_identifier: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
4352
4447
|
# })
|
|
4353
4448
|
#
|
|
4354
4449
|
# resp.to_h outputs the following:
|
|
4355
4450
|
# {
|
|
4356
4451
|
# instance_profile: {
|
|
4357
|
-
#
|
|
4358
|
-
#
|
|
4359
|
-
#
|
|
4360
|
-
#
|
|
4361
|
-
#
|
|
4362
|
-
#
|
|
4452
|
+
# description: "Example instance profile for documentation",
|
|
4453
|
+
# instance_profile_arn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
4454
|
+
# instance_profile_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
4455
|
+
# instance_profile_name: "example-instance-profile",
|
|
4456
|
+
# kms_key_arn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
4457
|
+
# network_type: "IPV4",
|
|
4458
|
+
# publicly_accessible: false,
|
|
4459
|
+
# subnet_group_identifier: "example-replication-subnet-group",
|
|
4363
4460
|
# vpc_security_groups: [
|
|
4364
|
-
# "sg-
|
|
4461
|
+
# "sg-0123456789abcdef0",
|
|
4365
4462
|
# ],
|
|
4366
4463
|
# },
|
|
4367
4464
|
# }
|
|
@@ -4397,10 +4494,18 @@ module Aws::DatabaseMigrationService
|
|
|
4397
4494
|
|
|
4398
4495
|
# Deletes the specified migration project.
|
|
4399
4496
|
#
|
|
4497
|
+
# **Required permissions:** `dms:DeleteMigrationProject`. For more
|
|
4498
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
4499
|
+
# Migration Service][1].
|
|
4500
|
+
#
|
|
4400
4501
|
# <note markdown="1"> The migration project must be closed before you can delete it.
|
|
4401
4502
|
#
|
|
4402
4503
|
# </note>
|
|
4403
4504
|
#
|
|
4505
|
+
#
|
|
4506
|
+
#
|
|
4507
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
4508
|
+
#
|
|
4404
4509
|
# @option params [required, String] :migration_project_identifier
|
|
4405
4510
|
# The name or Amazon Resource Name (ARN) of the migration project to
|
|
4406
4511
|
# delete.
|
|
@@ -4410,42 +4515,44 @@ module Aws::DatabaseMigrationService
|
|
|
4410
4515
|
# * {Types::DeleteMigrationProjectResponse#migration_project #migration_project} => Types::MigrationProject
|
|
4411
4516
|
#
|
|
4412
4517
|
#
|
|
4413
|
-
# @example Example: Delete
|
|
4518
|
+
# @example Example: Delete a migration project
|
|
4414
4519
|
#
|
|
4415
|
-
# #
|
|
4520
|
+
# # The following example deletes a migration project identified by its ARN.
|
|
4416
4521
|
#
|
|
4417
4522
|
# resp = client.delete_migration_project({
|
|
4418
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
4523
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
4419
4524
|
# })
|
|
4420
4525
|
#
|
|
4421
4526
|
# resp.to_h outputs the following:
|
|
4422
4527
|
# {
|
|
4423
4528
|
# migration_project: {
|
|
4424
|
-
#
|
|
4425
|
-
#
|
|
4426
|
-
#
|
|
4427
|
-
#
|
|
4428
|
-
#
|
|
4529
|
+
# description: "Example migration project for documentation",
|
|
4530
|
+
# instance_profile_arn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
4531
|
+
# instance_profile_name: "example-instance-profile",
|
|
4532
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
4533
|
+
# migration_project_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
4534
|
+
# migration_project_name: "example-migration-project",
|
|
4429
4535
|
# schema_conversion_application_attributes: {
|
|
4430
|
-
# s3_bucket_path: "
|
|
4431
|
-
# s3_bucket_role_arn: "arn:aws:iam::
|
|
4536
|
+
# s3_bucket_path: "s3://amzn-s3-demo-bucket",
|
|
4537
|
+
# s3_bucket_role_arn: "arn:aws:iam::111122223333:role/example-s3-access-role",
|
|
4432
4538
|
# },
|
|
4433
4539
|
# source_data_provider_descriptors: [
|
|
4434
4540
|
# {
|
|
4435
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
4436
|
-
# data_provider_name: "
|
|
4437
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
4438
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
4541
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
4542
|
+
# data_provider_name: "example-data-provider",
|
|
4543
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
4544
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3",
|
|
4439
4545
|
# },
|
|
4440
4546
|
# ],
|
|
4441
4547
|
# target_data_provider_descriptors: [
|
|
4442
4548
|
# {
|
|
4443
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
4444
|
-
# data_provider_name: "
|
|
4445
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
4446
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
4549
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
4550
|
+
# data_provider_name: "example-data-provider",
|
|
4551
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
4552
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3",
|
|
4447
4553
|
# },
|
|
4448
4554
|
# ],
|
|
4555
|
+
# transformation_rules: "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
|
|
4449
4556
|
# },
|
|
4450
4557
|
# }
|
|
4451
4558
|
#
|
|
@@ -5203,6 +5310,14 @@ module Aws::DatabaseMigrationService
|
|
|
5203
5310
|
|
|
5204
5311
|
# Returns configuration parameters for a schema conversion project.
|
|
5205
5312
|
#
|
|
5313
|
+
# **Required permissions:** `dms:DescribeConversionConfiguration`. For
|
|
5314
|
+
# more information, see [Actions, resources, and condition keys for
|
|
5315
|
+
# Database Migration Service][1].
|
|
5316
|
+
#
|
|
5317
|
+
#
|
|
5318
|
+
#
|
|
5319
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
5320
|
+
#
|
|
5206
5321
|
# @option params [required, String] :migration_project_identifier
|
|
5207
5322
|
# The name or Amazon Resource Name (ARN) for the schema conversion
|
|
5208
5323
|
# project to describe.
|
|
@@ -5213,18 +5328,18 @@ module Aws::DatabaseMigrationService
|
|
|
5213
5328
|
# * {Types::DescribeConversionConfigurationResponse#conversion_configuration #conversion_configuration} => String
|
|
5214
5329
|
#
|
|
5215
5330
|
#
|
|
5216
|
-
# @example Example:
|
|
5331
|
+
# @example Example: Retrieving conversion configuration for a migration project
|
|
5217
5332
|
#
|
|
5218
|
-
# #
|
|
5333
|
+
# # The following example retrieves the conversion configuration for a migration project.
|
|
5219
5334
|
#
|
|
5220
5335
|
# resp = client.describe_conversion_configuration({
|
|
5221
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
5336
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
5222
5337
|
# })
|
|
5223
5338
|
#
|
|
5224
5339
|
# resp.to_h outputs the following:
|
|
5225
5340
|
# {
|
|
5226
|
-
# conversion_configuration: "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\"},\"
|
|
5227
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
5341
|
+
# conversion_configuration: "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\",\"EnableGenAiConversion\":false},\"MSSQL_TO_AURORA_POSTGRESQL\":{\"ConvertProceduresToFunction\":true,\"UniqueIndexGeneration\":true,\"CaseSensitivityNames\":false},\"Conversion version\":{\"MSSQL_TO_AURORA_POSTGRESQL_target_engine_version\":\"15\"}}",
|
|
5342
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
5228
5343
|
# }
|
|
5229
5344
|
#
|
|
5230
5345
|
# @example Request syntax with placeholder values
|
|
@@ -5347,12 +5462,22 @@ module Aws::DatabaseMigrationService
|
|
|
5347
5462
|
# Returns a paginated list of data providers for your account in the
|
|
5348
5463
|
# current region.
|
|
5349
5464
|
#
|
|
5465
|
+
# **Required permissions:** `dms:ListDataProviders`. For more
|
|
5466
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
5467
|
+
# Migration Service][1].
|
|
5468
|
+
#
|
|
5469
|
+
#
|
|
5470
|
+
#
|
|
5471
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
5472
|
+
#
|
|
5350
5473
|
# @option params [Array<Types::Filter>] :filters
|
|
5351
|
-
#
|
|
5352
|
-
# key-value pairs.
|
|
5474
|
+
# The filters to apply to the data providers.
|
|
5353
5475
|
#
|
|
5354
|
-
#
|
|
5355
|
-
#
|
|
5476
|
+
# The following filter names are supported:
|
|
5477
|
+
#
|
|
5478
|
+
# * `data-provider-identifier` – The data provider name or ARN.
|
|
5479
|
+
#
|
|
5480
|
+
# ^
|
|
5356
5481
|
#
|
|
5357
5482
|
# @option params [Integer] :max_records
|
|
5358
5483
|
# The maximum number of records to include in the response. If more
|
|
@@ -5379,40 +5504,41 @@ module Aws::DatabaseMigrationService
|
|
|
5379
5504
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
5380
5505
|
#
|
|
5381
5506
|
#
|
|
5382
|
-
# @example Example: Describe
|
|
5507
|
+
# @example Example: Describe data providers with a filter
|
|
5508
|
+
#
|
|
5509
|
+
# # The following example retrieves the details of a data provider identified by its ARN.
|
|
5383
5510
|
#
|
|
5384
5511
|
# resp = client.describe_data_providers({
|
|
5385
5512
|
# filters: [
|
|
5386
5513
|
# {
|
|
5387
5514
|
# name: "data-provider-identifier",
|
|
5388
5515
|
# values: [
|
|
5389
|
-
# "arn:aws:dms:us-east-1:
|
|
5516
|
+
# "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
5390
5517
|
# ],
|
|
5391
5518
|
# },
|
|
5392
5519
|
# ],
|
|
5393
|
-
# marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
|
|
5394
|
-
# max_records: 20,
|
|
5395
5520
|
# })
|
|
5396
5521
|
#
|
|
5397
5522
|
# resp.to_h outputs the following:
|
|
5398
5523
|
# {
|
|
5399
5524
|
# data_providers: [
|
|
5400
5525
|
# {
|
|
5401
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
5402
|
-
# data_provider_creation_time: Time.parse("
|
|
5403
|
-
# data_provider_name: "
|
|
5404
|
-
#
|
|
5526
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
5527
|
+
# data_provider_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
5528
|
+
# data_provider_name: "example-data-provider",
|
|
5529
|
+
# description: "Example data provider for documentation",
|
|
5530
|
+
# engine: "sqlserver",
|
|
5405
5531
|
# settings: {
|
|
5406
|
-
#
|
|
5407
|
-
#
|
|
5408
|
-
#
|
|
5409
|
-
#
|
|
5410
|
-
#
|
|
5532
|
+
# microsoft_sql_server_settings: {
|
|
5533
|
+
# certificate_arn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
5534
|
+
# database_name: "ExampleDatabase",
|
|
5535
|
+
# port: 1433,
|
|
5536
|
+
# server_name: "example-source-server.us-east-1.rds.amazonaws.com",
|
|
5537
|
+
# ssl_mode: "verify-full",
|
|
5411
5538
|
# },
|
|
5412
5539
|
# },
|
|
5413
5540
|
# },
|
|
5414
5541
|
# ],
|
|
5415
|
-
# marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
|
|
5416
5542
|
# }
|
|
5417
5543
|
#
|
|
5418
5544
|
# @example Request syntax with placeholder values
|
|
@@ -6351,17 +6477,30 @@ module Aws::DatabaseMigrationService
|
|
|
6351
6477
|
req.send_request(options)
|
|
6352
6478
|
end
|
|
6353
6479
|
|
|
6354
|
-
# Returns a paginated list of extension pack
|
|
6355
|
-
#
|
|
6356
|
-
#
|
|
6357
|
-
#
|
|
6480
|
+
# Returns a paginated list of extension pack installation requests for a
|
|
6481
|
+
# migration project, initiated by [StartExtensionPackAssociation][1].
|
|
6482
|
+
#
|
|
6483
|
+
# **Required permissions:** `dms:ListExtensionPacks`. For more
|
|
6484
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
6485
|
+
# Migration Service][2].
|
|
6486
|
+
#
|
|
6487
|
+
#
|
|
6488
|
+
#
|
|
6489
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartExtensionPackAssociation.html
|
|
6490
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
6358
6491
|
#
|
|
6359
6492
|
# @option params [required, String] :migration_project_identifier
|
|
6360
|
-
# The name or Amazon Resource Name (ARN)
|
|
6493
|
+
# The migration project name or Amazon Resource Name (ARN).
|
|
6361
6494
|
#
|
|
6362
6495
|
# @option params [Array<Types::Filter>] :filters
|
|
6363
|
-
#
|
|
6364
|
-
#
|
|
6496
|
+
# The filters to apply to the extension pack installation requests.
|
|
6497
|
+
#
|
|
6498
|
+
# The following filter names are supported:
|
|
6499
|
+
#
|
|
6500
|
+
# * `request-id` – The request identifier.
|
|
6501
|
+
#
|
|
6502
|
+
# * `status` – The request status. Valid values: `RECEIVED`,
|
|
6503
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`.
|
|
6365
6504
|
#
|
|
6366
6505
|
# @option params [String] :marker
|
|
6367
6506
|
# Specifies the unique pagination token that makes it possible to
|
|
@@ -6388,33 +6527,52 @@ module Aws::DatabaseMigrationService
|
|
|
6388
6527
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
6389
6528
|
#
|
|
6390
6529
|
#
|
|
6391
|
-
# @example Example:
|
|
6530
|
+
# @example Example: Retrieve the status of extension pack associations
|
|
6392
6531
|
#
|
|
6393
|
-
# #
|
|
6532
|
+
# # The following example retrieves the status of operations that apply an extension pack to the target database, identified
|
|
6533
|
+
# # by their request IDs.
|
|
6394
6534
|
#
|
|
6395
6535
|
# resp = client.describe_extension_pack_associations({
|
|
6396
6536
|
# filters: [
|
|
6397
6537
|
# {
|
|
6398
|
-
# name: "
|
|
6538
|
+
# name: "request-id",
|
|
6399
6539
|
# values: [
|
|
6400
|
-
# "
|
|
6540
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
6541
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
6542
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
6401
6543
|
# ],
|
|
6402
6544
|
# },
|
|
6403
6545
|
# ],
|
|
6404
|
-
#
|
|
6405
|
-
# max_records: 20,
|
|
6406
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
|
|
6546
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
6407
6547
|
# })
|
|
6408
6548
|
#
|
|
6409
6549
|
# resp.to_h outputs the following:
|
|
6410
6550
|
# {
|
|
6411
|
-
# marker: "0123456789abcdefghijklmnopqrs",
|
|
6412
6551
|
# requests: [
|
|
6413
6552
|
# {
|
|
6414
|
-
# migration_project_arn: "arn:aws:dms:us-east-1:
|
|
6415
|
-
# request_identifier: "
|
|
6553
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
6554
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
6416
6555
|
# status: "SUCCESS",
|
|
6417
6556
|
# },
|
|
6557
|
+
# {
|
|
6558
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
6559
|
+
# progress: {
|
|
6560
|
+
# progress_percent: 50.0,
|
|
6561
|
+
# progress_step: "IN_PROGRESS",
|
|
6562
|
+
# },
|
|
6563
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
6564
|
+
# status: "IN_PROGRESS",
|
|
6565
|
+
# },
|
|
6566
|
+
# {
|
|
6567
|
+
# error: {
|
|
6568
|
+
# default_error_details: {
|
|
6569
|
+
# message: "The database user in your target secret does not have sufficient privileges. Grant the required privileges and try again.",
|
|
6570
|
+
# },
|
|
6571
|
+
# },
|
|
6572
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
6573
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
6574
|
+
# status: "FAILED",
|
|
6575
|
+
# },
|
|
6418
6576
|
# ],
|
|
6419
6577
|
# }
|
|
6420
6578
|
#
|
|
@@ -6885,12 +7043,22 @@ module Aws::DatabaseMigrationService
|
|
|
6885
7043
|
# Returns a paginated list of instance profiles for your account in the
|
|
6886
7044
|
# current region.
|
|
6887
7045
|
#
|
|
7046
|
+
# **Required permissions:** `dms:ListInstanceProfiles`. For more
|
|
7047
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
7048
|
+
# Migration Service][1].
|
|
7049
|
+
#
|
|
7050
|
+
#
|
|
7051
|
+
#
|
|
7052
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7053
|
+
#
|
|
6888
7054
|
# @option params [Array<Types::Filter>] :filters
|
|
6889
|
-
#
|
|
6890
|
-
# key-value pairs.
|
|
7055
|
+
# The filters to apply to the instance profiles.
|
|
6891
7056
|
#
|
|
6892
|
-
#
|
|
6893
|
-
#
|
|
7057
|
+
# The following filter names are supported:
|
|
7058
|
+
#
|
|
7059
|
+
# * `instance-profile-identifier` – The instance profile name or ARN.
|
|
7060
|
+
#
|
|
7061
|
+
# ^
|
|
6894
7062
|
#
|
|
6895
7063
|
# @option params [Integer] :max_records
|
|
6896
7064
|
# The maximum number of records to include in the response. If more
|
|
@@ -6917,36 +7085,38 @@ module Aws::DatabaseMigrationService
|
|
|
6917
7085
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
6918
7086
|
#
|
|
6919
7087
|
#
|
|
6920
|
-
# @example Example: Describe
|
|
7088
|
+
# @example Example: Describe instance profiles with a filter
|
|
6921
7089
|
#
|
|
6922
|
-
# #
|
|
7090
|
+
# # The following example retrieves the details of an instance profile identified by its ARN.
|
|
6923
7091
|
#
|
|
6924
7092
|
# resp = client.describe_instance_profiles({
|
|
6925
7093
|
# filters: [
|
|
6926
7094
|
# {
|
|
6927
7095
|
# name: "instance-profile-identifier",
|
|
6928
7096
|
# values: [
|
|
6929
|
-
# "arn:aws:dms:us-east-1:
|
|
7097
|
+
# "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
6930
7098
|
# ],
|
|
6931
7099
|
# },
|
|
6932
7100
|
# ],
|
|
6933
|
-
# marker: "0123456789abcdefghijklmnopqrs",
|
|
6934
|
-
# max_records: 20,
|
|
6935
7101
|
# })
|
|
6936
7102
|
#
|
|
6937
7103
|
# resp.to_h outputs the following:
|
|
6938
7104
|
# {
|
|
6939
7105
|
# instance_profiles: [
|
|
6940
7106
|
# {
|
|
6941
|
-
#
|
|
6942
|
-
#
|
|
6943
|
-
#
|
|
6944
|
-
#
|
|
6945
|
-
#
|
|
6946
|
-
#
|
|
7107
|
+
# description: "Example instance profile for documentation",
|
|
7108
|
+
# instance_profile_arn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7109
|
+
# instance_profile_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
7110
|
+
# instance_profile_name: "example-instance-profile",
|
|
7111
|
+
# kms_key_arn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7112
|
+
# network_type: "IPV4",
|
|
7113
|
+
# publicly_accessible: false,
|
|
7114
|
+
# subnet_group_identifier: "example-replication-subnet-group",
|
|
7115
|
+
# vpc_security_groups: [
|
|
7116
|
+
# "sg-0123456789abcdef0",
|
|
7117
|
+
# ],
|
|
6947
7118
|
# },
|
|
6948
7119
|
# ],
|
|
6949
|
-
# marker: "0123456789abcdefghijklmnopqrs",
|
|
6950
7120
|
# }
|
|
6951
7121
|
#
|
|
6952
7122
|
# @example Request syntax with placeholder values
|
|
@@ -6991,14 +7161,32 @@ module Aws::DatabaseMigrationService
|
|
|
6991
7161
|
# including its definition and corresponding converted objects in the
|
|
6992
7162
|
# target database if applicable.
|
|
6993
7163
|
#
|
|
7164
|
+
# **Required permissions:** `dms:DescribeMetadataModel`. For more
|
|
7165
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
7166
|
+
# Migration Service][1].
|
|
7167
|
+
#
|
|
7168
|
+
#
|
|
7169
|
+
#
|
|
7170
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7171
|
+
#
|
|
6994
7172
|
# @option params [required, String] :selection_rules
|
|
6995
|
-
#
|
|
6996
|
-
#
|
|
6997
|
-
#
|
|
7173
|
+
# A JSON string that identifies the metadata model to retrieve. For the
|
|
7174
|
+
# selection rule format and examples, see [Selection rules in DMS Schema
|
|
7175
|
+
# Conversion][1].
|
|
6998
7176
|
#
|
|
7177
|
+
# Usage:
|
|
6999
7178
|
#
|
|
7179
|
+
# * Accepts source or target selection rules depending on the `Origin`
|
|
7180
|
+
# parameter. The `server-name` in the object locator must match the
|
|
7181
|
+
# corresponding data provider.
|
|
7000
7182
|
#
|
|
7001
|
-
#
|
|
7183
|
+
# * Supports only `explicit` rule actions.
|
|
7184
|
+
#
|
|
7185
|
+
# * Exactly one rule is allowed.
|
|
7186
|
+
#
|
|
7187
|
+
#
|
|
7188
|
+
#
|
|
7189
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
7002
7190
|
#
|
|
7003
7191
|
# @option params [required, String] :migration_project_identifier
|
|
7004
7192
|
# The migration project name or Amazon Resource Name (ARN).
|
|
@@ -7014,6 +7202,32 @@ module Aws::DatabaseMigrationService
|
|
|
7014
7202
|
# * {Types::DescribeMetadataModelResponse#target_metadata_models #target_metadata_models} => Array<Types::MetadataModelReference>
|
|
7015
7203
|
# * {Types::DescribeMetadataModelResponse#definition #definition} => String
|
|
7016
7204
|
#
|
|
7205
|
+
#
|
|
7206
|
+
# @example Example: Retrieve a source table metadata model
|
|
7207
|
+
#
|
|
7208
|
+
# # The following example retrieves detailed information about the ExampleTable table in the ExampleSchema schema from the
|
|
7209
|
+
# # source metadata tree, including its SQL definition and references to the corresponding converted metadata models in the
|
|
7210
|
+
# # target database.
|
|
7211
|
+
#
|
|
7212
|
+
# resp = client.describe_metadata_model({
|
|
7213
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7214
|
+
# origin: "SOURCE",
|
|
7215
|
+
# selection_rules: "{\"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\"}]}",
|
|
7216
|
+
# })
|
|
7217
|
+
#
|
|
7218
|
+
# resp.to_h outputs the following:
|
|
7219
|
+
# {
|
|
7220
|
+
# definition: "CREATE TABLE ExampleTable (ExampleColumn INTEGER NOT NULL);",
|
|
7221
|
+
# metadata_model_name: "ExampleTable",
|
|
7222
|
+
# metadata_model_type: "table",
|
|
7223
|
+
# target_metadata_models: [
|
|
7224
|
+
# {
|
|
7225
|
+
# metadata_model_name: "exampletable",
|
|
7226
|
+
# selection_rules: "{\"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\"}]}",
|
|
7227
|
+
# },
|
|
7228
|
+
# ],
|
|
7229
|
+
# }
|
|
7230
|
+
#
|
|
7017
7231
|
# @example Request syntax with placeholder values
|
|
7018
7232
|
#
|
|
7019
7233
|
# resp = client.describe_metadata_model({
|
|
@@ -7040,15 +7254,30 @@ module Aws::DatabaseMigrationService
|
|
|
7040
7254
|
req.send_request(options)
|
|
7041
7255
|
end
|
|
7042
7256
|
|
|
7043
|
-
# Returns a paginated list of metadata model
|
|
7044
|
-
#
|
|
7257
|
+
# Returns a paginated list of metadata model assessment requests for a
|
|
7258
|
+
# migration project, initiated by [StartMetadataModelAssessment][1].
|
|
7259
|
+
#
|
|
7260
|
+
# **Required permissions:** `dms:ListMetadataModelAssessments`. For more
|
|
7261
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
7262
|
+
# Migration Service][2].
|
|
7263
|
+
#
|
|
7264
|
+
#
|
|
7265
|
+
#
|
|
7266
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelAssessment.html
|
|
7267
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7045
7268
|
#
|
|
7046
7269
|
# @option params [required, String] :migration_project_identifier
|
|
7047
|
-
# The name or Amazon Resource Name (ARN)
|
|
7270
|
+
# The migration project name or Amazon Resource Name (ARN).
|
|
7048
7271
|
#
|
|
7049
7272
|
# @option params [Array<Types::Filter>] :filters
|
|
7050
|
-
#
|
|
7051
|
-
#
|
|
7273
|
+
# The filters to apply to the metadata model assessment requests.
|
|
7274
|
+
#
|
|
7275
|
+
# The following filter names are supported:
|
|
7276
|
+
#
|
|
7277
|
+
# * `request-id` – The request identifier.
|
|
7278
|
+
#
|
|
7279
|
+
# * `status` – The request status. Valid values: `RECEIVED`,
|
|
7280
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`.
|
|
7052
7281
|
#
|
|
7053
7282
|
# @option params [String] :marker
|
|
7054
7283
|
# Specifies the unique pagination token that makes it possible to
|
|
@@ -7075,33 +7304,57 @@ module Aws::DatabaseMigrationService
|
|
|
7075
7304
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7076
7305
|
#
|
|
7077
7306
|
#
|
|
7078
|
-
# @example Example:
|
|
7307
|
+
# @example Example: Retrieve the status of metadata model assessments
|
|
7079
7308
|
#
|
|
7080
|
-
# #
|
|
7309
|
+
# # The following example retrieves the status of metadata model assessment operations identified by their request IDs.
|
|
7081
7310
|
#
|
|
7082
7311
|
# resp = client.describe_metadata_model_assessments({
|
|
7083
7312
|
# filters: [
|
|
7084
7313
|
# {
|
|
7085
|
-
# name: "
|
|
7314
|
+
# name: "request-id",
|
|
7086
7315
|
# values: [
|
|
7087
|
-
# "
|
|
7316
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7317
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
7318
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7088
7319
|
# ],
|
|
7089
7320
|
# },
|
|
7090
7321
|
# ],
|
|
7091
|
-
#
|
|
7092
|
-
# max_records: 20,
|
|
7093
|
-
# migration_project_identifier: "",
|
|
7322
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7094
7323
|
# })
|
|
7095
7324
|
#
|
|
7096
7325
|
# resp.to_h outputs the following:
|
|
7097
7326
|
# {
|
|
7098
|
-
# marker: "ASDLKJASDJKHDFHGDNBGDASKJHGFK",
|
|
7099
7327
|
# requests: [
|
|
7100
7328
|
# {
|
|
7101
|
-
# migration_project_arn: "arn:aws:dms:us-east-1:
|
|
7102
|
-
# request_identifier: "
|
|
7329
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7330
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7103
7331
|
# status: "SUCCESS",
|
|
7104
7332
|
# },
|
|
7333
|
+
# {
|
|
7334
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7335
|
+
# progress: {
|
|
7336
|
+
# processed_object: {
|
|
7337
|
+
# endpoint_type: "SOURCE",
|
|
7338
|
+
# name: "ExampleTable",
|
|
7339
|
+
# type: "table",
|
|
7340
|
+
# },
|
|
7341
|
+
# progress_percent: 50.0,
|
|
7342
|
+
# progress_step: "ANALYZING",
|
|
7343
|
+
# total_objects: 100,
|
|
7344
|
+
# },
|
|
7345
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
7346
|
+
# status: "IN_PROGRESS",
|
|
7347
|
+
# },
|
|
7348
|
+
# {
|
|
7349
|
+
# error: {
|
|
7350
|
+
# default_error_details: {
|
|
7351
|
+
# message: "No objects were found according to the specified selection rules. Please review your selection rules and try again.",
|
|
7352
|
+
# },
|
|
7353
|
+
# },
|
|
7354
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7355
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7356
|
+
# status: "FAILED",
|
|
7357
|
+
# },
|
|
7105
7358
|
# ],
|
|
7106
7359
|
# }
|
|
7107
7360
|
#
|
|
@@ -7153,15 +7406,32 @@ module Aws::DatabaseMigrationService
|
|
|
7153
7406
|
# Gets a list of child metadata models for the specified metadata model
|
|
7154
7407
|
# in the database hierarchy.
|
|
7155
7408
|
#
|
|
7409
|
+
# **Required permissions:** `dms:DescribeMetadataModelChildren`. For
|
|
7410
|
+
# more information, see [Actions, resources, and condition keys for
|
|
7411
|
+
# Database Migration Service][1].
|
|
7412
|
+
#
|
|
7413
|
+
#
|
|
7414
|
+
#
|
|
7415
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7416
|
+
#
|
|
7156
7417
|
# @option params [required, String] :selection_rules
|
|
7157
|
-
#
|
|
7158
|
-
# retrieve.
|
|
7159
|
-
#
|
|
7160
|
-
#
|
|
7418
|
+
# A JSON string that identifies the metadata model whose children to
|
|
7419
|
+
# retrieve. For the selection rule format and examples, see [Selection
|
|
7420
|
+
# rules in DMS Schema Conversion][1].
|
|
7421
|
+
#
|
|
7422
|
+
# Usage:
|
|
7423
|
+
#
|
|
7424
|
+
# * Accepts source or target selection rules depending on the `Origin`
|
|
7425
|
+
# parameter. The `server-name` in the object locator must match the
|
|
7426
|
+
# corresponding data provider.
|
|
7427
|
+
#
|
|
7428
|
+
# * Supports only `explicit` rule actions.
|
|
7161
7429
|
#
|
|
7430
|
+
# * Exactly one rule is allowed.
|
|
7162
7431
|
#
|
|
7163
7432
|
#
|
|
7164
|
-
#
|
|
7433
|
+
#
|
|
7434
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
7165
7435
|
#
|
|
7166
7436
|
# @option params [required, String] :migration_project_identifier
|
|
7167
7437
|
# The migration project name or Amazon Resource Name (ARN).
|
|
@@ -7189,6 +7459,39 @@ module Aws::DatabaseMigrationService
|
|
|
7189
7459
|
#
|
|
7190
7460
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7191
7461
|
#
|
|
7462
|
+
#
|
|
7463
|
+
# @example Example: Retrieve children of a schema
|
|
7464
|
+
#
|
|
7465
|
+
# # The following example retrieves the child metadata models of the ExampleSchema schema from the source metadata tree.
|
|
7466
|
+
#
|
|
7467
|
+
# resp = client.describe_metadata_model_children({
|
|
7468
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7469
|
+
# origin: "SOURCE",
|
|
7470
|
+
# selection_rules: "{\"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\"}]}",
|
|
7471
|
+
# })
|
|
7472
|
+
#
|
|
7473
|
+
# resp.to_h outputs the following:
|
|
7474
|
+
# {
|
|
7475
|
+
# metadata_model_children: [
|
|
7476
|
+
# {
|
|
7477
|
+
# metadata_model_name: "Tables",
|
|
7478
|
+
# selection_rules: "{\"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\"}]}",
|
|
7479
|
+
# },
|
|
7480
|
+
# {
|
|
7481
|
+
# metadata_model_name: "Views",
|
|
7482
|
+
# selection_rules: "{\"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\"}]}",
|
|
7483
|
+
# },
|
|
7484
|
+
# {
|
|
7485
|
+
# metadata_model_name: "Functions",
|
|
7486
|
+
# selection_rules: "{\"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\"}]}",
|
|
7487
|
+
# },
|
|
7488
|
+
# {
|
|
7489
|
+
# metadata_model_name: "Sequences",
|
|
7490
|
+
# selection_rules: "{\"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\"}]}",
|
|
7491
|
+
# },
|
|
7492
|
+
# ],
|
|
7493
|
+
# }
|
|
7494
|
+
#
|
|
7192
7495
|
# @example Request syntax with placeholder values
|
|
7193
7496
|
#
|
|
7194
7497
|
# resp = client.describe_metadata_model_children({
|
|
@@ -7215,15 +7518,34 @@ module Aws::DatabaseMigrationService
|
|
|
7215
7518
|
req.send_request(options)
|
|
7216
7519
|
end
|
|
7217
7520
|
|
|
7218
|
-
# Returns a paginated list of metadata model
|
|
7219
|
-
# project.
|
|
7521
|
+
# Returns a paginated list of metadata model conversion requests for a
|
|
7522
|
+
# migration project, initiated by [StartMetadataModelConversion][1].
|
|
7523
|
+
#
|
|
7524
|
+
# To cancel a queued or in-progress request, call
|
|
7525
|
+
# [CancelMetadataModelConversion][2].
|
|
7526
|
+
#
|
|
7527
|
+
# **Required permissions:** `dms:ListMetadataModelConversions`. For more
|
|
7528
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
7529
|
+
# Migration Service][3].
|
|
7530
|
+
#
|
|
7531
|
+
#
|
|
7532
|
+
#
|
|
7533
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelConversion.html
|
|
7534
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CancelMetadataModelConversion.html
|
|
7535
|
+
# [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7220
7536
|
#
|
|
7221
7537
|
# @option params [required, String] :migration_project_identifier
|
|
7222
7538
|
# The migration project name or Amazon Resource Name (ARN).
|
|
7223
7539
|
#
|
|
7224
7540
|
# @option params [Array<Types::Filter>] :filters
|
|
7225
|
-
#
|
|
7226
|
-
#
|
|
7541
|
+
# The filters to apply to the metadata model conversion requests.
|
|
7542
|
+
#
|
|
7543
|
+
# The following filter names are supported:
|
|
7544
|
+
#
|
|
7545
|
+
# * `request-id` – The request identifier.
|
|
7546
|
+
#
|
|
7547
|
+
# * `status` – The request status. Valid values: `RECEIVED`,
|
|
7548
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`, `CANCELING`, `CANCELED`.
|
|
7227
7549
|
#
|
|
7228
7550
|
# @option params [String] :marker
|
|
7229
7551
|
# Specifies the unique pagination token that makes it possible to
|
|
@@ -7250,33 +7572,57 @@ module Aws::DatabaseMigrationService
|
|
|
7250
7572
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7251
7573
|
#
|
|
7252
7574
|
#
|
|
7253
|
-
# @example Example:
|
|
7575
|
+
# @example Example: Retrieve the status of metadata model conversions
|
|
7254
7576
|
#
|
|
7255
|
-
# #
|
|
7577
|
+
# # The following example retrieves the status of metadata model conversion operations identified by their request IDs.
|
|
7256
7578
|
#
|
|
7257
7579
|
# resp = client.describe_metadata_model_conversions({
|
|
7258
7580
|
# filters: [
|
|
7259
7581
|
# {
|
|
7260
7582
|
# name: "request-id",
|
|
7261
7583
|
# values: [
|
|
7262
|
-
# "
|
|
7584
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7585
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
7586
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7263
7587
|
# ],
|
|
7264
7588
|
# },
|
|
7265
7589
|
# ],
|
|
7266
|
-
#
|
|
7267
|
-
# max_records: 123,
|
|
7268
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
|
|
7590
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7269
7591
|
# })
|
|
7270
7592
|
#
|
|
7271
7593
|
# resp.to_h outputs the following:
|
|
7272
7594
|
# {
|
|
7273
|
-
# marker: "0123456789abcdefghijklmnopqrs",
|
|
7274
7595
|
# requests: [
|
|
7275
7596
|
# {
|
|
7276
|
-
# migration_project_arn: "arn:aws:dms:us-east-1:
|
|
7277
|
-
# request_identifier: "
|
|
7597
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7598
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7278
7599
|
# status: "SUCCESS",
|
|
7279
7600
|
# },
|
|
7601
|
+
# {
|
|
7602
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7603
|
+
# progress: {
|
|
7604
|
+
# processed_object: {
|
|
7605
|
+
# endpoint_type: "SOURCE",
|
|
7606
|
+
# name: "ExampleTable",
|
|
7607
|
+
# type: "table",
|
|
7608
|
+
# },
|
|
7609
|
+
# progress_percent: 50.0,
|
|
7610
|
+
# progress_step: "CONVERTING",
|
|
7611
|
+
# total_objects: 100,
|
|
7612
|
+
# },
|
|
7613
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
7614
|
+
# status: "IN_PROGRESS",
|
|
7615
|
+
# },
|
|
7616
|
+
# {
|
|
7617
|
+
# error: {
|
|
7618
|
+
# default_error_details: {
|
|
7619
|
+
# message: "No objects were found according to the specified selection rules. Please review your selection rules and try again.",
|
|
7620
|
+
# },
|
|
7621
|
+
# },
|
|
7622
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7623
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7624
|
+
# status: "FAILED",
|
|
7625
|
+
# },
|
|
7280
7626
|
# ],
|
|
7281
7627
|
# }
|
|
7282
7628
|
#
|
|
@@ -7327,24 +7673,47 @@ module Aws::DatabaseMigrationService
|
|
|
7327
7673
|
end
|
|
7328
7674
|
|
|
7329
7675
|
# Returns a paginated list of metadata model creation requests for a
|
|
7330
|
-
# migration project.
|
|
7676
|
+
# migration project, initiated by [StartMetadataModelCreation][1].
|
|
7677
|
+
#
|
|
7678
|
+
# To cancel a queued or in-progress request, call
|
|
7679
|
+
# [CancelMetadataModelCreation][2].
|
|
7680
|
+
#
|
|
7681
|
+
# **Required permissions:** `dms:DescribeMetadataModelCreations`. For
|
|
7682
|
+
# more information, see [Actions, resources, and condition keys for
|
|
7683
|
+
# Database Migration Service][3].
|
|
7684
|
+
#
|
|
7685
|
+
#
|
|
7686
|
+
#
|
|
7687
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelCreation.html
|
|
7688
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CancelMetadataModelCreation.html
|
|
7689
|
+
# [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7331
7690
|
#
|
|
7332
7691
|
# @option params [Array<Types::Filter>] :filters
|
|
7333
|
-
#
|
|
7334
|
-
#
|
|
7335
|
-
#
|
|
7692
|
+
# The filters to apply to the metadata model creation requests.
|
|
7693
|
+
#
|
|
7694
|
+
# The following filter names are supported:
|
|
7695
|
+
#
|
|
7696
|
+
# * `request-id` – The request identifier.
|
|
7697
|
+
#
|
|
7698
|
+
# * `status` – The request status. Valid values: `RECEIVED`,
|
|
7699
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`, `CANCELING`, `CANCELED`.
|
|
7336
7700
|
#
|
|
7337
7701
|
# @option params [String] :marker
|
|
7338
7702
|
# Specifies the unique pagination token that makes it possible to
|
|
7339
|
-
# display the next page of
|
|
7340
|
-
#
|
|
7341
|
-
#
|
|
7703
|
+
# display the next page of results. If this parameter is specified, the
|
|
7704
|
+
# response includes only records beyond the marker, up to the value
|
|
7705
|
+
# specified by `MaxRecords`.
|
|
7706
|
+
#
|
|
7707
|
+
# If `Marker` is returned by a previous response, there are more results
|
|
7708
|
+
# available. The value of `Marker` is a unique pagination token for each
|
|
7709
|
+
# page. To retrieve the next page, make the call again using the
|
|
7710
|
+
# returned token and keeping all other arguments unchanged.
|
|
7342
7711
|
#
|
|
7343
7712
|
# @option params [Integer] :max_records
|
|
7344
|
-
# The maximum number of
|
|
7345
|
-
#
|
|
7346
|
-
#
|
|
7347
|
-
#
|
|
7713
|
+
# The maximum number of records to include in the response. If more
|
|
7714
|
+
# records exist than the specified `MaxRecords` value, DMS includes a
|
|
7715
|
+
# pagination token in the response so that you can retrieve the
|
|
7716
|
+
# remaining results.
|
|
7348
7717
|
#
|
|
7349
7718
|
# @option params [required, String] :migration_project_identifier
|
|
7350
7719
|
# The migration project name or Amazon Resource Name (ARN).
|
|
@@ -7356,6 +7725,51 @@ module Aws::DatabaseMigrationService
|
|
|
7356
7725
|
#
|
|
7357
7726
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7358
7727
|
#
|
|
7728
|
+
#
|
|
7729
|
+
# @example Example: Retrieve the status of metadata model creations
|
|
7730
|
+
#
|
|
7731
|
+
# # The following example retrieves the status of metadata model creation operations identified by their request IDs.
|
|
7732
|
+
#
|
|
7733
|
+
# resp = client.describe_metadata_model_creations({
|
|
7734
|
+
# filters: [
|
|
7735
|
+
# {
|
|
7736
|
+
# name: "request-id",
|
|
7737
|
+
# values: [
|
|
7738
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7739
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
7740
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7741
|
+
# ],
|
|
7742
|
+
# },
|
|
7743
|
+
# ],
|
|
7744
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7745
|
+
# })
|
|
7746
|
+
#
|
|
7747
|
+
# resp.to_h outputs the following:
|
|
7748
|
+
# {
|
|
7749
|
+
# requests: [
|
|
7750
|
+
# {
|
|
7751
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7752
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7753
|
+
# status: "SUCCESS",
|
|
7754
|
+
# },
|
|
7755
|
+
# {
|
|
7756
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7757
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
7758
|
+
# status: "IN_PROGRESS",
|
|
7759
|
+
# },
|
|
7760
|
+
# {
|
|
7761
|
+
# error: {
|
|
7762
|
+
# default_error_details: {
|
|
7763
|
+
# message: "No objects were found according to the specified selection rules. Please review your selection rules and try again.",
|
|
7764
|
+
# },
|
|
7765
|
+
# },
|
|
7766
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7767
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7768
|
+
# status: "FAILED",
|
|
7769
|
+
# },
|
|
7770
|
+
# ],
|
|
7771
|
+
# }
|
|
7772
|
+
#
|
|
7359
7773
|
# @example Request syntax with placeholder values
|
|
7360
7774
|
#
|
|
7361
7775
|
# resp = client.describe_metadata_model_creations({
|
|
@@ -7402,14 +7816,30 @@ module Aws::DatabaseMigrationService
|
|
|
7402
7816
|
req.send_request(options)
|
|
7403
7817
|
end
|
|
7404
7818
|
|
|
7405
|
-
# Returns a paginated list of metadata model
|
|
7819
|
+
# Returns a paginated list of metadata model export requests for a
|
|
7820
|
+
# migration project, initiated by [StartMetadataModelExportAsScript][1].
|
|
7821
|
+
#
|
|
7822
|
+
# **Required permissions:** `dms:ListMetadataModelExports`. For more
|
|
7823
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
7824
|
+
# Migration Service][2].
|
|
7825
|
+
#
|
|
7826
|
+
#
|
|
7827
|
+
#
|
|
7828
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelExportAsScript.html
|
|
7829
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7406
7830
|
#
|
|
7407
7831
|
# @option params [required, String] :migration_project_identifier
|
|
7408
7832
|
# The migration project name or Amazon Resource Name (ARN).
|
|
7409
7833
|
#
|
|
7410
7834
|
# @option params [Array<Types::Filter>] :filters
|
|
7411
|
-
#
|
|
7412
|
-
#
|
|
7835
|
+
# The filters to apply to the metadata model export requests.
|
|
7836
|
+
#
|
|
7837
|
+
# The following filter names are supported:
|
|
7838
|
+
#
|
|
7839
|
+
# * `request-id` – The request identifier.
|
|
7840
|
+
#
|
|
7841
|
+
# * `status` – The request status. Valid values: `RECEIVED`,
|
|
7842
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`.
|
|
7413
7843
|
#
|
|
7414
7844
|
# @option params [String] :marker
|
|
7415
7845
|
# Specifies the unique pagination token that makes it possible to
|
|
@@ -7436,33 +7866,60 @@ module Aws::DatabaseMigrationService
|
|
|
7436
7866
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7437
7867
|
#
|
|
7438
7868
|
#
|
|
7439
|
-
# @example Example:
|
|
7869
|
+
# @example Example: Retrieve the status of metadata model exports as script
|
|
7440
7870
|
#
|
|
7441
|
-
# #
|
|
7871
|
+
# # The following example retrieves the status of operations that export metadata models as data definition language (DDL)
|
|
7872
|
+
# # scripts, identified by their request IDs.
|
|
7442
7873
|
#
|
|
7443
7874
|
# resp = client.describe_metadata_model_exports_as_script({
|
|
7444
7875
|
# filters: [
|
|
7445
7876
|
# {
|
|
7446
7877
|
# name: "request-id",
|
|
7447
7878
|
# values: [
|
|
7448
|
-
# "
|
|
7879
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7880
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
7881
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7449
7882
|
# ],
|
|
7450
7883
|
# },
|
|
7451
7884
|
# ],
|
|
7452
|
-
#
|
|
7453
|
-
# max_records: 20,
|
|
7454
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
|
|
7885
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7455
7886
|
# })
|
|
7456
7887
|
#
|
|
7457
7888
|
# resp.to_h outputs the following:
|
|
7458
7889
|
# {
|
|
7459
|
-
# marker: "0123456789abcdefghijklmnopqrs",
|
|
7460
7890
|
# requests: [
|
|
7461
7891
|
# {
|
|
7462
|
-
#
|
|
7463
|
-
#
|
|
7892
|
+
# export_sql_details: {
|
|
7893
|
+
# object_url: "https://amzn-s3-demo-bucket.s3.us-east-1.amazonaws.com/example-migration-project/ExampleScript.zip",
|
|
7894
|
+
# s3_object_key: "s3://amzn-s3-demo-bucket/example-migration-project/ExampleScript.zip",
|
|
7895
|
+
# },
|
|
7896
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7897
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7464
7898
|
# status: "SUCCESS",
|
|
7465
7899
|
# },
|
|
7900
|
+
# {
|
|
7901
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7902
|
+
# progress: {
|
|
7903
|
+
# processed_object: {
|
|
7904
|
+
# endpoint_type: "TARGET",
|
|
7905
|
+
# },
|
|
7906
|
+
# progress_percent: 50.0,
|
|
7907
|
+
# progress_step: "IN_PROGRESS",
|
|
7908
|
+
# total_objects: 100,
|
|
7909
|
+
# },
|
|
7910
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
7911
|
+
# status: "IN_PROGRESS",
|
|
7912
|
+
# },
|
|
7913
|
+
# {
|
|
7914
|
+
# error: {
|
|
7915
|
+
# default_error_details: {
|
|
7916
|
+
# message: "No objects were found according to the specified selection rules. Please review your selection rules and try again.",
|
|
7917
|
+
# },
|
|
7918
|
+
# },
|
|
7919
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7920
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7921
|
+
# status: "FAILED",
|
|
7922
|
+
# },
|
|
7466
7923
|
# ],
|
|
7467
7924
|
# }
|
|
7468
7925
|
#
|
|
@@ -7511,14 +7968,30 @@ module Aws::DatabaseMigrationService
|
|
|
7511
7968
|
req.send_request(options)
|
|
7512
7969
|
end
|
|
7513
7970
|
|
|
7514
|
-
# Returns a paginated list of metadata model
|
|
7971
|
+
# Returns a paginated list of metadata model export requests for a
|
|
7972
|
+
# migration project, initiated by [StartMetadataModelExportToTarget][1].
|
|
7973
|
+
#
|
|
7974
|
+
# **Required permissions:** `dms:ListMetadataModelExports`. For more
|
|
7975
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
7976
|
+
# Migration Service][2].
|
|
7977
|
+
#
|
|
7978
|
+
#
|
|
7979
|
+
#
|
|
7980
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelExportToTarget.html
|
|
7981
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7515
7982
|
#
|
|
7516
7983
|
# @option params [required, String] :migration_project_identifier
|
|
7517
7984
|
# The migration project name or Amazon Resource Name (ARN).
|
|
7518
7985
|
#
|
|
7519
7986
|
# @option params [Array<Types::Filter>] :filters
|
|
7520
|
-
#
|
|
7521
|
-
#
|
|
7987
|
+
# The filters to apply to the metadata model export requests.
|
|
7988
|
+
#
|
|
7989
|
+
# The following filter names are supported:
|
|
7990
|
+
#
|
|
7991
|
+
# * `request-id` – The request identifier.
|
|
7992
|
+
#
|
|
7993
|
+
# * `status` – The request status. Valid values: `RECEIVED`,
|
|
7994
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`.
|
|
7522
7995
|
#
|
|
7523
7996
|
# @option params [String] :marker
|
|
7524
7997
|
# Specifies the unique pagination token that makes it possible to
|
|
@@ -7545,33 +8018,56 @@ module Aws::DatabaseMigrationService
|
|
|
7545
8018
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7546
8019
|
#
|
|
7547
8020
|
#
|
|
7548
|
-
# @example Example:
|
|
8021
|
+
# @example Example: Retrieve the status of metadata model exports to target
|
|
7549
8022
|
#
|
|
7550
|
-
# #
|
|
8023
|
+
# # The following example retrieves the status of operations that export converted metadata models to the target database,
|
|
8024
|
+
# # identified by their request IDs.
|
|
7551
8025
|
#
|
|
7552
8026
|
# resp = client.describe_metadata_model_exports_to_target({
|
|
7553
8027
|
# filters: [
|
|
7554
8028
|
# {
|
|
7555
8029
|
# name: "request-id",
|
|
7556
8030
|
# values: [
|
|
7557
|
-
# "
|
|
8031
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
8032
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
8033
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7558
8034
|
# ],
|
|
7559
8035
|
# },
|
|
7560
8036
|
# ],
|
|
7561
|
-
#
|
|
7562
|
-
# max_records: 20,
|
|
7563
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
|
|
8037
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7564
8038
|
# })
|
|
7565
8039
|
#
|
|
7566
8040
|
# resp.to_h outputs the following:
|
|
7567
8041
|
# {
|
|
7568
|
-
# marker: "0123456789abcdefghijklmnopqrs",
|
|
7569
8042
|
# requests: [
|
|
7570
8043
|
# {
|
|
7571
|
-
# migration_project_arn: "arn:aws:dms:us-east-1:
|
|
7572
|
-
# request_identifier: "
|
|
8044
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8045
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7573
8046
|
# status: "SUCCESS",
|
|
7574
8047
|
# },
|
|
8048
|
+
# {
|
|
8049
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8050
|
+
# progress: {
|
|
8051
|
+
# processed_object: {
|
|
8052
|
+
# endpoint_type: "TARGET",
|
|
8053
|
+
# },
|
|
8054
|
+
# progress_percent: 50.0,
|
|
8055
|
+
# progress_step: "APPLYING",
|
|
8056
|
+
# total_objects: 100,
|
|
8057
|
+
# },
|
|
8058
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
8059
|
+
# status: "IN_PROGRESS",
|
|
8060
|
+
# },
|
|
8061
|
+
# {
|
|
8062
|
+
# error: {
|
|
8063
|
+
# default_error_details: {
|
|
8064
|
+
# message: "No objects were found according to the specified selection rules. Please review your selection rules and try again.",
|
|
8065
|
+
# },
|
|
8066
|
+
# },
|
|
8067
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8068
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
8069
|
+
# status: "FAILED",
|
|
8070
|
+
# },
|
|
7575
8071
|
# ],
|
|
7576
8072
|
# }
|
|
7577
8073
|
#
|
|
@@ -7620,14 +8116,30 @@ module Aws::DatabaseMigrationService
|
|
|
7620
8116
|
req.send_request(options)
|
|
7621
8117
|
end
|
|
7622
8118
|
|
|
7623
|
-
# Returns a paginated list of metadata model
|
|
8119
|
+
# Returns a paginated list of metadata model import requests for a
|
|
8120
|
+
# migration project, initiated by [StartMetadataModelImport][1].
|
|
8121
|
+
#
|
|
8122
|
+
# **Required permissions:** `dms:DescribeMetadataModelImports`. For more
|
|
8123
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
8124
|
+
# Migration Service][2].
|
|
8125
|
+
#
|
|
8126
|
+
#
|
|
8127
|
+
#
|
|
8128
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelImport.html
|
|
8129
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
7624
8130
|
#
|
|
7625
8131
|
# @option params [required, String] :migration_project_identifier
|
|
7626
8132
|
# The migration project name or Amazon Resource Name (ARN).
|
|
7627
8133
|
#
|
|
7628
8134
|
# @option params [Array<Types::Filter>] :filters
|
|
7629
|
-
#
|
|
7630
|
-
#
|
|
8135
|
+
# The filters to apply to the metadata model import requests.
|
|
8136
|
+
#
|
|
8137
|
+
# The following filter names are supported:
|
|
8138
|
+
#
|
|
8139
|
+
# * `request-id` – The request identifier.
|
|
8140
|
+
#
|
|
8141
|
+
# * `status` – The request status. Valid values: `RECEIVED`,
|
|
8142
|
+
# `IN_PROGRESS`, `SUCCESS`, `FAILED`.
|
|
7631
8143
|
#
|
|
7632
8144
|
# @option params [String] :marker
|
|
7633
8145
|
# Specifies the unique pagination token that makes it possible to
|
|
@@ -7641,7 +8153,10 @@ module Aws::DatabaseMigrationService
|
|
|
7641
8153
|
# returned token and keeping all other arguments unchanged.
|
|
7642
8154
|
#
|
|
7643
8155
|
# @option params [Integer] :max_records
|
|
7644
|
-
#
|
|
8156
|
+
# The maximum number of records to include in the response. If more
|
|
8157
|
+
# records exist than the specified `MaxRecords` value, DMS includes a
|
|
8158
|
+
# pagination token in the response so that you can retrieve the
|
|
8159
|
+
# remaining results.
|
|
7645
8160
|
#
|
|
7646
8161
|
# @return [Types::DescribeMetadataModelImportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7647
8162
|
#
|
|
@@ -7651,33 +8166,55 @@ module Aws::DatabaseMigrationService
|
|
|
7651
8166
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7652
8167
|
#
|
|
7653
8168
|
#
|
|
7654
|
-
# @example Example:
|
|
8169
|
+
# @example Example: Retrieve the status of metadata model imports
|
|
7655
8170
|
#
|
|
7656
|
-
# #
|
|
8171
|
+
# # The following example retrieves the status of metadata import operations identified by their request IDs.
|
|
7657
8172
|
#
|
|
7658
8173
|
# resp = client.describe_metadata_model_imports({
|
|
7659
8174
|
# filters: [
|
|
7660
8175
|
# {
|
|
7661
8176
|
# name: "request-id",
|
|
7662
8177
|
# values: [
|
|
7663
|
-
# "
|
|
8178
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
8179
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
8180
|
+
# "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
7664
8181
|
# ],
|
|
7665
8182
|
# },
|
|
7666
8183
|
# ],
|
|
7667
|
-
#
|
|
7668
|
-
# max_records: 20,
|
|
7669
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012",
|
|
8184
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7670
8185
|
# })
|
|
7671
8186
|
#
|
|
7672
8187
|
# resp.to_h outputs the following:
|
|
7673
8188
|
# {
|
|
7674
|
-
# marker: "0123456789abcdefghijklmnopqrs",
|
|
7675
8189
|
# requests: [
|
|
7676
8190
|
# {
|
|
7677
|
-
# migration_project_arn: "arn:aws:dms:us-east-1:
|
|
7678
|
-
# request_identifier: "
|
|
8191
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8192
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
7679
8193
|
# status: "SUCCESS",
|
|
7680
8194
|
# },
|
|
8195
|
+
# {
|
|
8196
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8197
|
+
# progress: {
|
|
8198
|
+
# processed_object: {
|
|
8199
|
+
# endpoint_type: "SOURCE",
|
|
8200
|
+
# },
|
|
8201
|
+
# progress_percent: 50.0,
|
|
8202
|
+
# progress_step: "IN_PROGRESS",
|
|
8203
|
+
# total_objects: 100,
|
|
8204
|
+
# },
|
|
8205
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
|
8206
|
+
# status: "IN_PROGRESS",
|
|
8207
|
+
# },
|
|
8208
|
+
# {
|
|
8209
|
+
# error: {
|
|
8210
|
+
# default_error_details: {
|
|
8211
|
+
# message: "No objects were found according to the specified selection rules. Please review your selection rules and try again.",
|
|
8212
|
+
# },
|
|
8213
|
+
# },
|
|
8214
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8215
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
|
8216
|
+
# status: "FAILED",
|
|
8217
|
+
# },
|
|
7681
8218
|
# ],
|
|
7682
8219
|
# }
|
|
7683
8220
|
#
|
|
@@ -7729,17 +8266,31 @@ module Aws::DatabaseMigrationService
|
|
|
7729
8266
|
# Returns a paginated list of migration projects for your account in the
|
|
7730
8267
|
# current region.
|
|
7731
8268
|
#
|
|
8269
|
+
# **Required permissions:** `dms:ListMigrationProjects`. For more
|
|
8270
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
8271
|
+
# Migration Service][1].
|
|
8272
|
+
#
|
|
8273
|
+
#
|
|
8274
|
+
#
|
|
8275
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
8276
|
+
#
|
|
7732
8277
|
# @option params [Array<Types::Filter>] :filters
|
|
7733
|
-
#
|
|
7734
|
-
# key-value pairs.
|
|
8278
|
+
# The filters to apply to the migration projects.
|
|
7735
8279
|
#
|
|
7736
|
-
#
|
|
8280
|
+
# The following filter names are supported:
|
|
7737
8281
|
#
|
|
7738
|
-
# *
|
|
8282
|
+
# * `migration-project-identifier` – The migration project name or ARN.
|
|
7739
8283
|
#
|
|
7740
|
-
# *
|
|
8284
|
+
# * `instance-profile-identifier` – The instance profile name or ARN.
|
|
7741
8285
|
#
|
|
7742
|
-
# *
|
|
8286
|
+
# * `data-provider-identifier` – The source or target data provider name
|
|
8287
|
+
# or ARN.
|
|
8288
|
+
#
|
|
8289
|
+
# * `source-data-provider-identifier` – The source data provider name or
|
|
8290
|
+
# ARN.
|
|
8291
|
+
#
|
|
8292
|
+
# * `target-data-provider-identifier` – The target data provider name or
|
|
8293
|
+
# ARN.
|
|
7743
8294
|
#
|
|
7744
8295
|
# @option params [Integer] :max_records
|
|
7745
8296
|
# The maximum number of records to include in the response. If more
|
|
@@ -7766,53 +8317,52 @@ module Aws::DatabaseMigrationService
|
|
|
7766
8317
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
7767
8318
|
#
|
|
7768
8319
|
#
|
|
7769
|
-
# @example Example: Describe
|
|
8320
|
+
# @example Example: Describe migration projects with a filter
|
|
7770
8321
|
#
|
|
7771
|
-
# #
|
|
8322
|
+
# # The following example retrieves the details of a migration project identified by its ARN.
|
|
7772
8323
|
#
|
|
7773
8324
|
# resp = client.describe_migration_projects({
|
|
7774
8325
|
# filters: [
|
|
7775
8326
|
# {
|
|
7776
8327
|
# name: "migration-project-identifier",
|
|
7777
8328
|
# values: [
|
|
7778
|
-
# "arn:aws:dms:us-east-1:
|
|
8329
|
+
# "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
7779
8330
|
# ],
|
|
7780
8331
|
# },
|
|
7781
8332
|
# ],
|
|
7782
|
-
# marker: "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ123456",
|
|
7783
|
-
# max_records: 20,
|
|
7784
8333
|
# })
|
|
7785
8334
|
#
|
|
7786
8335
|
# resp.to_h outputs the following:
|
|
7787
8336
|
# {
|
|
7788
|
-
# marker: "0123456789abcdefghijklmnopqrs",
|
|
7789
8337
|
# migration_projects: [
|
|
7790
8338
|
# {
|
|
7791
|
-
#
|
|
7792
|
-
#
|
|
7793
|
-
#
|
|
7794
|
-
#
|
|
7795
|
-
#
|
|
8339
|
+
# description: "Example migration project for documentation",
|
|
8340
|
+
# instance_profile_arn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8341
|
+
# instance_profile_name: "example-instance-profile",
|
|
8342
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8343
|
+
# migration_project_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
8344
|
+
# migration_project_name: "example-migration-project",
|
|
7796
8345
|
# schema_conversion_application_attributes: {
|
|
7797
|
-
# s3_bucket_path: "
|
|
7798
|
-
# s3_bucket_role_arn: "arn:aws:iam::
|
|
8346
|
+
# s3_bucket_path: "s3://amzn-s3-demo-bucket",
|
|
8347
|
+
# s3_bucket_role_arn: "arn:aws:iam::111122223333:role/example-s3-access-role",
|
|
7799
8348
|
# },
|
|
7800
8349
|
# source_data_provider_descriptors: [
|
|
7801
8350
|
# {
|
|
7802
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
7803
|
-
# data_provider_name: "
|
|
7804
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
7805
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
8351
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8352
|
+
# data_provider_name: "example-data-provider",
|
|
8353
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
8354
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3",
|
|
7806
8355
|
# },
|
|
7807
8356
|
# ],
|
|
7808
8357
|
# target_data_provider_descriptors: [
|
|
7809
8358
|
# {
|
|
7810
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
7811
|
-
# data_provider_name: "
|
|
7812
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
7813
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
8359
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
8360
|
+
# data_provider_name: "example-data-provider",
|
|
8361
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
8362
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3",
|
|
7814
8363
|
# },
|
|
7815
8364
|
# ],
|
|
8365
|
+
# transformation_rules: "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
|
|
7816
8366
|
# },
|
|
7817
8367
|
# ],
|
|
7818
8368
|
# }
|
|
@@ -9308,11 +9858,32 @@ module Aws::DatabaseMigrationService
|
|
|
9308
9858
|
# S3 bucket. DMS can save your assessment report as a comma-separated
|
|
9309
9859
|
# value (CSV) or a PDF file.
|
|
9310
9860
|
#
|
|
9861
|
+
# **Required permissions:** `dms:ExportMetadataModelAssessment`. For
|
|
9862
|
+
# more information, see [Actions, resources, and condition keys for
|
|
9863
|
+
# Database Migration Service][1].
|
|
9864
|
+
#
|
|
9865
|
+
#
|
|
9866
|
+
#
|
|
9867
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
9868
|
+
#
|
|
9311
9869
|
# @option params [required, String] :migration_project_identifier
|
|
9312
9870
|
# The migration project name or Amazon Resource Name (ARN).
|
|
9313
9871
|
#
|
|
9314
9872
|
# @option params [required, String] :selection_rules
|
|
9315
|
-
# A
|
|
9873
|
+
# A JSON string that identifies the metadata models to export a
|
|
9874
|
+
# conversion assessment report for. For the selection rule format and
|
|
9875
|
+
# examples, see [Selection rules in DMS Schema Conversion][1].
|
|
9876
|
+
#
|
|
9877
|
+
# Usage:
|
|
9878
|
+
#
|
|
9879
|
+
# * Accepts only source selection rules, where `server-name` in the
|
|
9880
|
+
# object locator matches the source data provider.
|
|
9881
|
+
#
|
|
9882
|
+
# * Supports only `explicit` rule actions.
|
|
9883
|
+
#
|
|
9884
|
+
#
|
|
9885
|
+
#
|
|
9886
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
9316
9887
|
#
|
|
9317
9888
|
# @option params [String] :file_name
|
|
9318
9889
|
# The name of the assessment file to create in your Amazon S3 bucket.
|
|
@@ -9326,29 +9897,29 @@ module Aws::DatabaseMigrationService
|
|
|
9326
9897
|
# * {Types::ExportMetadataModelAssessmentResponse#csv_report #csv_report} => Types::ExportMetadataModelAssessmentResultEntry
|
|
9327
9898
|
#
|
|
9328
9899
|
#
|
|
9329
|
-
# @example Example: Export
|
|
9900
|
+
# @example Example: Export a conversion assessment report
|
|
9330
9901
|
#
|
|
9331
|
-
# #
|
|
9332
|
-
# # comma-separated value (CSV) or a PDF file.
|
|
9902
|
+
# # The following example exports a conversion assessment report for all objects in the ExampleSchema schema.
|
|
9333
9903
|
#
|
|
9334
9904
|
# resp = client.export_metadata_model_assessment({
|
|
9335
9905
|
# assessment_report_types: [
|
|
9336
9906
|
# "pdf",
|
|
9907
|
+
# "csv",
|
|
9337
9908
|
# ],
|
|
9338
|
-
# file_name: "
|
|
9339
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
9340
|
-
# selection_rules: "{\"rules\": [{\"rule-type\": \"selection\"
|
|
9909
|
+
# file_name: "example-assessment-report",
|
|
9910
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
9911
|
+
# selection_rules: "{\"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\"}]}",
|
|
9341
9912
|
# })
|
|
9342
9913
|
#
|
|
9343
9914
|
# resp.to_h outputs the following:
|
|
9344
9915
|
# {
|
|
9345
9916
|
# csv_report: {
|
|
9346
|
-
# object_url: "
|
|
9347
|
-
# s3_object_key: "
|
|
9917
|
+
# object_url: "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.zip",
|
|
9918
|
+
# s3_object_key: "example-migration-project/example-assessment-report.zip",
|
|
9348
9919
|
# },
|
|
9349
9920
|
# pdf_report: {
|
|
9350
|
-
# object_url: "
|
|
9351
|
-
# s3_object_key: "
|
|
9921
|
+
# object_url: "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.pdf",
|
|
9922
|
+
# s3_object_key: "example-migration-project/example-assessment-report.pdf",
|
|
9352
9923
|
# },
|
|
9353
9924
|
# }
|
|
9354
9925
|
#
|
|
@@ -9380,19 +9951,57 @@ module Aws::DatabaseMigrationService
|
|
|
9380
9951
|
# Converts source selection rules into their target counterparts for
|
|
9381
9952
|
# schema conversion operations.
|
|
9382
9953
|
#
|
|
9954
|
+
# **Required permissions:** `dms:GetTargetSelectionRules`. For more
|
|
9955
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
9956
|
+
# Migration Service][1].
|
|
9957
|
+
#
|
|
9958
|
+
#
|
|
9959
|
+
#
|
|
9960
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
9961
|
+
#
|
|
9383
9962
|
# @option params [required, String] :migration_project_identifier
|
|
9384
9963
|
# The migration project name or Amazon Resource Name (ARN).
|
|
9385
9964
|
#
|
|
9386
9965
|
# @option params [required, String] :selection_rules
|
|
9387
|
-
#
|
|
9388
|
-
#
|
|
9389
|
-
#
|
|
9390
|
-
#
|
|
9966
|
+
# A JSON string that contains the source selection rules to convert into
|
|
9967
|
+
# their target counterparts. For the selection rule format and examples,
|
|
9968
|
+
# see [Selection rules in DMS Schema Conversion][1].
|
|
9969
|
+
#
|
|
9970
|
+
# Usage:
|
|
9971
|
+
#
|
|
9972
|
+
# * Accepts only source selection rules, where `server-name` in the
|
|
9973
|
+
# object locator matches the source data provider.
|
|
9974
|
+
#
|
|
9975
|
+
# * Supports only `explicit` rule actions.
|
|
9976
|
+
#
|
|
9977
|
+
# * Does not support `category-name` in the object locator.
|
|
9978
|
+
#
|
|
9979
|
+
# * Up to 10 rules are allowed.
|
|
9980
|
+
#
|
|
9981
|
+
#
|
|
9982
|
+
#
|
|
9983
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
9391
9984
|
#
|
|
9392
9985
|
# @return [Types::GetTargetSelectionRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
9393
9986
|
#
|
|
9394
9987
|
# * {Types::GetTargetSelectionRulesResponse#target_selection_rules #target_selection_rules} => String
|
|
9395
9988
|
#
|
|
9989
|
+
#
|
|
9990
|
+
# @example Example: Convert source selection rules to target selection rules
|
|
9991
|
+
#
|
|
9992
|
+
# # The following example converts source selection rules that select the ExampleTable table in the ExampleSchema schema
|
|
9993
|
+
# # into target selection rules that reference its converted counterpart.
|
|
9994
|
+
#
|
|
9995
|
+
# resp = client.get_target_selection_rules({
|
|
9996
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
9997
|
+
# selection_rules: "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": {\"server-name\": \"example-source-server.us-east-1.rds.amazonaws.com\", \"database-name\": \"ExampleDatabase\", \"schema-name\": \"ExampleSchema\", \"table-name\": \"ExampleTable\"}, \"rule-action\": \"explicit\"}]}",
|
|
9998
|
+
# })
|
|
9999
|
+
#
|
|
10000
|
+
# resp.to_h outputs the following:
|
|
10001
|
+
# {
|
|
10002
|
+
# target_selection_rules: "{\"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\": \"exampledatabase_exampleschema\", \"table-name\": \"exampletable\"}, \"rule-action\": \"explicit\"}]}",
|
|
10003
|
+
# }
|
|
10004
|
+
#
|
|
9396
10005
|
# @example Request syntax with placeholder values
|
|
9397
10006
|
#
|
|
9398
10007
|
# resp = client.get_target_selection_rules({
|
|
@@ -9568,29 +10177,51 @@ module Aws::DatabaseMigrationService
|
|
|
9568
10177
|
# Modifies the specified schema conversion configuration using the
|
|
9569
10178
|
# provided parameters.
|
|
9570
10179
|
#
|
|
10180
|
+
# **Required permissions:** `dms:UpdateConversionConfiguration`. For
|
|
10181
|
+
# more information, see [Actions, resources, and condition keys for
|
|
10182
|
+
# Database Migration Service][1].
|
|
10183
|
+
#
|
|
10184
|
+
#
|
|
10185
|
+
#
|
|
10186
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
10187
|
+
#
|
|
9571
10188
|
# @option params [required, String] :migration_project_identifier
|
|
9572
10189
|
# The migration project name or Amazon Resource Name (ARN).
|
|
9573
10190
|
#
|
|
9574
10191
|
# @option params [required, String] :conversion_configuration
|
|
9575
|
-
#
|
|
10192
|
+
# A JSON string that contains the schema conversion settings to update.
|
|
10193
|
+
# For the format and available settings, see [Specifying schema
|
|
10194
|
+
# conversion settings for migration projects][1].
|
|
10195
|
+
#
|
|
10196
|
+
# Usage:
|
|
10197
|
+
#
|
|
10198
|
+
# * Include only the sections and keys to change. The operation merges
|
|
10199
|
+
# supplied values with the existing configuration.
|
|
10200
|
+
#
|
|
10201
|
+
# ^
|
|
10202
|
+
#
|
|
10203
|
+
#
|
|
10204
|
+
#
|
|
10205
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-settings.html
|
|
9576
10206
|
#
|
|
9577
10207
|
# @return [Types::ModifyConversionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
9578
10208
|
#
|
|
9579
10209
|
# * {Types::ModifyConversionConfigurationResponse#migration_project_identifier #migration_project_identifier} => String
|
|
9580
10210
|
#
|
|
9581
10211
|
#
|
|
9582
|
-
# @example Example:
|
|
10212
|
+
# @example Example: Modifying conversion configuration for a migration project
|
|
9583
10213
|
#
|
|
9584
|
-
# #
|
|
10214
|
+
# # The following example enables generative AI assisted conversion and updates a conversion pair setting for a migration
|
|
10215
|
+
# # project.
|
|
9585
10216
|
#
|
|
9586
10217
|
# resp = client.modify_conversion_configuration({
|
|
9587
|
-
# conversion_configuration: "{\"Common project settings\":{\"
|
|
9588
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
10218
|
+
# conversion_configuration: "{\"Common project settings\":{\"EnableGenAiConversion\":true},\"MSSQL_TO_AURORA_POSTGRESQL\":{\"ConvertProceduresToFunction\":false}}",
|
|
10219
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
9589
10220
|
# })
|
|
9590
10221
|
#
|
|
9591
10222
|
# resp.to_h outputs the following:
|
|
9592
10223
|
# {
|
|
9593
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
10224
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
9594
10225
|
# }
|
|
9595
10226
|
#
|
|
9596
10227
|
# @example Request syntax with placeholder values
|
|
@@ -9723,11 +10354,19 @@ module Aws::DatabaseMigrationService
|
|
|
9723
10354
|
|
|
9724
10355
|
# Modifies the specified data provider using the provided settings.
|
|
9725
10356
|
#
|
|
10357
|
+
# **Required permissions:** `dms:UpdateDataProvider`. For more
|
|
10358
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
10359
|
+
# Migration Service][1].
|
|
10360
|
+
#
|
|
9726
10361
|
# <note markdown="1"> You must remove the data provider from all migration projects before
|
|
9727
10362
|
# you can modify it.
|
|
9728
10363
|
#
|
|
9729
10364
|
# </note>
|
|
9730
10365
|
#
|
|
10366
|
+
#
|
|
10367
|
+
#
|
|
10368
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
10369
|
+
#
|
|
9731
10370
|
# @option params [required, String] :data_provider_identifier
|
|
9732
10371
|
# The identifier of the data provider. Identifiers must begin with a
|
|
9733
10372
|
# letter and must contain only ASCII letters, digits, and hyphens. They
|
|
@@ -9740,10 +10379,11 @@ module Aws::DatabaseMigrationService
|
|
|
9740
10379
|
# A user-friendly description of the data provider.
|
|
9741
10380
|
#
|
|
9742
10381
|
# @option params [String] :engine
|
|
9743
|
-
# The type of database engine for the data provider.
|
|
9744
|
-
#
|
|
9745
|
-
#
|
|
9746
|
-
# `
|
|
10382
|
+
# The type of database engine for the data provider.
|
|
10383
|
+
#
|
|
10384
|
+
# Valid values: `aurora`, `aurora-postgresql`, `db2`, `db2-zos`,
|
|
10385
|
+
# `docdb`, `mariadb`, `mongodb`, `mysql`, `oracle`, `postgres`,
|
|
10386
|
+
# `redshift`, `sqlserver`, and `sybase`. A value of `aurora` represents
|
|
9747
10387
|
# Amazon Aurora MySQL-Compatible Edition.
|
|
9748
10388
|
#
|
|
9749
10389
|
# @option params [Boolean] :virtual
|
|
@@ -9769,21 +10409,17 @@ module Aws::DatabaseMigrationService
|
|
|
9769
10409
|
# * {Types::ModifyDataProviderResponse#data_provider #data_provider} => Types::DataProvider
|
|
9770
10410
|
#
|
|
9771
10411
|
#
|
|
9772
|
-
# @example Example: Modify
|
|
10412
|
+
# @example Example: Modify a data provider
|
|
9773
10413
|
#
|
|
9774
|
-
# #
|
|
10414
|
+
# # The following example updates the description and server name of a data provider.
|
|
9775
10415
|
#
|
|
9776
10416
|
# resp = client.modify_data_provider({
|
|
9777
|
-
# data_provider_identifier: "arn:aws:dms:us-east-1:
|
|
9778
|
-
#
|
|
9779
|
-
# description: "description",
|
|
10417
|
+
# data_provider_identifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
10418
|
+
# description: "Updated data provider description",
|
|
9780
10419
|
# engine: "sqlserver",
|
|
9781
10420
|
# settings: {
|
|
9782
10421
|
# microsoft_sql_server_settings: {
|
|
9783
|
-
#
|
|
9784
|
-
# port: 11112,
|
|
9785
|
-
# server_name: "ServerName2",
|
|
9786
|
-
# ssl_mode: "none",
|
|
10422
|
+
# server_name: "new-source-server.us-east-1.rds.amazonaws.com",
|
|
9787
10423
|
# },
|
|
9788
10424
|
# },
|
|
9789
10425
|
# })
|
|
@@ -9791,16 +10427,18 @@ module Aws::DatabaseMigrationService
|
|
|
9791
10427
|
# resp.to_h outputs the following:
|
|
9792
10428
|
# {
|
|
9793
10429
|
# data_provider: {
|
|
9794
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
9795
|
-
# data_provider_creation_time: Time.parse("
|
|
9796
|
-
# data_provider_name: "
|
|
9797
|
-
#
|
|
10430
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
10431
|
+
# data_provider_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
10432
|
+
# data_provider_name: "example-data-provider",
|
|
10433
|
+
# description: "Updated data provider description",
|
|
10434
|
+
# engine: "sqlserver",
|
|
9798
10435
|
# settings: {
|
|
9799
|
-
#
|
|
9800
|
-
#
|
|
9801
|
-
#
|
|
9802
|
-
#
|
|
9803
|
-
#
|
|
10436
|
+
# microsoft_sql_server_settings: {
|
|
10437
|
+
# certificate_arn: "arn:aws:dms:us-east-1:111122223333:cert:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
10438
|
+
# database_name: "ExampleDatabase",
|
|
10439
|
+
# port: 1433,
|
|
10440
|
+
# server_name: "new-source-server.us-east-1.rds.amazonaws.com",
|
|
10441
|
+
# ssl_mode: "verify-full",
|
|
9804
10442
|
# },
|
|
9805
10443
|
# },
|
|
9806
10444
|
# },
|
|
@@ -11071,11 +11709,19 @@ module Aws::DatabaseMigrationService
|
|
|
11071
11709
|
|
|
11072
11710
|
# Modifies the specified instance profile using the provided parameters.
|
|
11073
11711
|
#
|
|
11712
|
+
# **Required permissions:** `dms:UpdateInstanceProfile`. For more
|
|
11713
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
11714
|
+
# Migration Service][1].
|
|
11715
|
+
#
|
|
11074
11716
|
# <note markdown="1"> All migration projects associated with the instance profile must be
|
|
11075
11717
|
# deleted or modified before you can modify the instance profile.
|
|
11076
11718
|
#
|
|
11077
11719
|
# </note>
|
|
11078
11720
|
#
|
|
11721
|
+
#
|
|
11722
|
+
#
|
|
11723
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
11724
|
+
#
|
|
11079
11725
|
# @option params [required, String] :instance_profile_identifier
|
|
11080
11726
|
# The identifier of the instance profile. Identifiers must begin with a
|
|
11081
11727
|
# letter and must contain only ASCII letters, digits, and hyphens. They
|
|
@@ -11125,34 +11771,29 @@ module Aws::DatabaseMigrationService
|
|
|
11125
11771
|
# * {Types::ModifyInstanceProfileResponse#instance_profile #instance_profile} => Types::InstanceProfile
|
|
11126
11772
|
#
|
|
11127
11773
|
#
|
|
11128
|
-
# @example Example: Modify
|
|
11774
|
+
# @example Example: Modify an instance profile
|
|
11129
11775
|
#
|
|
11130
|
-
# #
|
|
11776
|
+
# # The following example updates the description and network type of an instance profile.
|
|
11131
11777
|
#
|
|
11132
11778
|
# resp = client.modify_instance_profile({
|
|
11133
|
-
#
|
|
11134
|
-
#
|
|
11135
|
-
#
|
|
11136
|
-
# instance_profile_name: "",
|
|
11137
|
-
# kms_key_arn: "",
|
|
11138
|
-
# network_type: "",
|
|
11139
|
-
# publicly_accessible: true,
|
|
11140
|
-
# subnet_group_identifier: "",
|
|
11141
|
-
# vpc_security_groups: [
|
|
11142
|
-
# ],
|
|
11779
|
+
# description: "Updated instance profile description",
|
|
11780
|
+
# instance_profile_identifier: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
11781
|
+
# network_type: "DUAL",
|
|
11143
11782
|
# })
|
|
11144
11783
|
#
|
|
11145
11784
|
# resp.to_h outputs the following:
|
|
11146
11785
|
# {
|
|
11147
11786
|
# instance_profile: {
|
|
11148
|
-
#
|
|
11149
|
-
#
|
|
11150
|
-
#
|
|
11151
|
-
#
|
|
11152
|
-
#
|
|
11153
|
-
#
|
|
11787
|
+
# description: "Updated instance profile description",
|
|
11788
|
+
# instance_profile_arn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
11789
|
+
# instance_profile_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
11790
|
+
# instance_profile_name: "example-instance-profile",
|
|
11791
|
+
# kms_key_arn: "arn:aws:kms:us-east-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
11792
|
+
# network_type: "DUAL",
|
|
11793
|
+
# publicly_accessible: false,
|
|
11794
|
+
# subnet_group_identifier: "example-replication-subnet-group",
|
|
11154
11795
|
# vpc_security_groups: [
|
|
11155
|
-
# "sg-
|
|
11796
|
+
# "sg-0123456789abcdef0",
|
|
11156
11797
|
# ],
|
|
11157
11798
|
# },
|
|
11158
11799
|
# }
|
|
@@ -11197,10 +11838,18 @@ module Aws::DatabaseMigrationService
|
|
|
11197
11838
|
# Modifies the specified migration project using the provided
|
|
11198
11839
|
# parameters.
|
|
11199
11840
|
#
|
|
11841
|
+
# **Required permissions:** `dms:UpdateMigrationProject`. For more
|
|
11842
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
11843
|
+
# Migration Service][1].
|
|
11844
|
+
#
|
|
11200
11845
|
# <note markdown="1"> The migration project must be closed before you can modify it.
|
|
11201
11846
|
#
|
|
11202
11847
|
# </note>
|
|
11203
11848
|
#
|
|
11849
|
+
#
|
|
11850
|
+
#
|
|
11851
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
11852
|
+
#
|
|
11204
11853
|
# @option params [required, String] :migration_project_identifier
|
|
11205
11854
|
# The identifier of the migration project. Identifiers must begin with a
|
|
11206
11855
|
# letter and must contain only ASCII letters, digits, and hyphens. They
|
|
@@ -11221,11 +11870,20 @@ module Aws::DatabaseMigrationService
|
|
|
11221
11870
|
# The name or Amazon Resource Name (ARN) for the instance profile.
|
|
11222
11871
|
#
|
|
11223
11872
|
# @option params [String] :transformation_rules
|
|
11224
|
-
#
|
|
11225
|
-
#
|
|
11226
|
-
#
|
|
11227
|
-
#
|
|
11228
|
-
#
|
|
11873
|
+
# A JSON string that specifies the transformation rules for the
|
|
11874
|
+
# migration project. Transformation rules let you customize how DMS
|
|
11875
|
+
# Schema Conversion converts your source database objects, including
|
|
11876
|
+
# renaming, adding prefixes or suffixes, and changing data types. For
|
|
11877
|
+
# the transformation rule format and examples, see [Transformation rules
|
|
11878
|
+
# in DMS Schema Conversion][1].
|
|
11879
|
+
#
|
|
11880
|
+
# <note markdown="1"> Homogeneous data migrations do not support transformation rules.
|
|
11881
|
+
#
|
|
11882
|
+
# </note>
|
|
11883
|
+
#
|
|
11884
|
+
#
|
|
11885
|
+
#
|
|
11886
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-transformation-rules.html
|
|
11229
11887
|
#
|
|
11230
11888
|
# @option params [String] :description
|
|
11231
11889
|
# A user-friendly description of the migration project.
|
|
@@ -11239,31 +11897,16 @@ module Aws::DatabaseMigrationService
|
|
|
11239
11897
|
# * {Types::ModifyMigrationProjectResponse#migration_project #migration_project} => Types::MigrationProject
|
|
11240
11898
|
#
|
|
11241
11899
|
#
|
|
11242
|
-
# @example Example: Modify
|
|
11900
|
+
# @example Example: Modify a migration project
|
|
11243
11901
|
#
|
|
11244
|
-
# #
|
|
11902
|
+
# # The following example updates the source data provider and description of a migration project.
|
|
11245
11903
|
#
|
|
11246
11904
|
# resp = client.modify_migration_project({
|
|
11247
|
-
# description: "description",
|
|
11248
|
-
#
|
|
11249
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
|
|
11250
|
-
# migration_project_name: "new-name",
|
|
11251
|
-
# schema_conversion_application_attributes: {
|
|
11252
|
-
# s3_bucket_path: "arn:aws:s3:::myuser-bucket",
|
|
11253
|
-
# s3_bucket_role_arn: "arn:aws:iam::012345678901:role/Admin",
|
|
11254
|
-
# },
|
|
11905
|
+
# description: "Updated migration project description",
|
|
11906
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
11255
11907
|
# source_data_provider_descriptors: [
|
|
11256
11908
|
# {
|
|
11257
|
-
# data_provider_identifier: "arn:aws:dms:us-east-1:
|
|
11258
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::012345678901:role/myuser-admin-access",
|
|
11259
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/myuser/ALL.SOURCE.ORACLE_12-A1B2C3",
|
|
11260
|
-
# },
|
|
11261
|
-
# ],
|
|
11262
|
-
# target_data_provider_descriptors: [
|
|
11263
|
-
# {
|
|
11264
|
-
# data_provider_identifier: "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345",
|
|
11265
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::012345678901:role/myuser-admin-access",
|
|
11266
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:012345678901:secret:myorg/myuser/TARGET.postgresql-A1B2C3",
|
|
11909
|
+
# data_provider_identifier: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
11267
11910
|
# },
|
|
11268
11911
|
# ],
|
|
11269
11912
|
# })
|
|
@@ -11271,31 +11914,33 @@ module Aws::DatabaseMigrationService
|
|
|
11271
11914
|
# resp.to_h outputs the following:
|
|
11272
11915
|
# {
|
|
11273
11916
|
# migration_project: {
|
|
11274
|
-
#
|
|
11275
|
-
#
|
|
11276
|
-
#
|
|
11277
|
-
#
|
|
11278
|
-
#
|
|
11917
|
+
# description: "Updated migration project description",
|
|
11918
|
+
# instance_profile_arn: "arn:aws:dms:us-east-1:111122223333:instance-profile:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
11919
|
+
# instance_profile_name: "example-instance-profile",
|
|
11920
|
+
# migration_project_arn: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
11921
|
+
# migration_project_creation_time: Time.parse("2026-01-09T12:30:00.000000Z"),
|
|
11922
|
+
# migration_project_name: "example-migration-project",
|
|
11279
11923
|
# schema_conversion_application_attributes: {
|
|
11280
|
-
# s3_bucket_path: "
|
|
11281
|
-
# s3_bucket_role_arn: "arn:aws:iam::
|
|
11924
|
+
# s3_bucket_path: "s3://amzn-s3-demo-bucket",
|
|
11925
|
+
# s3_bucket_role_arn: "arn:aws:iam::111122223333:role/example-s3-access-role",
|
|
11282
11926
|
# },
|
|
11283
11927
|
# source_data_provider_descriptors: [
|
|
11284
11928
|
# {
|
|
11285
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
11286
|
-
# data_provider_name: "
|
|
11287
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
11288
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
11929
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
11930
|
+
# data_provider_name: "example-data-provider",
|
|
11931
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
11932
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-source-secret-A1B2C3",
|
|
11289
11933
|
# },
|
|
11290
11934
|
# ],
|
|
11291
11935
|
# target_data_provider_descriptors: [
|
|
11292
11936
|
# {
|
|
11293
|
-
# data_provider_arn: "arn:aws:dms:us-east-1:
|
|
11294
|
-
# data_provider_name: "
|
|
11295
|
-
# secrets_manager_access_role_arn: "arn:aws:iam::
|
|
11296
|
-
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:
|
|
11937
|
+
# data_provider_arn: "arn:aws:dms:us-east-1:111122223333:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
11938
|
+
# data_provider_name: "example-data-provider",
|
|
11939
|
+
# secrets_manager_access_role_arn: "arn:aws:iam::111122223333:role/example-secrets-manager-role",
|
|
11940
|
+
# secrets_manager_secret_id: "arn:aws:secretsmanager:us-east-1:111122223333:secret:example-target-secret-A1B2C3",
|
|
11297
11941
|
# },
|
|
11298
11942
|
# ],
|
|
11943
|
+
# transformation_rules: "{\"rules\":[{\"rule-type\":\"transformation\",\"rule-id\":\"1\",\"rule-name\":\"1\",\"rule-target\":\"schema\",\"rule-action\":\"rename\",\"object-locator\":{\"schema-name\":\"ExampleSchema\"},\"value\":\"TargetSchema\"}]}",
|
|
11299
11944
|
# },
|
|
11300
11945
|
# }
|
|
11301
11946
|
#
|
|
@@ -12400,10 +13045,31 @@ module Aws::DatabaseMigrationService
|
|
|
12400
13045
|
req.send_request(options)
|
|
12401
13046
|
end
|
|
12402
13047
|
|
|
12403
|
-
#
|
|
12404
|
-
#
|
|
12405
|
-
#
|
|
12406
|
-
#
|
|
13048
|
+
# Queues the installation of the extension pack on your target database.
|
|
13049
|
+
# If other requests created by `Start*` operations are already in the
|
|
13050
|
+
# migration project's queue, the installation begins after they
|
|
13051
|
+
# complete.
|
|
13052
|
+
#
|
|
13053
|
+
# This operation requires a non-virtual target data provider.
|
|
13054
|
+
#
|
|
13055
|
+
# If the extension pack already exists, the operation reinstalls it. To
|
|
13056
|
+
# ensure compatibility, reconvert your database objects if the version
|
|
13057
|
+
# has changed since your last conversion. For more information, see
|
|
13058
|
+
# [Using extension packs in DMS Schema Conversion][1].
|
|
13059
|
+
#
|
|
13060
|
+
# To check the status of the request, call
|
|
13061
|
+
# [DescribeExtensionPackAssociations][2] using the returned
|
|
13062
|
+
# `RequestIdentifier` as a filter.
|
|
13063
|
+
#
|
|
13064
|
+
# **Required permissions:** `dms:AssociateExtensionPack`. For more
|
|
13065
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
13066
|
+
# Migration Service][3].
|
|
13067
|
+
#
|
|
13068
|
+
#
|
|
13069
|
+
#
|
|
13070
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/extension-pack.html
|
|
13071
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeExtensionPackAssociations.html
|
|
13072
|
+
# [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
12407
13073
|
#
|
|
12408
13074
|
# @option params [required, String] :migration_project_identifier
|
|
12409
13075
|
# The migration project name or Amazon Resource Name (ARN).
|
|
@@ -12413,17 +13079,17 @@ module Aws::DatabaseMigrationService
|
|
|
12413
13079
|
# * {Types::StartExtensionPackAssociationResponse#request_identifier #request_identifier} => String
|
|
12414
13080
|
#
|
|
12415
13081
|
#
|
|
12416
|
-
# @example Example:
|
|
13082
|
+
# @example Example: Install the extension pack on the target database
|
|
12417
13083
|
#
|
|
12418
|
-
# #
|
|
13084
|
+
# # The following example queues the installation of the extension pack on the target database.
|
|
12419
13085
|
#
|
|
12420
13086
|
# resp = client.start_extension_pack_association({
|
|
12421
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
13087
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
12422
13088
|
# })
|
|
12423
13089
|
#
|
|
12424
13090
|
# resp.to_h outputs the following:
|
|
12425
13091
|
# {
|
|
12426
|
-
# request_identifier: "
|
|
13092
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
12427
13093
|
# }
|
|
12428
13094
|
#
|
|
12429
13095
|
# @example Request syntax with placeholder values
|
|
@@ -12445,36 +13111,72 @@ module Aws::DatabaseMigrationService
|
|
|
12445
13111
|
req.send_request(options)
|
|
12446
13112
|
end
|
|
12447
13113
|
|
|
12448
|
-
#
|
|
12449
|
-
#
|
|
12450
|
-
#
|
|
12451
|
-
#
|
|
12452
|
-
#
|
|
13114
|
+
# Queues an assessment of the selected source metadata models (database
|
|
13115
|
+
# objects such as tables, views, and procedures) to evaluate conversion
|
|
13116
|
+
# complexity to the target database format. If other requests created by
|
|
13117
|
+
# `Start*` operations are already in the migration project's queue, the
|
|
13118
|
+
# assessment begins after they complete.
|
|
13119
|
+
#
|
|
13120
|
+
# The assessment request loads metadata models that are not yet in the
|
|
13121
|
+
# metadata tree, but does not reload metadata models that are already
|
|
13122
|
+
# present. If your source database has changed since the metadata was
|
|
13123
|
+
# loaded, refresh the affected metadata models with
|
|
13124
|
+
# [StartMetadataModelImport][1] before calling this operation.
|
|
13125
|
+
#
|
|
13126
|
+
# To check the status of the assessment request, call
|
|
13127
|
+
# [DescribeMetadataModelAssessments][2] using the returned
|
|
13128
|
+
# `RequestIdentifier` as a filter.
|
|
13129
|
+
#
|
|
13130
|
+
# To export the conversion assessment report after the request completes
|
|
13131
|
+
# successfully, call [ExportMetadataModelAssessment][3].
|
|
13132
|
+
#
|
|
13133
|
+
# **Required permissions:** `dms:StartMetadataModelAssessment`. For more
|
|
13134
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
13135
|
+
# Migration Service][4].
|
|
13136
|
+
#
|
|
13137
|
+
#
|
|
13138
|
+
#
|
|
13139
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelImport.html
|
|
13140
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelAssessments.html
|
|
13141
|
+
# [3]: https://docs.aws.amazon.com/dms/latest/APIReference/API_ExportMetadataModelAssessment.html
|
|
13142
|
+
# [4]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
12453
13143
|
#
|
|
12454
13144
|
# @option params [required, String] :migration_project_identifier
|
|
12455
13145
|
# The migration project name or Amazon Resource Name (ARN).
|
|
12456
13146
|
#
|
|
12457
13147
|
# @option params [required, String] :selection_rules
|
|
12458
|
-
# A
|
|
13148
|
+
# A JSON string that identifies the metadata models to assess. For the
|
|
13149
|
+
# selection rule format and examples, see [Selection rules in DMS Schema
|
|
13150
|
+
# Conversion][1].
|
|
13151
|
+
#
|
|
13152
|
+
# Usage:
|
|
13153
|
+
#
|
|
13154
|
+
# * Accepts only source selection rules, where `server-name` in the
|
|
13155
|
+
# object locator matches the source data provider.
|
|
13156
|
+
#
|
|
13157
|
+
# * Supports `explicit`, `include`, and `exclude` rule actions.
|
|
13158
|
+
#
|
|
13159
|
+
#
|
|
13160
|
+
#
|
|
13161
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
12459
13162
|
#
|
|
12460
13163
|
# @return [Types::StartMetadataModelAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
12461
13164
|
#
|
|
12462
13165
|
# * {Types::StartMetadataModelAssessmentResponse#request_identifier #request_identifier} => String
|
|
12463
13166
|
#
|
|
12464
13167
|
#
|
|
12465
|
-
# @example Example:
|
|
13168
|
+
# @example Example: Assess all objects in a schema
|
|
12466
13169
|
#
|
|
12467
|
-
# #
|
|
12468
|
-
# # your source database.
|
|
13170
|
+
# # The following example queues an assessment of the conversion complexity for all objects in the ExampleSchema schema.
|
|
12469
13171
|
#
|
|
12470
13172
|
# resp = client.start_metadata_model_assessment({
|
|
12471
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
12472
|
-
# selection_rules: "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"
|
|
13173
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
13174
|
+
# selection_rules: "{\"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\"}]}",
|
|
12473
13175
|
# })
|
|
12474
13176
|
#
|
|
12475
13177
|
# resp.to_h outputs the following:
|
|
12476
13178
|
# {
|
|
12477
|
-
# request_identifier: "
|
|
13179
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
12478
13180
|
# }
|
|
12479
13181
|
#
|
|
12480
13182
|
# @example Request syntax with placeholder values
|
|
@@ -12497,32 +13199,100 @@ module Aws::DatabaseMigrationService
|
|
|
12497
13199
|
req.send_request(options)
|
|
12498
13200
|
end
|
|
12499
13201
|
|
|
12500
|
-
#
|
|
12501
|
-
# target database
|
|
13202
|
+
# Queues a conversion of the selected source metadata models (database
|
|
13203
|
+
# objects such as tables, views, and procedures) to the target database
|
|
13204
|
+
# format. If other requests created by `Start*` operations are already
|
|
13205
|
+
# in the migration project's queue, the conversion begins after they
|
|
13206
|
+
# complete.
|
|
13207
|
+
#
|
|
13208
|
+
# The conversion request loads metadata models that are not yet in the
|
|
13209
|
+
# metadata tree, but does not reload metadata models that are already
|
|
13210
|
+
# present. If your source database has changed since the metadata was
|
|
13211
|
+
# loaded, refresh the affected metadata models with
|
|
13212
|
+
# [StartMetadataModelImport][1] before calling this operation.
|
|
13213
|
+
#
|
|
13214
|
+
# <note markdown="1"> If converted objects already exist in the target metadata tree, the
|
|
13215
|
+
# conversion overwrites them, including any manual edits.
|
|
13216
|
+
#
|
|
13217
|
+
# </note>
|
|
13218
|
+
#
|
|
13219
|
+
# To check the status of the conversion request, call
|
|
13220
|
+
# [DescribeMetadataModelConversions][2] using the returned
|
|
13221
|
+
# `RequestIdentifier` as a filter.
|
|
13222
|
+
#
|
|
13223
|
+
# To cancel a queued or in-progress request, call
|
|
13224
|
+
# [CancelMetadataModelConversion][3] with the returned
|
|
13225
|
+
# `RequestIdentifier`.
|
|
13226
|
+
#
|
|
13227
|
+
# After the conversion completes successfully:
|
|
13228
|
+
#
|
|
13229
|
+
# * To export a post-conversion assessment report, call
|
|
13230
|
+
# [ExportMetadataModelAssessment][4].
|
|
13231
|
+
#
|
|
13232
|
+
# * To retrieve converted code, use any of the following options:
|
|
13233
|
+
#
|
|
13234
|
+
# * [DescribeMetadataModel][5] and [DescribeMetadataModelChildren][6]
|
|
13235
|
+
# – navigate the target metadata tree and retrieve converted
|
|
13236
|
+
# definitions.
|
|
13237
|
+
#
|
|
13238
|
+
# * [StartMetadataModelExportAsScript][7] – export as data definition
|
|
13239
|
+
# language (DDL) scripts to your Amazon S3 bucket.
|
|
13240
|
+
#
|
|
13241
|
+
# * [StartMetadataModelExportToTarget][8] – apply directly to your
|
|
13242
|
+
# target database.
|
|
13243
|
+
#
|
|
13244
|
+
# **Required permissions:** `dms:StartMetadataModelConversion`. For more
|
|
13245
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
13246
|
+
# Migration Service][9].
|
|
13247
|
+
#
|
|
13248
|
+
#
|
|
13249
|
+
#
|
|
13250
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelImport.html
|
|
13251
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelConversions.html
|
|
13252
|
+
# [3]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CancelMetadataModelConversion.html
|
|
13253
|
+
# [4]: https://docs.aws.amazon.com/dms/latest/APIReference/API_ExportMetadataModelAssessment.html
|
|
13254
|
+
# [5]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModel.html
|
|
13255
|
+
# [6]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelChildren.html
|
|
13256
|
+
# [7]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelExportAsScript.html
|
|
13257
|
+
# [8]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelExportToTarget.html
|
|
13258
|
+
# [9]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
12502
13259
|
#
|
|
12503
13260
|
# @option params [required, String] :migration_project_identifier
|
|
12504
13261
|
# The migration project name or Amazon Resource Name (ARN).
|
|
12505
13262
|
#
|
|
12506
13263
|
# @option params [required, String] :selection_rules
|
|
12507
|
-
# A
|
|
13264
|
+
# A JSON string that identifies the metadata models to convert. For the
|
|
13265
|
+
# selection rule format and examples, see [Selection rules in DMS Schema
|
|
13266
|
+
# Conversion][1].
|
|
13267
|
+
#
|
|
13268
|
+
# Usage:
|
|
13269
|
+
#
|
|
13270
|
+
# * Accepts only source selection rules, where `server-name` in the
|
|
13271
|
+
# object locator matches the source data provider.
|
|
13272
|
+
#
|
|
13273
|
+
# * Supports `explicit`, `include`, and `exclude` rule actions.
|
|
13274
|
+
#
|
|
13275
|
+
#
|
|
13276
|
+
#
|
|
13277
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
12508
13278
|
#
|
|
12509
13279
|
# @return [Types::StartMetadataModelConversionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
12510
13280
|
#
|
|
12511
13281
|
# * {Types::StartMetadataModelConversionResponse#request_identifier #request_identifier} => String
|
|
12512
13282
|
#
|
|
12513
13283
|
#
|
|
12514
|
-
# @example Example:
|
|
13284
|
+
# @example Example: Convert all objects in a schema
|
|
12515
13285
|
#
|
|
12516
|
-
# #
|
|
13286
|
+
# # The following example queues a conversion of all objects in the ExampleSchema schema to the target database format.
|
|
12517
13287
|
#
|
|
12518
13288
|
# resp = client.start_metadata_model_conversion({
|
|
12519
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
12520
|
-
# selection_rules: "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"
|
|
13289
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
13290
|
+
# selection_rules: "{\"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\"}]}",
|
|
12521
13291
|
# })
|
|
12522
13292
|
#
|
|
12523
13293
|
# resp.to_h outputs the following:
|
|
12524
13294
|
# {
|
|
12525
|
-
# request_identifier: "
|
|
13295
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
12526
13296
|
# }
|
|
12527
13297
|
#
|
|
12528
13298
|
# @example Request syntax with placeholder values
|
|
@@ -12545,33 +13315,102 @@ module Aws::DatabaseMigrationService
|
|
|
12545
13315
|
req.send_request(options)
|
|
12546
13316
|
end
|
|
12547
13317
|
|
|
12548
|
-
#
|
|
12549
|
-
#
|
|
13318
|
+
# Queues the creation of a metadata model in the source metadata tree.
|
|
13319
|
+
# If other requests created by `Start*` operations are already in the
|
|
13320
|
+
# migration project's queue, the creation begins after they complete.
|
|
12550
13321
|
#
|
|
12551
|
-
# <note markdown="1"> This
|
|
12552
|
-
#
|
|
13322
|
+
# <note markdown="1"> This operation supports only Microsoft SQL Server to Aurora PostgreSQL
|
|
13323
|
+
# and Microsoft SQL Server to Amazon RDS for PostgreSQL conversion
|
|
13324
|
+
# paths.
|
|
12553
13325
|
#
|
|
12554
13326
|
# </note>
|
|
12555
13327
|
#
|
|
13328
|
+
# To check the status of the creation request, call
|
|
13329
|
+
# [DescribeMetadataModelCreations][1] using the returned
|
|
13330
|
+
# `RequestIdentifier` as a filter.
|
|
13331
|
+
#
|
|
13332
|
+
# To cancel a queued or in-progress request, call
|
|
13333
|
+
# [CancelMetadataModelCreation][2] with the returned
|
|
13334
|
+
# `RequestIdentifier`.
|
|
13335
|
+
#
|
|
13336
|
+
# Calling [StartMetadataModelImport][3] with `Refresh` deletes metadata
|
|
13337
|
+
# models created by this operation.
|
|
13338
|
+
#
|
|
13339
|
+
# After the creation completes successfully:
|
|
13340
|
+
#
|
|
13341
|
+
# * To evaluate conversion complexity, call
|
|
13342
|
+
# [StartMetadataModelAssessment][4].
|
|
13343
|
+
#
|
|
13344
|
+
# * To convert to the target database format, call
|
|
13345
|
+
# [StartMetadataModelConversion][5].
|
|
13346
|
+
#
|
|
13347
|
+
# **Required permissions:** `dms:StartMetadataModelCreation`. For more
|
|
13348
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
13349
|
+
# Migration Service][6].
|
|
13350
|
+
#
|
|
13351
|
+
#
|
|
13352
|
+
#
|
|
13353
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelCreations.html
|
|
13354
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_CancelMetadataModelCreation.html
|
|
13355
|
+
# [3]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelImport.html
|
|
13356
|
+
# [4]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelAssessment.html
|
|
13357
|
+
# [5]: https://docs.aws.amazon.com/dms/latest/APIReference/API_StartMetadataModelConversion.html
|
|
13358
|
+
# [6]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
13359
|
+
#
|
|
12556
13360
|
# @option params [required, String] :migration_project_identifier
|
|
12557
13361
|
# The migration project name or Amazon Resource Name (ARN).
|
|
12558
13362
|
#
|
|
12559
13363
|
# @option params [required, String] :selection_rules
|
|
12560
|
-
#
|
|
12561
|
-
#
|
|
12562
|
-
#
|
|
13364
|
+
# A JSON string that identifies the source schema for the metadata
|
|
13365
|
+
# model. For the selection rule format and examples, see [Selection
|
|
13366
|
+
# rules in DMS Schema Conversion][1].
|
|
13367
|
+
#
|
|
13368
|
+
# Usage:
|
|
13369
|
+
#
|
|
13370
|
+
# * Accepts only source selection rules, where `server-name` in the
|
|
13371
|
+
# object locator matches the source data provider.
|
|
13372
|
+
#
|
|
13373
|
+
# * Supports only `explicit` rule actions.
|
|
13374
|
+
#
|
|
13375
|
+
# * Exactly one rule is allowed.
|
|
13376
|
+
#
|
|
13377
|
+
#
|
|
13378
|
+
#
|
|
13379
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
12563
13380
|
#
|
|
12564
13381
|
# @option params [required, String] :metadata_model_name
|
|
12565
|
-
# The name
|
|
13382
|
+
# The name for the metadata model to use in subsequent operations.
|
|
12566
13383
|
#
|
|
12567
13384
|
# @option params [required, Types::MetadataModelProperties] :properties
|
|
12568
|
-
# The properties of metadata model
|
|
12569
|
-
# Union. Only one member of this object can be specified or returned.
|
|
13385
|
+
# The properties of the metadata model.
|
|
12570
13386
|
#
|
|
12571
13387
|
# @return [Types::StartMetadataModelCreationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
12572
13388
|
#
|
|
12573
13389
|
# * {Types::StartMetadataModelCreationResponse#request_identifier #request_identifier} => String
|
|
12574
13390
|
#
|
|
13391
|
+
#
|
|
13392
|
+
# @example Example: Create a metadata model for a SQL statement
|
|
13393
|
+
#
|
|
13394
|
+
# # The following example queues the creation of a metadata model for a SQL statement. The selection rule specifies the
|
|
13395
|
+
# # schema where the metadata model is placed, and MetadataModelName provides a unique identifier for use in subsequent
|
|
13396
|
+
# # operations.
|
|
13397
|
+
#
|
|
13398
|
+
# resp = client.start_metadata_model_creation({
|
|
13399
|
+
# metadata_model_name: "ExampleStatement",
|
|
13400
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
13401
|
+
# properties: {
|
|
13402
|
+
# statement_properties: {
|
|
13403
|
+
# definition: "SELECT * FROM ExampleTable;",
|
|
13404
|
+
# },
|
|
13405
|
+
# },
|
|
13406
|
+
# selection_rules: "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": {\"server-name\": \"example-source-server.us-east-1.rds.amazonaws.com\", \"database-name\": \"ExampleDatabase\", \"schema-name\": \"ExampleSchema\"}, \"rule-action\": \"explicit\"}]}",
|
|
13407
|
+
# })
|
|
13408
|
+
#
|
|
13409
|
+
# resp.to_h outputs the following:
|
|
13410
|
+
# {
|
|
13411
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
13412
|
+
# }
|
|
13413
|
+
#
|
|
12575
13414
|
# @example Request syntax with placeholder values
|
|
12576
13415
|
#
|
|
12577
13416
|
# resp = client.start_metadata_model_creation({
|
|
@@ -12598,40 +13437,78 @@ module Aws::DatabaseMigrationService
|
|
|
12598
13437
|
req.send_request(options)
|
|
12599
13438
|
end
|
|
12600
13439
|
|
|
12601
|
-
#
|
|
12602
|
-
#
|
|
13440
|
+
# Queues an export of metadata models (database objects such as tables,
|
|
13441
|
+
# views, and procedures) as a data definition language (DDL) script. The
|
|
13442
|
+
# script is stored as a ZIP archive in the Amazon S3 bucket associated
|
|
13443
|
+
# with the migration project. If other requests created by `Start*`
|
|
13444
|
+
# operations are already in the migration project's queue, the export
|
|
13445
|
+
# begins after they complete.
|
|
13446
|
+
#
|
|
13447
|
+
# When exporting from the target metadata tree, the export applies only
|
|
13448
|
+
# to metadata models created by conversion. Metadata models imported
|
|
13449
|
+
# from the database are skipped.
|
|
13450
|
+
#
|
|
13451
|
+
# To check the status of the export request, call
|
|
13452
|
+
# [DescribeMetadataModelExportsAsScript][1] using the returned
|
|
13453
|
+
# `RequestIdentifier` as a filter.
|
|
13454
|
+
#
|
|
13455
|
+
# **Required permissions:** `dms:StartMetadataModelExportAsScripts`. For
|
|
13456
|
+
# more information, see [Actions, resources, and condition keys for
|
|
13457
|
+
# Database Migration Service][2].
|
|
13458
|
+
#
|
|
13459
|
+
#
|
|
13460
|
+
#
|
|
13461
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelExportsAsScript.html
|
|
13462
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
12603
13463
|
#
|
|
12604
13464
|
# @option params [required, String] :migration_project_identifier
|
|
12605
13465
|
# The migration project name or Amazon Resource Name (ARN).
|
|
12606
13466
|
#
|
|
12607
13467
|
# @option params [required, String] :selection_rules
|
|
12608
|
-
# A
|
|
13468
|
+
# A JSON string that identifies the metadata models to export as a SQL
|
|
13469
|
+
# script. For the selection rule format and examples, see [Selection
|
|
13470
|
+
# rules in DMS Schema Conversion][1].
|
|
13471
|
+
#
|
|
13472
|
+
# Usage:
|
|
13473
|
+
#
|
|
13474
|
+
# * Accepts source or target selection rules depending on the `Origin`
|
|
13475
|
+
# parameter. The `server-name` in the object locator must match the
|
|
13476
|
+
# corresponding data provider.
|
|
13477
|
+
#
|
|
13478
|
+
# * Supports `explicit`, `include`, and `exclude` rule actions.
|
|
13479
|
+
#
|
|
13480
|
+
#
|
|
13481
|
+
#
|
|
13482
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
12609
13483
|
#
|
|
12610
13484
|
# @option params [required, String] :origin
|
|
12611
|
-
#
|
|
13485
|
+
# Specifies the metadata tree to export from.
|
|
12612
13486
|
#
|
|
12613
13487
|
# @option params [String] :file_name
|
|
12614
|
-
# The name
|
|
13488
|
+
# The name for the exported file. When you omit this parameter, the
|
|
13489
|
+
# service generates a name from the data provider engine name and an
|
|
13490
|
+
# export timestamp.
|
|
12615
13491
|
#
|
|
12616
13492
|
# @return [Types::StartMetadataModelExportAsScriptResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
12617
13493
|
#
|
|
12618
13494
|
# * {Types::StartMetadataModelExportAsScriptResponse#request_identifier #request_identifier} => String
|
|
12619
13495
|
#
|
|
12620
13496
|
#
|
|
12621
|
-
# @example Example:
|
|
13497
|
+
# @example Example: Export converted metadata models as DDL scripts
|
|
12622
13498
|
#
|
|
12623
|
-
# #
|
|
13499
|
+
# # The following example queues an export of converted metadata models for all objects in the ExampleSchema schema as data
|
|
13500
|
+
# # definition language (DDL) scripts to the S3 bucket associated with the migration project.
|
|
12624
13501
|
#
|
|
12625
13502
|
# resp = client.start_metadata_model_export_as_script({
|
|
12626
|
-
# file_name: "
|
|
12627
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
12628
|
-
# origin: "
|
|
12629
|
-
# selection_rules: "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"
|
|
13503
|
+
# file_name: "ExampleScript",
|
|
13504
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
13505
|
+
# origin: "TARGET",
|
|
13506
|
+
# selection_rules: "{\"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\"},\"rule-action\": \"explicit\"}]}",
|
|
12630
13507
|
# })
|
|
12631
13508
|
#
|
|
12632
13509
|
# resp.to_h outputs the following:
|
|
12633
13510
|
# {
|
|
12634
|
-
# request_identifier: "
|
|
13511
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
12635
13512
|
# }
|
|
12636
13513
|
#
|
|
12637
13514
|
# @example Request syntax with placeholder values
|
|
@@ -12656,38 +13533,82 @@ module Aws::DatabaseMigrationService
|
|
|
12656
13533
|
req.send_request(options)
|
|
12657
13534
|
end
|
|
12658
13535
|
|
|
12659
|
-
#
|
|
13536
|
+
# Queues an export of the selected converted metadata models (database
|
|
13537
|
+
# objects such as tables, views, and procedures) to your target
|
|
13538
|
+
# database. If other requests created by `Start*` operations are already
|
|
13539
|
+
# in the migration project's queue, the export begins after they
|
|
13540
|
+
# complete.
|
|
13541
|
+
#
|
|
13542
|
+
# This operation requires a non-virtual target data provider.
|
|
13543
|
+
#
|
|
13544
|
+
# The export applies only metadata models created by conversion.
|
|
13545
|
+
# Metadata models imported from the database are skipped.
|
|
13546
|
+
#
|
|
13547
|
+
# <note markdown="1"> If objects with the same name already exist on the target database,
|
|
13548
|
+
# the export overwrites them.
|
|
13549
|
+
#
|
|
13550
|
+
# </note>
|
|
13551
|
+
#
|
|
13552
|
+
# The operation installs the extension pack on the target database. For
|
|
13553
|
+
# more information, see [Using extension packs in DMS Schema
|
|
13554
|
+
# Conversion][1].
|
|
13555
|
+
#
|
|
13556
|
+
# To check the status of the export request, call
|
|
13557
|
+
# [DescribeMetadataModelExportsToTarget][2] using the returned
|
|
13558
|
+
# `RequestIdentifier` as a filter.
|
|
13559
|
+
#
|
|
13560
|
+
# **Required permissions:** `dms:StartMetadataModelExportToTarget`. For
|
|
13561
|
+
# more information, see [Actions, resources, and condition keys for
|
|
13562
|
+
# Database Migration Service][3].
|
|
13563
|
+
#
|
|
13564
|
+
#
|
|
13565
|
+
#
|
|
13566
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/extension-pack.html
|
|
13567
|
+
# [2]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelExportsToTarget.html
|
|
13568
|
+
# [3]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
12660
13569
|
#
|
|
12661
13570
|
# @option params [required, String] :migration_project_identifier
|
|
12662
13571
|
# The migration project name or Amazon Resource Name (ARN).
|
|
12663
13572
|
#
|
|
12664
13573
|
# @option params [required, String] :selection_rules
|
|
12665
|
-
# A
|
|
13574
|
+
# A JSON string that identifies the metadata models to export to the
|
|
13575
|
+
# target database. For the selection rule format and examples, see
|
|
13576
|
+
# [Selection rules in DMS Schema Conversion][1].
|
|
13577
|
+
#
|
|
13578
|
+
# Usage:
|
|
13579
|
+
#
|
|
13580
|
+
# * Accepts only target selection rules, where `server-name` in the
|
|
13581
|
+
# object locator matches the target data provider.
|
|
13582
|
+
#
|
|
13583
|
+
# * Supports `explicit`, `include`, and `exclude` rule actions.
|
|
13584
|
+
#
|
|
13585
|
+
#
|
|
13586
|
+
#
|
|
13587
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
12666
13588
|
#
|
|
12667
13589
|
# @option params [Boolean] :overwrite_extension_pack
|
|
12668
|
-
#
|
|
12669
|
-
#
|
|
12670
|
-
# a source database that are required when converting objects to the
|
|
12671
|
-
# target database.
|
|
13590
|
+
# Specifies whether to overwrite the extension pack if one already
|
|
13591
|
+
# exists on the target database. The default value is `true`.
|
|
12672
13592
|
#
|
|
12673
13593
|
# @return [Types::StartMetadataModelExportToTargetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
12674
13594
|
#
|
|
12675
13595
|
# * {Types::StartMetadataModelExportToTargetResponse#request_identifier #request_identifier} => String
|
|
12676
13596
|
#
|
|
12677
13597
|
#
|
|
12678
|
-
# @example Example:
|
|
13598
|
+
# @example Example: Export converted metadata models to the target database
|
|
12679
13599
|
#
|
|
12680
|
-
# #
|
|
13600
|
+
# # The following example queues an export of converted metadata models for all objects in the ExampleSchema schema to the
|
|
13601
|
+
# # target database.
|
|
12681
13602
|
#
|
|
12682
13603
|
# resp = client.start_metadata_model_export_to_target({
|
|
12683
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
13604
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
12684
13605
|
# overwrite_extension_pack: true,
|
|
12685
|
-
# selection_rules: "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"
|
|
13606
|
+
# selection_rules: "{\"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\"},\"rule-action\": \"explicit\"}]}",
|
|
12686
13607
|
# })
|
|
12687
13608
|
#
|
|
12688
13609
|
# resp.to_h outputs the following:
|
|
12689
13610
|
# {
|
|
12690
|
-
# request_identifier: "
|
|
13611
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
12691
13612
|
# }
|
|
12692
13613
|
#
|
|
12693
13614
|
# @example Request syntax with placeholder values
|
|
@@ -12711,44 +13632,80 @@ module Aws::DatabaseMigrationService
|
|
|
12711
13632
|
req.send_request(options)
|
|
12712
13633
|
end
|
|
12713
13634
|
|
|
12714
|
-
#
|
|
12715
|
-
#
|
|
13635
|
+
# Queues an import of metadata models (database objects such as tables,
|
|
13636
|
+
# views, and procedures) from your data provider into the metadata tree.
|
|
13637
|
+
# If other requests created by `Start*` operations are already in the
|
|
13638
|
+
# migration project's queue, the import begins after they complete.
|
|
12716
13639
|
#
|
|
12717
|
-
#
|
|
12718
|
-
#
|
|
13640
|
+
# To check the status of the import request, call
|
|
13641
|
+
# [DescribeMetadataModelImports][1] using the returned
|
|
13642
|
+
# `RequestIdentifier` as a filter.
|
|
13643
|
+
#
|
|
13644
|
+
# **Required permissions:** `dms:StartMetadataModelImport`. For more
|
|
13645
|
+
# information, see [Actions, resources, and condition keys for Database
|
|
13646
|
+
# Migration Service][2].
|
|
13647
|
+
#
|
|
13648
|
+
#
|
|
13649
|
+
#
|
|
13650
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_DescribeMetadataModelImports.html
|
|
13651
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html
|
|
12719
13652
|
#
|
|
12720
13653
|
# @option params [required, String] :migration_project_identifier
|
|
12721
13654
|
# The migration project name or Amazon Resource Name (ARN).
|
|
12722
13655
|
#
|
|
12723
13656
|
# @option params [required, String] :selection_rules
|
|
12724
|
-
# A
|
|
13657
|
+
# A JSON string that identifies the metadata models to import from the
|
|
13658
|
+
# data provider. For the selection rule format and examples, see
|
|
13659
|
+
# [Selection rules in DMS Schema Conversion][1].
|
|
13660
|
+
#
|
|
13661
|
+
# Usage:
|
|
13662
|
+
#
|
|
13663
|
+
# * Accepts source or target selection rules depending on the `Origin`
|
|
13664
|
+
# parameter. The `server-name` in the object locator must match the
|
|
13665
|
+
# corresponding data provider.
|
|
13666
|
+
#
|
|
13667
|
+
# * Supports `explicit`, `include`, and `exclude` rule actions.
|
|
13668
|
+
#
|
|
13669
|
+
#
|
|
13670
|
+
#
|
|
13671
|
+
# [1]: https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html
|
|
12725
13672
|
#
|
|
12726
13673
|
# @option params [required, String] :origin
|
|
12727
|
-
#
|
|
13674
|
+
# Specifies the metadata tree to import into.
|
|
13675
|
+
#
|
|
13676
|
+
# <note markdown="1"> You cannot import from a virtual target data provider.
|
|
13677
|
+
#
|
|
13678
|
+
# </note>
|
|
12728
13679
|
#
|
|
12729
13680
|
# @option params [Boolean] :refresh
|
|
12730
|
-
#
|
|
12731
|
-
#
|
|
13681
|
+
# Specifies whether to refresh the selected metadata models from the
|
|
13682
|
+
# data provider.
|
|
13683
|
+
#
|
|
13684
|
+
# When `true`, the import reloads the selected metadata models with
|
|
13685
|
+
# current definitions and removes their existing subtree.
|
|
13686
|
+
#
|
|
13687
|
+
# When `false` (default), the import loads the full subtree that has not
|
|
13688
|
+
# yet been loaded into the metadata tree.
|
|
12732
13689
|
#
|
|
12733
13690
|
# @return [Types::StartMetadataModelImportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
12734
13691
|
#
|
|
12735
13692
|
# * {Types::StartMetadataModelImportResponse#request_identifier #request_identifier} => String
|
|
12736
13693
|
#
|
|
12737
13694
|
#
|
|
12738
|
-
# @example Example:
|
|
13695
|
+
# @example Example: Import metadata from the source database
|
|
12739
13696
|
#
|
|
12740
|
-
# #
|
|
13697
|
+
# # The following example queues a metadata import for all objects in the ExampleSchema schema from the source database.
|
|
12741
13698
|
#
|
|
12742
13699
|
# resp = client.start_metadata_model_import({
|
|
12743
|
-
# migration_project_identifier: "arn:aws:dms:us-east-1:
|
|
13700
|
+
# migration_project_identifier: "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
|
|
12744
13701
|
# origin: "SOURCE",
|
|
12745
13702
|
# refresh: false,
|
|
12746
|
-
# selection_rules: "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"
|
|
13703
|
+
# selection_rules: "{\"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\"}]}",
|
|
12747
13704
|
# })
|
|
12748
13705
|
#
|
|
12749
13706
|
# resp.to_h outputs the following:
|
|
12750
13707
|
# {
|
|
12751
|
-
# request_identifier: "
|
|
13708
|
+
# request_identifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
12752
13709
|
# }
|
|
12753
13710
|
#
|
|
12754
13711
|
# @example Request syntax with placeholder values
|
|
@@ -13721,7 +14678,7 @@ module Aws::DatabaseMigrationService
|
|
|
13721
14678
|
tracer: tracer
|
|
13722
14679
|
)
|
|
13723
14680
|
context[:gem_name] = 'aws-sdk-databasemigrationservice'
|
|
13724
|
-
context[:gem_version] = '1.
|
|
14681
|
+
context[:gem_version] = '1.149.0'
|
|
13725
14682
|
Seahorse::Client::Request.new(handlers, context)
|
|
13726
14683
|
end
|
|
13727
14684
|
|