lib/aws-sdk-databasemigrationservice/client.rb in aws-sdk-databasemigrationservice-1.53.0 vs lib/aws-sdk-databasemigrationservice/client.rb in aws-sdk-databasemigrationservice-1.54.0

- old
+ new

@@ -335,25 +335,25 @@ super end # @!group API Operations - # Adds metadata tags to an AWS DMS resource, including replication - # instance, endpoint, security group, and migration task. These tags can - # also be used with cost allocation reporting to track cost associated - # with DMS resources, or used in a Condition statement in an IAM policy - # for DMS. For more information, see [ `Tag` ][1] data type description. + # Adds metadata tags to an DMS resource, including replication instance, + # endpoint, security group, and migration task. These tags can also be + # used with cost allocation reporting to track cost associated with DMS + # resources, or used in a Condition statement in an IAM policy for DMS. + # For more information, see [ `Tag` ][1] data type description. # # # # [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html # # @option params [required, String] :resource_arn - # Identifies the AWS DMS resource to which tags should be added. The - # value for this parameter is an Amazon Resource Name (ARN). + # Identifies the DMS resource to which tags should be added. The value + # for this parameter is an Amazon Resource Name (ARN). # - # For AWS DMS, you can tag a replication instance, an endpoint, or a + # For DMS, you can tag a replication instance, an endpoint, or a # replication task. # # @option params [required, Array<Types::Tag>] :tags # One or more tags to be assigned to the resource. # @@ -403,12 +403,12 @@ # Applies a pending maintenance action to a resource (for example, to a # replication instance). # # @option params [required, String] :replication_instance_arn - # The Amazon Resource Name (ARN) of the AWS DMS resource that the - # pending maintenance action applies to. + # The Amazon Resource Name (ARN) of the DMS resource that the pending + # maintenance action applies to. # # @option params [required, String] :apply_action # The pending maintenance action to apply to this resource. # # @option params [required, String] :opt_in_type @@ -502,10 +502,19 @@ req.send_request(options) end # Creates an endpoint using the provided settings. # + # <note markdown="1"> For a MySQL source or target endpoint, don't explicitly specify the + # database using the `DatabaseName` request parameter on the + # `CreateEndpoint` API call. Specifying `DatabaseName` when you create a + # MySQL endpoint replicates all the task tables to this single database. + # For MySQL endpoints, you specify the database only when you specify + # the schema in the table-mapping rules of the DMS task. + # + # </note> + # # @option params [required, String] :endpoint_identifier # The database endpoint identifier. Identifiers must begin with a letter # and must contain only ASCII letters, digits, and hyphens. They can't # end with a hyphen, or contain two consecutive hyphens. # @@ -531,34 +540,34 @@ # # @option params [Integer] :port # The port used by the endpoint database. # # @option params [String] :database_name - # The name of the endpoint database. + # The name of the endpoint database. For a MySQL source or target + # endpoint, do not specify DatabaseName. # # @option params [String] :extra_connection_attributes # Additional attributes associated with the connection. Each attribute # is specified as a name-value pair associated by an equal sign (=). # Multiple attributes are separated by a semicolon (;) with no # additional white space. For information on the attributes available - # for connecting your source or target endpoint, see [Working with AWS - # DMS Endpoints][1] in the *AWS Database Migration Service User Guide.* + # for connecting your source or target endpoint, see [Working with DMS + # Endpoints][1] in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html # # @option params [String] :kms_key_id - # An AWS KMS key identifier that is used to encrypt the connection + # An KMS key identifier that is used to encrypt the connection # parameters for the endpoint. # - # If you don't specify a value for the `KmsKeyId` parameter, then AWS - # DMS uses your default encryption key. + # If you don't specify a value for the `KmsKeyId` parameter, then DMS + # uses your default encryption key. # - # AWS KMS creates the default encryption key for your AWS account. Your - # AWS account has a different default encryption key for each AWS - # Region. + # KMS creates the default encryption key for your account. Your account + # has a different default encryption key for each Region. # # @option params [Array<Types::Tag>] :tags # One or more tags to be assigned to the endpoint. # # @option params [String] :certificate_arn @@ -568,30 +577,31 @@ # The Secure Sockets Layer (SSL) mode to use for the SSL connection. The # default is `none` # # @option params [String] :service_access_role_arn # The Amazon Resource Name (ARN) for the service access role that you - # want to use to create the endpoint. + # want to use to create the endpoint. The role must allow the + # `iam:PassRole` action. # # @option params [String] :external_table_definition # The external table definition. # # @option params [Types::DynamoDbSettings] :dynamo_db_settings # Settings in JSON format for the target Amazon DynamoDB endpoint. For # information about other available settings, see [Using Object Mapping - # to Migrate Data to DynamoDB][1] in the *AWS Database Migration Service + # to Migrate Data to DynamoDB][1] in the *Database Migration Service # User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping # # @option params [Types::S3Settings] :s3_settings # Settings in JSON format for the target Amazon S3 endpoint. For more # information about the available settings, see [Extra Connection - # Attributes When Using Amazon S3 as a Target for AWS DMS][1] in the - # *AWS Database Migration Service User Guide.* + # Attributes When Using Amazon S3 as a Target for DMS][1] in the + # *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring # @@ -600,71 +610,65 @@ # endpoint. # # Possible settings include the following: # # * `ServiceAccessRoleArn` - The IAM role that has permission to access - # the Amazon S3 bucket. + # the Amazon S3 bucket. The role must allow the `iam:PassRole` action. # # * `BucketName` - The name of the S3 bucket to use. # - # * `CompressionType` - An optional parameter to use GZIP to compress - # the target files. To use GZIP, set this value to `NONE` (the - # default). To keep the files uncompressed, don't use this value. - # # Shorthand syntax for these settings is as follows: - # `ServiceAccessRoleArn=string,BucketName=string,CompressionType=string` + # `ServiceAccessRoleArn=string,BucketName=string` # # JSON syntax for these settings is as follows: `\{ - # "ServiceAccessRoleArn": "string", "BucketName": "string", - # "CompressionType": "none"|"gzip" \} ` + # "ServiceAccessRoleArn": "string", "BucketName": "string", \} ` # # @option params [Types::MongoDbSettings] :mongo_db_settings # Settings in JSON format for the source MongoDB endpoint. For more - # information about the available settings, see [Using MongoDB as a - # Target for AWS Database Migration Service][1] in the *AWS Database - # Migration Service User Guide.* + # information about the available settings, see [Endpoint configuration + # settings when using MongoDB as a source for Database Migration + # Service][1] in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration # # @option params [Types::KinesisSettings] :kinesis_settings # Settings in JSON format for the target endpoint for Amazon Kinesis # Data Streams. For more information about the available settings, see - # [Using Amazon Kinesis Data Streams as a Target for AWS Database - # Migration Service][1] in the *AWS Database Migration Service User - # Guide.* + # [Using object mapping to migrate data to a Kinesis data stream][1] in + # the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping # # @option params [Types::KafkaSettings] :kafka_settings # Settings in JSON format for the target Apache Kafka endpoint. For more - # information about the available settings, see [Using Apache Kafka as a - # Target for AWS Database Migration Service][1] in the *AWS Database - # Migration Service User Guide.* + # information about the available settings, see [Using object mapping to + # migrate data to a Kafka topic][1] in the *Database Migration Service + # User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping # # @option params [Types::ElasticsearchSettings] :elasticsearch_settings # Settings in JSON format for the target Elasticsearch endpoint. For # more information about the available settings, see [Extra Connection - # Attributes When Using Elasticsearch as a Target for AWS DMS][1] in the - # *AWS Database Migration Service User Guide*. + # Attributes When Using Elasticsearch as a Target for DMS][1] in the + # *Database Migration Service User Guide*. # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration # # @option params [Types::NeptuneSettings] :neptune_settings # Settings in JSON format for the target Amazon Neptune endpoint. For # more information about the available settings, see [Specifying - # Endpoint Settings for Amazon Neptune as a Target][1] in the *AWS - # Database Migration Service User Guide.* + # graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a + # target][1] in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings # @@ -672,90 +676,88 @@ # Provides information that defines an Amazon Redshift endpoint. # # @option params [Types::PostgreSQLSettings] :postgre_sql_settings # Settings in JSON format for the source and target PostgreSQL endpoint. # For information about other available settings, see [Extra connection - # attributes when using PostgreSQL as a source for AWS DMS][1] and [ - # Extra connection attributes when using PostgreSQL as a target for AWS - # DMS][2] in the *AWS Database Migration Service User Guide.* + # attributes when using PostgreSQL as a source for DMS][1] and [ Extra + # connection attributes when using PostgreSQL as a target for DMS][2] in + # the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib # # @option params [Types::MySQLSettings] :my_sql_settings # Settings in JSON format for the source and target MySQL endpoint. For # information about other available settings, see [Extra connection - # attributes when using MySQL as a source for AWS DMS][1] and [Extra + # attributes when using MySQL as a source for DMS][1] and [Extra # connection attributes when using a MySQL-compatible database as a - # target for AWS DMS][2] in the *AWS Database Migration Service User - # Guide.* + # target for DMS][2] in the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib # # @option params [Types::OracleSettings] :oracle_settings # Settings in JSON format for the source and target Oracle endpoint. For # information about other available settings, see [Extra connection - # attributes when using Oracle as a source for AWS DMS][1] and [ Extra - # connection attributes when using Oracle as a target for AWS DMS][2] in - # the *AWS Database Migration Service User Guide.* + # attributes when using Oracle as a source for DMS][1] and [ Extra + # connection attributes when using Oracle as a target for DMS][2] in the + # *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib # # @option params [Types::SybaseSettings] :sybase_settings # Settings in JSON format for the source and target SAP ASE endpoint. # For information about other available settings, see [Extra connection - # attributes when using SAP ASE as a source for AWS DMS][1] and [Extra - # connection attributes when using SAP ASE as a target for AWS DMS][2] - # in the *AWS Database Migration Service User Guide.* + # attributes when using SAP ASE as a source for DMS][1] and [Extra + # connection attributes when using SAP ASE as a target for DMS][2] in + # the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib # # @option params [Types::MicrosoftSQLServerSettings] :microsoft_sql_server_settings # Settings in JSON format for the source and target Microsoft SQL Server # endpoint. For information about other available settings, see [Extra - # connection attributes when using SQL Server as a source for AWS - # DMS][1] and [ Extra connection attributes when using SQL Server as a - # target for AWS DMS][2] in the *AWS Database Migration Service User - # Guide.* + # connection attributes when using SQL Server as a source for DMS][1] + # and [ Extra connection attributes when using SQL Server as a target + # for DMS][2] in the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib # # @option params [Types::IBMDb2Settings] :ibm_db_2_settings # Settings in JSON format for the source IBM Db2 LUW endpoint. For # information about other available settings, see [Extra connection - # attributes when using Db2 LUW as a source for AWS DMS][1] in the *AWS - # Database Migration Service User Guide.* + # attributes when using Db2 LUW as a source for DMS][1] in the *Database + # Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib # # @option params [String] :resource_identifier # A friendly name for the resource identifier at the end of the # `EndpointArn` response parameter that is returned in the created # `Endpoint` object. The value for this parameter can have up to 31 # characters. It can contain only ASCII letters, digits, and hyphen # ('-'). Also, it can't end with a hyphen or contain two consecutive # hyphens, and can only begin with a letter, such as `Example-App-ARN1`. # For example, this value might result in the `EndpointArn` value # `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you - # don't specify a `ResourceIdentifier` value, AWS DMS generates a - # default identifier value for the end of `EndpointArn`. + # don't specify a `ResourceIdentifier` value, DMS generates a default + # identifier value for the end of `EndpointArn`. # # @option params [Types::DocDbSettings] :doc_db_settings # Provides information that defines a DocumentDB endpoint. # # @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -887,10 +889,11 @@ # include_partition_value: false, # partition_include_schema_table: false, # include_table_alter_operations: false, # include_control_details: false, # include_null_and_empty: false, + # no_hex_prefix: false, # }, # kafka_settings: { # broker: "String", # topic: "String", # message_format: "json", # accepts json, json-unformatted @@ -906,10 +909,11 @@ # ssl_client_key_arn: "String", # ssl_client_key_password: "SecretString", # ssl_ca_certificate_arn: "String", # sasl_username: "String", # sasl_password: "SecretString", + # no_hex_prefix: false, # }, # elasticsearch_settings: { # service_access_role_arn: "String", # required # endpoint_uri: "String", # required # full_load_error_percentage: 1, @@ -962,15 +966,19 @@ # max_file_size: 1, # database_name: "String", # ddl_artifacts_schema: "String", # execute_timeout: 1, # fail_tasks_on_lob_truncation: false, + # heartbeat_enable: false, + # heartbeat_schema: "String", + # heartbeat_frequency: 1, # password: "SecretString", # port: 1, # server_name: "String", # username: "String", # slot_name: "String", + # plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical # secrets_manager_access_role_arn: "String", # secrets_manager_secret_id: "String", # }, # my_sql_settings: { # after_connect_script: "String", @@ -1017,11 +1025,15 @@ # retry_interval: 1, # security_db_encryption: "SecretString", # security_db_encryption_name: "String", # server_name: "String", # spatial_data_option_to_geo_json_function_name: "String", + # standby_delay_time: 1, # username: "String", + # use_b_file: false, + # use_direct_path_full_load: false, + # use_logminer_reader: false, # secrets_manager_access_role_arn: "String", # secrets_manager_secret_id: "String", # secrets_manager_oracle_asm_access_role_arn: "String", # secrets_manager_oracle_asm_secret_id: "String", # }, @@ -1149,10 +1161,11 @@ # resp.endpoint.kinesis_settings.include_partition_value #=> Boolean # resp.endpoint.kinesis_settings.partition_include_schema_table #=> Boolean # resp.endpoint.kinesis_settings.include_table_alter_operations #=> Boolean # resp.endpoint.kinesis_settings.include_control_details #=> Boolean # resp.endpoint.kinesis_settings.include_null_and_empty #=> Boolean + # resp.endpoint.kinesis_settings.no_hex_prefix #=> Boolean # resp.endpoint.kafka_settings.broker #=> String # resp.endpoint.kafka_settings.topic #=> String # resp.endpoint.kafka_settings.message_format #=> String, one of "json", "json-unformatted" # resp.endpoint.kafka_settings.include_transaction_details #=> Boolean # resp.endpoint.kafka_settings.include_partition_value #=> Boolean @@ -1166,10 +1179,11 @@ # resp.endpoint.kafka_settings.ssl_client_key_arn #=> String # resp.endpoint.kafka_settings.ssl_client_key_password #=> String # resp.endpoint.kafka_settings.ssl_ca_certificate_arn #=> String # resp.endpoint.kafka_settings.sasl_username #=> String # resp.endpoint.kafka_settings.sasl_password #=> String + # resp.endpoint.kafka_settings.no_hex_prefix #=> Boolean # resp.endpoint.elasticsearch_settings.service_access_role_arn #=> String # resp.endpoint.elasticsearch_settings.endpoint_uri #=> String # resp.endpoint.elasticsearch_settings.full_load_error_percentage #=> Integer # resp.endpoint.elasticsearch_settings.error_retry_duration #=> Integer # resp.endpoint.neptune_settings.service_access_role_arn #=> String @@ -1214,15 +1228,19 @@ # resp.endpoint.postgre_sql_settings.max_file_size #=> Integer # resp.endpoint.postgre_sql_settings.database_name #=> String # resp.endpoint.postgre_sql_settings.ddl_artifacts_schema #=> String # resp.endpoint.postgre_sql_settings.execute_timeout #=> Integer # resp.endpoint.postgre_sql_settings.fail_tasks_on_lob_truncation #=> Boolean + # resp.endpoint.postgre_sql_settings.heartbeat_enable #=> Boolean + # resp.endpoint.postgre_sql_settings.heartbeat_schema #=> String + # resp.endpoint.postgre_sql_settings.heartbeat_frequency #=> Integer # resp.endpoint.postgre_sql_settings.password #=> String # resp.endpoint.postgre_sql_settings.port #=> Integer # resp.endpoint.postgre_sql_settings.server_name #=> String # resp.endpoint.postgre_sql_settings.username #=> String # resp.endpoint.postgre_sql_settings.slot_name #=> String + # resp.endpoint.postgre_sql_settings.plugin_name #=> String, one of "no-preference", "test-decoding", "pglogical" # resp.endpoint.postgre_sql_settings.secrets_manager_access_role_arn #=> String # resp.endpoint.postgre_sql_settings.secrets_manager_secret_id #=> String # resp.endpoint.my_sql_settings.after_connect_script #=> String # resp.endpoint.my_sql_settings.clean_source_metadata_on_mismatch #=> Boolean # resp.endpoint.my_sql_settings.database_name #=> String @@ -1265,11 +1283,15 @@ # resp.endpoint.oracle_settings.retry_interval #=> Integer # resp.endpoint.oracle_settings.security_db_encryption #=> String # resp.endpoint.oracle_settings.security_db_encryption_name #=> String # resp.endpoint.oracle_settings.server_name #=> String # resp.endpoint.oracle_settings.spatial_data_option_to_geo_json_function_name #=> String + # resp.endpoint.oracle_settings.standby_delay_time #=> Integer # resp.endpoint.oracle_settings.username #=> String + # resp.endpoint.oracle_settings.use_b_file #=> Boolean + # resp.endpoint.oracle_settings.use_direct_path_full_load #=> Boolean + # resp.endpoint.oracle_settings.use_logminer_reader #=> Boolean # resp.endpoint.oracle_settings.secrets_manager_access_role_arn #=> String # resp.endpoint.oracle_settings.secrets_manager_secret_id #=> String # resp.endpoint.oracle_settings.secrets_manager_oracle_asm_access_role_arn #=> String # resp.endpoint.oracle_settings.secrets_manager_oracle_asm_secret_id #=> String # resp.endpoint.sybase_settings.database_name #=> String @@ -1322,61 +1344,60 @@ def create_endpoint(params = {}, options = {}) req = build_request(:create_endpoint, params) req.send_request(options) end - # Creates an AWS DMS event notification subscription. + # Creates an DMS event notification subscription. # # You can specify the type of source (`SourceType`) you want to be - # notified of, provide a list of AWS DMS source IDs (`SourceIds`) that + # notified of, provide a list of DMS source IDs (`SourceIds`) that # triggers the events, and provide a list of event categories # (`EventCategories`) for events you want to be notified of. If you # specify both the `SourceType` and `SourceIds`, such as `SourceType = # replication-instance` and `SourceIdentifier = my-replinstance`, you # will be notified of all the replication instance events for the # specified source. If you specify a `SourceType` but don't specify a # `SourceIdentifier`, you receive notice of the events for that source - # type for all your AWS DMS sources. If you don't specify either + # type for all your DMS sources. If you don't specify either # `SourceType` nor `SourceIdentifier`, you will be notified of events - # generated from all AWS DMS sources belonging to your customer account. + # generated from all DMS sources belonging to your customer account. # - # For more information about AWS DMS events, see [Working with Events - # and Notifications][1] in the *AWS Database Migration Service User - # Guide.* + # For more information about DMS events, see [Working with Events and + # Notifications][1] in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html # # @option params [required, String] :subscription_name - # The name of the AWS DMS event notification subscription. This name - # must be less than 255 characters. + # The name of the DMS event notification subscription. This name must be + # less than 255 characters. # # @option params [required, String] :sns_topic_arn # The Amazon Resource Name (ARN) of the Amazon SNS topic created for # event notification. The ARN is created by Amazon SNS when you create a # topic and subscribe to it. # # @option params [String] :source_type - # The type of AWS DMS resource that generates the events. For example, - # if you want to be notified of events generated by a replication - # instance, you set this parameter to `replication-instance`. If this - # value isn't specified, all events are returned. + # The type of DMS resource that generates the events. For example, if + # you want to be notified of events generated by a replication instance, + # you set this parameter to `replication-instance`. If this value isn't + # specified, all events are returned. # # Valid values: `replication-instance` \| `replication-task` # # @option params [Array<String>] :event_categories # A list of event categories for a source type that you want to # subscribe to. For more information, see [Working with Events and - # Notifications][1] in the *AWS Database Migration Service User Guide.* + # Notifications][1] in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html # # @option params [Array<String>] :source_ids - # A list of identifiers for which AWS DMS provides notification events. + # A list of identifiers for which DMS provides notification events. # # If you don't specify a value, notifications are provided for all # sources. # # If you specify multiple values, they must be of the same type. For @@ -1434,15 +1455,15 @@ req.send_request(options) end # Creates the replication instance using the specified parameters. # - # AWS DMS requires that your account have certain roles with appropriate + # DMS requires that your account have certain roles with appropriate # permissions before you can create a replication instance. For # information on the required roles, see [Creating the IAM Roles to Use - # With the AWS CLI and AWS DMS API][1]. For information on the required - # permissions, see [IAM Permissions Needed to Use AWS DMS][2]. + # With the CLI and DMS API][1]. For information on the required + # permissions, see [IAM Permissions Needed to Use DMS][2]. # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.IAMPermissions @@ -1470,11 +1491,11 @@ # for the specified replication instance class. For example to specify # the instance class dms.c4.large, set this parameter to # `"dms.c4.large"`. # # For more information on the settings and capacities for the available - # replication instance classes, see [ Selecting the right AWS DMS + # replication instance classes, see [ Selecting the right DMS # replication instance for your migration][1]. # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth @@ -1485,11 +1506,11 @@ # replication instance. # # @option params [String] :availability_zone # The Availability Zone where the replication instance will be created. # The default value is a random, system-chosen Availability Zone in the - # endpoint's AWS Region, for example: `us-east-1d` + # endpoint's Region, for example: `us-east-1d` # # @option params [String] :replication_subnet_group_identifier # A subnet group to associate with the replication instance. # # @option params [String] :preferred_maintenance_window @@ -1497,11 +1518,11 @@ # Universal Coordinated Time (UTC). # # Format: `ddd:hh24:mi-ddd:hh24:mi` # # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region, occurring on a random day of the week. + # time per Region, occurring on a random day of the week. # # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun # # Constraints: Minimum 30-minute window. # @@ -1526,19 +1547,18 @@ # # @option params [Array<Types::Tag>] :tags # One or more tags to be assigned to the replication instance. # # @option params [String] :kms_key_id - # An AWS KMS key identifier that is used to encrypt the data on the + # An KMS key identifier that is used to encrypt the data on the # replication instance. # - # If you don't specify a value for the `KmsKeyId` parameter, then AWS - # DMS uses your default encryption key. + # If you don't specify a value for the `KmsKeyId` parameter, then DMS + # uses your default encryption key. # - # AWS KMS creates the default encryption key for your AWS account. Your - # AWS account has a different default encryption key for each AWS - # Region. + # KMS creates the default encryption key for your account. Your account + # has a different default encryption key for each Region. # # @option params [Boolean] :publicly_accessible # Specifies the accessibility options for the replication instance. A # value of `true` represents an instance with a public IP address. A # value of `false` represents an instance with a private IP address. The @@ -1559,12 +1579,12 @@ # characters. It can contain only ASCII letters, digits, and hyphen # ('-'). Also, it can't end with a hyphen or contain two consecutive # hyphens, and can only begin with a letter, such as `Example-App-ARN1`. # For example, this value might result in the `EndpointArn` value # `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you - # don't specify a `ResourceIdentifier` value, AWS DMS generates a - # default identifier value for the end of `EndpointArn`. + # don't specify a `ResourceIdentifier` value, DMS generates a default + # identifier value for the end of `EndpointArn`. # # @return [Types::CreateReplicationInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateReplicationInstanceResponse#replication_instance #replication_instance} => Types::ReplicationInstance # @@ -1836,21 +1856,21 @@ # The migration type. Valid values: `full-load` \| `cdc` \| # `full-load-and-cdc` # # @option params [required, String] :table_mappings # The table mappings for the task, in JSON format. For more information, - # see [Using Table Mapping to Specify Task Settings][1] in the *AWS - # Database Migration Service User Guide.* + # see [Using Table Mapping to Specify Task Settings][1] in the *Database + # Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html # # @option params [String] :replication_task_settings # Overall settings for the task, in JSON format. For more information, - # see [Specifying Task Settings for AWS Database Migration Service - # Tasks][1] in the *AWS Database Migration User Guide.* + # see [Specifying Task Settings for Database Migration Service Tasks][1] + # in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html # @@ -1879,11 +1899,11 @@ # <note markdown="1"> When you use this task setting with a source PostgreSQL database, a # logical replication slot should already be created and associated with # the source endpoint. You can verify this by setting the `slotName` # extra connection attribute to the name of this logical replication # slot. For more information, see [Extra Connection Attributes When - # Using PostgreSQL as a Source for AWS DMS][1]. + # Using PostgreSQL as a Source for DMS][1]. # # </note> # # # @@ -1903,12 +1923,12 @@ # One or more tags to be assigned to the replication task. # # @option params [String] :task_data # Supplemental information that the task requires to migrate the data # for certain source and target endpoints. For more information, see - # [Specifying Supplemental Data for Task Settings][1] in the *AWS - # Database Migration Service User Guide.* + # [Specifying Supplemental Data for Task Settings][1] in the *Database + # Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html # @@ -1919,12 +1939,12 @@ # characters. It can contain only ASCII letters, digits, and hyphen # ('-'). Also, it can't end with a hyphen or contain two consecutive # hyphens, and can only begin with a letter, such as `Example-App-ARN1`. # For example, this value might result in the `EndpointArn` value # `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`. If you - # don't specify a `ResourceIdentifier` value, AWS DMS generates a - # default identifier value for the end of `EndpointArn`. + # don't specify a `ResourceIdentifier` value, DMS generates a default + # identifier value for the end of `EndpointArn`. # # @return [Types::CreateReplicationTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateReplicationTaskResponse#replication_task #replication_task} => Types::ReplicationTask # @@ -2253,10 +2273,11 @@ # resp.endpoint.kinesis_settings.include_partition_value #=> Boolean # resp.endpoint.kinesis_settings.partition_include_schema_table #=> Boolean # resp.endpoint.kinesis_settings.include_table_alter_operations #=> Boolean # resp.endpoint.kinesis_settings.include_control_details #=> Boolean # resp.endpoint.kinesis_settings.include_null_and_empty #=> Boolean + # resp.endpoint.kinesis_settings.no_hex_prefix #=> Boolean # resp.endpoint.kafka_settings.broker #=> String # resp.endpoint.kafka_settings.topic #=> String # resp.endpoint.kafka_settings.message_format #=> String, one of "json", "json-unformatted" # resp.endpoint.kafka_settings.include_transaction_details #=> Boolean # resp.endpoint.kafka_settings.include_partition_value #=> Boolean @@ -2270,10 +2291,11 @@ # resp.endpoint.kafka_settings.ssl_client_key_arn #=> String # resp.endpoint.kafka_settings.ssl_client_key_password #=> String # resp.endpoint.kafka_settings.ssl_ca_certificate_arn #=> String # resp.endpoint.kafka_settings.sasl_username #=> String # resp.endpoint.kafka_settings.sasl_password #=> String + # resp.endpoint.kafka_settings.no_hex_prefix #=> Boolean # resp.endpoint.elasticsearch_settings.service_access_role_arn #=> String # resp.endpoint.elasticsearch_settings.endpoint_uri #=> String # resp.endpoint.elasticsearch_settings.full_load_error_percentage #=> Integer # resp.endpoint.elasticsearch_settings.error_retry_duration #=> Integer # resp.endpoint.neptune_settings.service_access_role_arn #=> String @@ -2318,15 +2340,19 @@ # resp.endpoint.postgre_sql_settings.max_file_size #=> Integer # resp.endpoint.postgre_sql_settings.database_name #=> String # resp.endpoint.postgre_sql_settings.ddl_artifacts_schema #=> String # resp.endpoint.postgre_sql_settings.execute_timeout #=> Integer # resp.endpoint.postgre_sql_settings.fail_tasks_on_lob_truncation #=> Boolean + # resp.endpoint.postgre_sql_settings.heartbeat_enable #=> Boolean + # resp.endpoint.postgre_sql_settings.heartbeat_schema #=> String + # resp.endpoint.postgre_sql_settings.heartbeat_frequency #=> Integer # resp.endpoint.postgre_sql_settings.password #=> String # resp.endpoint.postgre_sql_settings.port #=> Integer # resp.endpoint.postgre_sql_settings.server_name #=> String # resp.endpoint.postgre_sql_settings.username #=> String # resp.endpoint.postgre_sql_settings.slot_name #=> String + # resp.endpoint.postgre_sql_settings.plugin_name #=> String, one of "no-preference", "test-decoding", "pglogical" # resp.endpoint.postgre_sql_settings.secrets_manager_access_role_arn #=> String # resp.endpoint.postgre_sql_settings.secrets_manager_secret_id #=> String # resp.endpoint.my_sql_settings.after_connect_script #=> String # resp.endpoint.my_sql_settings.clean_source_metadata_on_mismatch #=> Boolean # resp.endpoint.my_sql_settings.database_name #=> String @@ -2369,11 +2395,15 @@ # resp.endpoint.oracle_settings.retry_interval #=> Integer # resp.endpoint.oracle_settings.security_db_encryption #=> String # resp.endpoint.oracle_settings.security_db_encryption_name #=> String # resp.endpoint.oracle_settings.server_name #=> String # resp.endpoint.oracle_settings.spatial_data_option_to_geo_json_function_name #=> String + # resp.endpoint.oracle_settings.standby_delay_time #=> Integer # resp.endpoint.oracle_settings.username #=> String + # resp.endpoint.oracle_settings.use_b_file #=> Boolean + # resp.endpoint.oracle_settings.use_direct_path_full_load #=> Boolean + # resp.endpoint.oracle_settings.use_logminer_reader #=> Boolean # resp.endpoint.oracle_settings.secrets_manager_access_role_arn #=> String # resp.endpoint.oracle_settings.secrets_manager_secret_id #=> String # resp.endpoint.oracle_settings.secrets_manager_oracle_asm_access_role_arn #=> String # resp.endpoint.oracle_settings.secrets_manager_oracle_asm_secret_id #=> String # resp.endpoint.sybase_settings.database_name #=> String @@ -2426,11 +2456,11 @@ def delete_endpoint(params = {}, options = {}) req = build_request(:delete_endpoint, params) req.send_request(options) end - # Deletes an AWS DMS event subscription. + # Deletes an DMS event subscription. # # @option params [required, String] :subscription_name # The name of the DMS event notification subscription to be deleted. # # @return [Types::DeleteEventSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -2716,11 +2746,11 @@ req.send_request(options) end # Deletes the record of a single premigration assessment run. # - # This operation removes all metadata that AWS DMS maintains about this + # This operation removes all metadata that DMS maintains about this # assessment run. However, the operation leaves untouched all # information about this assessment run that is stored in your Amazon S3 # bucket. # # @option params [required, String] :replication_task_assessment_run_arn @@ -2760,12 +2790,12 @@ def delete_replication_task_assessment_run(params = {}, options = {}) req = build_request(:delete_replication_task_assessment_run, params) req.send_request(options) end - # Lists all of the AWS DMS attributes for a customer account. These - # attributes include AWS DMS quotas for the account and a unique account + # Lists all of the DMS attributes for a customer account. These + # attributes include DMS quotas for the account and a unique account # identifier in a particular DMS region. DMS quotas include a list of # resource quotas supported by the account, such as the number of # replication instances allowed. The description for each resource # quota, includes the quota name, current usage toward that quota, and # the quota's maximum value. DMS uses the unique account identifier to @@ -3149,10 +3179,11 @@ # resp.endpoint_settings[0].sensitive #=> Boolean # resp.endpoint_settings[0].units #=> String # resp.endpoint_settings[0].applicability #=> String # resp.endpoint_settings[0].int_value_min #=> Integer # resp.endpoint_settings[0].int_value_max #=> Integer + # resp.endpoint_settings[0].default_value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/dms-2016-01-01/DescribeEndpointSettings AWS API Documentation # # @overload describe_endpoint_settings(params = {}) # @param [Hash] params ({}) @@ -3391,10 +3422,11 @@ # resp.endpoints[0].kinesis_settings.include_partition_value #=> Boolean # resp.endpoints[0].kinesis_settings.partition_include_schema_table #=> Boolean # resp.endpoints[0].kinesis_settings.include_table_alter_operations #=> Boolean # resp.endpoints[0].kinesis_settings.include_control_details #=> Boolean # resp.endpoints[0].kinesis_settings.include_null_and_empty #=> Boolean + # resp.endpoints[0].kinesis_settings.no_hex_prefix #=> Boolean # resp.endpoints[0].kafka_settings.broker #=> String # resp.endpoints[0].kafka_settings.topic #=> String # resp.endpoints[0].kafka_settings.message_format #=> String, one of "json", "json-unformatted" # resp.endpoints[0].kafka_settings.include_transaction_details #=> Boolean # resp.endpoints[0].kafka_settings.include_partition_value #=> Boolean @@ -3408,10 +3440,11 @@ # resp.endpoints[0].kafka_settings.ssl_client_key_arn #=> String # resp.endpoints[0].kafka_settings.ssl_client_key_password #=> String # resp.endpoints[0].kafka_settings.ssl_ca_certificate_arn #=> String # resp.endpoints[0].kafka_settings.sasl_username #=> String # resp.endpoints[0].kafka_settings.sasl_password #=> String + # resp.endpoints[0].kafka_settings.no_hex_prefix #=> Boolean # resp.endpoints[0].elasticsearch_settings.service_access_role_arn #=> String # resp.endpoints[0].elasticsearch_settings.endpoint_uri #=> String # resp.endpoints[0].elasticsearch_settings.full_load_error_percentage #=> Integer # resp.endpoints[0].elasticsearch_settings.error_retry_duration #=> Integer # resp.endpoints[0].neptune_settings.service_access_role_arn #=> String @@ -3456,15 +3489,19 @@ # resp.endpoints[0].postgre_sql_settings.max_file_size #=> Integer # resp.endpoints[0].postgre_sql_settings.database_name #=> String # resp.endpoints[0].postgre_sql_settings.ddl_artifacts_schema #=> String # resp.endpoints[0].postgre_sql_settings.execute_timeout #=> Integer # resp.endpoints[0].postgre_sql_settings.fail_tasks_on_lob_truncation #=> Boolean + # resp.endpoints[0].postgre_sql_settings.heartbeat_enable #=> Boolean + # resp.endpoints[0].postgre_sql_settings.heartbeat_schema #=> String + # resp.endpoints[0].postgre_sql_settings.heartbeat_frequency #=> Integer # resp.endpoints[0].postgre_sql_settings.password #=> String # resp.endpoints[0].postgre_sql_settings.port #=> Integer # resp.endpoints[0].postgre_sql_settings.server_name #=> String # resp.endpoints[0].postgre_sql_settings.username #=> String # resp.endpoints[0].postgre_sql_settings.slot_name #=> String + # resp.endpoints[0].postgre_sql_settings.plugin_name #=> String, one of "no-preference", "test-decoding", "pglogical" # resp.endpoints[0].postgre_sql_settings.secrets_manager_access_role_arn #=> String # resp.endpoints[0].postgre_sql_settings.secrets_manager_secret_id #=> String # resp.endpoints[0].my_sql_settings.after_connect_script #=> String # resp.endpoints[0].my_sql_settings.clean_source_metadata_on_mismatch #=> Boolean # resp.endpoints[0].my_sql_settings.database_name #=> String @@ -3507,11 +3544,15 @@ # resp.endpoints[0].oracle_settings.retry_interval #=> Integer # resp.endpoints[0].oracle_settings.security_db_encryption #=> String # resp.endpoints[0].oracle_settings.security_db_encryption_name #=> String # resp.endpoints[0].oracle_settings.server_name #=> String # resp.endpoints[0].oracle_settings.spatial_data_option_to_geo_json_function_name #=> String + # resp.endpoints[0].oracle_settings.standby_delay_time #=> Integer # resp.endpoints[0].oracle_settings.username #=> String + # resp.endpoints[0].oracle_settings.use_b_file #=> Boolean + # resp.endpoints[0].oracle_settings.use_direct_path_full_load #=> Boolean + # resp.endpoints[0].oracle_settings.use_logminer_reader #=> Boolean # resp.endpoints[0].oracle_settings.secrets_manager_access_role_arn #=> String # resp.endpoints[0].oracle_settings.secrets_manager_secret_id #=> String # resp.endpoints[0].oracle_settings.secrets_manager_oracle_asm_access_role_arn #=> String # resp.endpoints[0].oracle_settings.secrets_manager_oracle_asm_secret_id #=> String # resp.endpoints[0].sybase_settings.database_name #=> String @@ -3571,19 +3612,19 @@ req.send_request(options) end # Lists categories for all event source types, or, if specified, for a # specified source type. You can see a list of the event categories and - # source types in [Working with Events and Notifications][1] in the *AWS - # Database Migration Service User Guide.* + # source types in [Working with Events and Notifications][1] in the + # *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html # # @option params [String] :source_type - # The type of AWS DMS resource that generates events. + # The type of DMS resource that generates events. # # Valid values: replication-instance \| replication-task # # @option params [Array<Types::Filter>] :filters # Filters applied to the event categories. @@ -3627,11 +3668,11 @@ # # If you specify `SubscriptionName`, this action lists the description # for that subscription. # # @option params [String] :subscription_name - # The name of the AWS DMS event subscription to be described. + # The name of the DMS event subscription to be described. # # @option params [Array<Types::Filter>] :filters # Filters applied to event subscriptions. # # @option params [Integer] :max_records @@ -3694,23 +3735,23 @@ req = build_request(:describe_event_subscriptions, params) req.send_request(options) end # Lists events for a given source identifier and source type. You can - # also specify a start and end time. For more information on AWS DMS - # events, see [Working with Events and Notifications][1] in the *AWS - # Database Migration User Guide.* + # also specify a start and end time. For more information on DMS events, + # see [Working with Events and Notifications][1] in the *Database + # Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html # # @option params [String] :source_identifier # The identifier of an event source. # # @option params [String] :source_type - # The type of AWS DMS resource that generates events. + # The type of DMS resource that generates events. # # Valid values: replication-instance \| replication-task # # @option params [Time,DateTime,Date,Integer,String] :start_time # The start time for the events to be listed. @@ -4244,13 +4285,23 @@ def describe_replication_subnet_groups(params = {}, options = {}) req = build_request(:describe_replication_subnet_groups, params) req.send_request(options) end - # Returns the task assessment results from Amazon S3. This action always - # returns the latest results. + # Returns the task assessment results from the Amazon S3 bucket that DMS + # creates in your account. This action always returns the latest + # results. # + # For more information about DMS task assessments, see [Creating a task + # assessment report][1] in the [ Database Migration Service User + # Guide][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html + # [2]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/Welcome.html + # # @option params [String] :replication_task_arn # The Amazon Resource Name (ARN) string that uniquely identifies the # task. When this input parameter is specified, the API returns only one # result and ignore the values of the `MaxRecords` and `Marker` # parameters. @@ -4647,11 +4698,11 @@ # Returns table statistics on the database migration task, including # table name, rows inserted, rows updated, and rows deleted. # # Note that the "last updated" column the DMS console only indicates - # the time that AWS DMS last updated the table statistics record for a + # the time that DMS last updated the table statistics record for a # table. It does not indicate the time of the last update to the table. # # @option params [required, String] :replication_task_arn # The Amazon Resource Name (ARN) of the replication task. # @@ -4765,11 +4816,12 @@ # @option params [String] :certificate_pem # The contents of a `.pem` file, which contains an X.509 certificate. # # @option params [String, StringIO, File] :certificate_wallet # The location of an imported Oracle Wallet certificate for use with - # SSL. + # SSL. Provide the name of a `.sso` file using the `fileb://` prefix. + # You can't provide the certificate inline. # # @option params [Array<Types::Tag>] :tags # The tags associated with the certificate. # # @return [Types::ImportCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -4826,21 +4878,21 @@ def import_certificate(params = {}, options = {}) req = build_request(:import_certificate, params) req.send_request(options) end - # Lists all metadata tags attached to an AWS DMS resource, including + # Lists all metadata tags attached to an DMS resource, including # replication instance, endpoint, security group, and migration task. # For more information, see [ `Tag` ][1] data type description. # # # # [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html # # @option params [required, String] :resource_arn - # The Amazon Resource Name (ARN) string that uniquely identifies the AWS - # DMS resource. + # The Amazon Resource Name (ARN) string that uniquely identifies the DMS + # resource. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tag_list #tag_list} => Array&lt;Types::Tag&gt; # @@ -4880,10 +4932,19 @@ req.send_request(options) end # Modifies the specified endpoint. # + # <note markdown="1"> For a MySQL source or target endpoint, don't explicitly specify the + # database using the `DatabaseName` request parameter on the + # `ModifyEndpoint` API call. Specifying `DatabaseName` when you modify a + # MySQL endpoint replicates all the task tables to this single database. + # For MySQL endpoints, you specify the database only when you specify + # the schema in the table-mapping rules of the DMS task. + # + # </note> + # # @option params [required, String] :endpoint_arn # The Amazon Resource Name (ARN) string that uniquely identifies the # endpoint. # # @option params [String] :endpoint_identifier @@ -4913,11 +4974,12 @@ # # @option params [Integer] :port # The port used by the endpoint database. # # @option params [String] :database_name - # The name of the endpoint database. + # The name of the endpoint database. For a MySQL source or target + # endpoint, do not specify DatabaseName. # # @option params [String] :extra_connection_attributes # Additional attributes associated with the connection. To reset this # parameter, pass the empty string ("") as an argument. # @@ -4928,31 +4990,31 @@ # @option params [String] :ssl_mode # The SSL mode used to connect to the endpoint. The default value is # `none`. # # @option params [String] :service_access_role_arn - # The Amazon Resource Name (ARN) for the service access role you want to - # use to modify the endpoint. + # The Amazon Resource Name (ARN) for the IAM role you want to use to + # modify the endpoint. The role must allow the `iam:PassRole` action. # # @option params [String] :external_table_definition # The external table definition. # # @option params [Types::DynamoDbSettings] :dynamo_db_settings # Settings in JSON format for the target Amazon DynamoDB endpoint. For # information about other available settings, see [Using Object Mapping - # to Migrate Data to DynamoDB][1] in the *AWS Database Migration Service + # to Migrate Data to DynamoDB][1] in the *Database Migration Service # User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping # # @option params [Types::S3Settings] :s3_settings # Settings in JSON format for the target Amazon S3 endpoint. For more # information about the available settings, see [Extra Connection - # Attributes When Using Amazon S3 as a Target for AWS DMS][1] in the - # *AWS Database Migration Service User Guide.* + # Attributes When Using Amazon S3 as a Target for DMS][1] in the + # *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring # @@ -4960,74 +5022,68 @@ # The settings in JSON format for the DMS transfer type of source # endpoint. # # Attributes include the following: # - # * serviceAccessRoleArn - The AWS Identity and Access Management (IAM) - # role that has permission to access the Amazon S3 bucket. + # * serviceAccessRoleArn - The Identity and Access Management (IAM) role + # that has permission to access the Amazon S3 bucket. The role must + # allow the `iam:PassRole` action. # # * BucketName - The name of the S3 bucket to use. # - # * compressionType - An optional parameter to use GZIP to compress the - # target files. Either set this parameter to NONE (the default) or - # don't use it to leave the files uncompressed. - # # Shorthand syntax for these settings is as follows: - # `ServiceAccessRoleArn=string - # ,BucketName=string,CompressionType=string` + # `ServiceAccessRoleArn=string ,BucketName=string` # # JSON syntax for these settings is as follows: `\{ - # "ServiceAccessRoleArn": "string", "BucketName": "string", - # "CompressionType": "none"|"gzip" \} ` + # "ServiceAccessRoleArn": "string", "BucketName": "string"\} ` # # @option params [Types::MongoDbSettings] :mongo_db_settings # Settings in JSON format for the source MongoDB endpoint. For more # information about the available settings, see the configuration - # properties section in [ Using MongoDB as a Target for AWS Database - # Migration Service][1] in the *AWS Database Migration Service User - # Guide.* + # properties section in [Endpoint configuration settings when using + # MongoDB as a source for Database Migration Service][1] in the + # *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration # # @option params [Types::KinesisSettings] :kinesis_settings # Settings in JSON format for the target endpoint for Amazon Kinesis # Data Streams. For more information about the available settings, see - # [Using Amazon Kinesis Data Streams as a Target for AWS Database - # Migration Service][1] in the *AWS Database Migration Service User - # Guide.* + # [Using object mapping to migrate data to a Kinesis data stream][1] in + # the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping # # @option params [Types::KafkaSettings] :kafka_settings # Settings in JSON format for the target Apache Kafka endpoint. For more - # information about the available settings, see [Using Apache Kafka as a - # Target for AWS Database Migration Service][1] in the *AWS Database - # Migration Service User Guide.* + # information about the available settings, see [Using object mapping to + # migrate data to a Kafka topic][1] in the *Database Migration Service + # User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping # # @option params [Types::ElasticsearchSettings] :elasticsearch_settings # Settings in JSON format for the target Elasticsearch endpoint. For # more information about the available settings, see [Extra Connection - # Attributes When Using Elasticsearch as a Target for AWS DMS][1] in the - # *AWS Database Migration Service User Guide.* + # Attributes When Using Elasticsearch as a Target for DMS][1] in the + # *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration # # @option params [Types::NeptuneSettings] :neptune_settings # Settings in JSON format for the target Amazon Neptune endpoint. For # more information about the available settings, see [Specifying - # Endpoint Settings for Amazon Neptune as a Target][1] in the *AWS - # Database Migration Service User Guide.* + # graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a + # target][1] in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings # @@ -5035,90 +5091,111 @@ # Provides information that defines an Amazon Redshift endpoint. # # @option params [Types::PostgreSQLSettings] :postgre_sql_settings # Settings in JSON format for the source and target PostgreSQL endpoint. # For information about other available settings, see [Extra connection - # attributes when using PostgreSQL as a source for AWS DMS][1] and [ - # Extra connection attributes when using PostgreSQL as a target for AWS - # DMS][2] in the *AWS Database Migration Service User Guide.* + # attributes when using PostgreSQL as a source for DMS][1] and [ Extra + # connection attributes when using PostgreSQL as a target for DMS][2] in + # the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.ConnectionAttrib - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.ConnectionAttrib + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib # # @option params [Types::MySQLSettings] :my_sql_settings # Settings in JSON format for the source and target MySQL endpoint. For # information about other available settings, see [Extra connection - # attributes when using MySQL as a source for AWS DMS][1] and [Extra + # attributes when using MySQL as a source for DMS][1] and [Extra # connection attributes when using a MySQL-compatible database as a - # target for AWS DMS][2] in the *AWS Database Migration Service User - # Guide.* + # target for DMS][2] in the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.ConnectionAttrib - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.ConnectionAttrib + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib # # @option params [Types::OracleSettings] :oracle_settings # Settings in JSON format for the source and target Oracle endpoint. For # information about other available settings, see [Extra connection - # attributes when using Oracle as a source for AWS DMS][1] and [ Extra - # connection attributes when using Oracle as a target for AWS DMS][2] in - # the *AWS Database Migration Service User Guide.* + # attributes when using Oracle as a source for DMS][1] and [ Extra + # connection attributes when using Oracle as a target for DMS][2] in the + # *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.ConnectionAttrib - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.ConnectionAttrib + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib # # @option params [Types::SybaseSettings] :sybase_settings # Settings in JSON format for the source and target SAP ASE endpoint. # For information about other available settings, see [Extra connection - # attributes when using SAP ASE as a source for AWS DMS][1] and [Extra - # connection attributes when using SAP ASE as a target for AWS DMS][2] - # in the *AWS Database Migration Service User Guide.* + # attributes when using SAP ASE as a source for DMS][1] and [Extra + # connection attributes when using SAP ASE as a target for DMS][2] in + # the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.ConnectionAttrib - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.ConnectionAttrib + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib # # @option params [Types::MicrosoftSQLServerSettings] :microsoft_sql_server_settings # Settings in JSON format for the source and target Microsoft SQL Server # endpoint. For information about other available settings, see [Extra - # connection attributes when using SQL Server as a source for AWS - # DMS][1] and [ Extra connection attributes when using SQL Server as a - # target for AWS DMS][2] in the *AWS Database Migration Service User - # Guide.* + # connection attributes when using SQL Server as a source for DMS][1] + # and [ Extra connection attributes when using SQL Server as a target + # for DMS][2] in the *Database Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.ConnectionAttrib - # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.ConnectionAttrib + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib + # [2]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib # # @option params [Types::IBMDb2Settings] :ibm_db_2_settings # Settings in JSON format for the source IBM Db2 LUW endpoint. For # information about other available settings, see [Extra connection - # attributes when using Db2 LUW as a source for AWS DMS][1] in the *AWS - # Database Migration Service User Guide.* + # attributes when using Db2 LUW as a source for DMS][1] in the *Database + # Migration Service User Guide.* # # # - # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.ConnectionAttrib + # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib # # @option params [Types::DocDbSettings] :doc_db_settings # Settings in JSON format for the source DocumentDB endpoint. For more # information about the available settings, see the configuration - # properties section in [ Using DocumentDB as a Target for AWS Database - # Migration Service][1] in the *AWS Database Migration Service User - # Guide.* + # properties section in [ Using DocumentDB as a Target for Database + # Migration Service ][1] in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html # + # @option params [Boolean] :exact_settings + # If this attribute is Y, the current call to `ModifyEndpoint` replaces + # all existing endpoint settings with the exact settings that you + # specify in this call. If this attribute is N, the current call to + # `ModifyEndpoint` does two things: + # + # * It replaces any endpoint settings that already exist with new + # values, for settings with the same names. + # + # * It creates new endpoint settings that you specify in the call, for + # settings with different names. + # + # For example, if you call `create-endpoint ... --endpoint-settings + # '\{"a":1\}' ...`, the endpoint has the following endpoint settings: + # `'\{"a":1\}'`. If you then call `modify-endpoint ... + # --endpoint-settings '\{"b":2\}' ...` for the same endpoint, the + # endpoint has the following settings: `'\{"a":1,"b":2\}'`. + # + # However, suppose that you follow this with a call to `modify-endpoint + # ... --endpoint-settings '\{"b":2\}' --exact-settings ...` for that + # same endpoint again. Then the endpoint has the following settings: + # `'\{"b":2\}'`. All existing settings are replaced with the exact + # settings that you specify. + # # @return [Types::ModifyEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ModifyEndpointResponse#endpoint #endpoint} => Types::Endpoint # # @@ -5225,10 +5302,11 @@ # include_partition_value: false, # partition_include_schema_table: false, # include_table_alter_operations: false, # include_control_details: false, # include_null_and_empty: false, + # no_hex_prefix: false, # }, # kafka_settings: { # broker: "String", # topic: "String", # message_format: "json", # accepts json, json-unformatted @@ -5244,10 +5322,11 @@ # ssl_client_key_arn: "String", # ssl_client_key_password: "SecretString", # ssl_ca_certificate_arn: "String", # sasl_username: "String", # sasl_password: "SecretString", + # no_hex_prefix: false, # }, # elasticsearch_settings: { # service_access_role_arn: "String", # required # endpoint_uri: "String", # required # full_load_error_percentage: 1, @@ -5300,15 +5379,19 @@ # max_file_size: 1, # database_name: "String", # ddl_artifacts_schema: "String", # execute_timeout: 1, # fail_tasks_on_lob_truncation: false, + # heartbeat_enable: false, + # heartbeat_schema: "String", + # heartbeat_frequency: 1, # password: "SecretString", # port: 1, # server_name: "String", # username: "String", # slot_name: "String", + # plugin_name: "no-preference", # accepts no-preference, test-decoding, pglogical # secrets_manager_access_role_arn: "String", # secrets_manager_secret_id: "String", # }, # my_sql_settings: { # after_connect_script: "String", @@ -5355,11 +5438,15 @@ # retry_interval: 1, # security_db_encryption: "SecretString", # security_db_encryption_name: "String", # server_name: "String", # spatial_data_option_to_geo_json_function_name: "String", + # standby_delay_time: 1, # username: "String", + # use_b_file: false, + # use_direct_path_full_load: false, + # use_logminer_reader: false, # secrets_manager_access_role_arn: "String", # secrets_manager_secret_id: "String", # secrets_manager_oracle_asm_access_role_arn: "String", # secrets_manager_oracle_asm_secret_id: "String", # }, @@ -5411,10 +5498,11 @@ # docs_to_investigate: 1, # kms_key_id: "String", # secrets_manager_access_role_arn: "String", # secrets_manager_secret_id: "String", # }, + # exact_settings: false, # }) # # @example Response structure # # resp.endpoint.endpoint_identifier #=> String @@ -5486,10 +5574,11 @@ # resp.endpoint.kinesis_settings.include_partition_value #=> Boolean # resp.endpoint.kinesis_settings.partition_include_schema_table #=> Boolean # resp.endpoint.kinesis_settings.include_table_alter_operations #=> Boolean # resp.endpoint.kinesis_settings.include_control_details #=> Boolean # resp.endpoint.kinesis_settings.include_null_and_empty #=> Boolean + # resp.endpoint.kinesis_settings.no_hex_prefix #=> Boolean # resp.endpoint.kafka_settings.broker #=> String # resp.endpoint.kafka_settings.topic #=> String # resp.endpoint.kafka_settings.message_format #=> String, one of "json", "json-unformatted" # resp.endpoint.kafka_settings.include_transaction_details #=> Boolean # resp.endpoint.kafka_settings.include_partition_value #=> Boolean @@ -5503,10 +5592,11 @@ # resp.endpoint.kafka_settings.ssl_client_key_arn #=> String # resp.endpoint.kafka_settings.ssl_client_key_password #=> String # resp.endpoint.kafka_settings.ssl_ca_certificate_arn #=> String # resp.endpoint.kafka_settings.sasl_username #=> String # resp.endpoint.kafka_settings.sasl_password #=> String + # resp.endpoint.kafka_settings.no_hex_prefix #=> Boolean # resp.endpoint.elasticsearch_settings.service_access_role_arn #=> String # resp.endpoint.elasticsearch_settings.endpoint_uri #=> String # resp.endpoint.elasticsearch_settings.full_load_error_percentage #=> Integer # resp.endpoint.elasticsearch_settings.error_retry_duration #=> Integer # resp.endpoint.neptune_settings.service_access_role_arn #=> String @@ -5551,15 +5641,19 @@ # resp.endpoint.postgre_sql_settings.max_file_size #=> Integer # resp.endpoint.postgre_sql_settings.database_name #=> String # resp.endpoint.postgre_sql_settings.ddl_artifacts_schema #=> String # resp.endpoint.postgre_sql_settings.execute_timeout #=> Integer # resp.endpoint.postgre_sql_settings.fail_tasks_on_lob_truncation #=> Boolean + # resp.endpoint.postgre_sql_settings.heartbeat_enable #=> Boolean + # resp.endpoint.postgre_sql_settings.heartbeat_schema #=> String + # resp.endpoint.postgre_sql_settings.heartbeat_frequency #=> Integer # resp.endpoint.postgre_sql_settings.password #=> String # resp.endpoint.postgre_sql_settings.port #=> Integer # resp.endpoint.postgre_sql_settings.server_name #=> String # resp.endpoint.postgre_sql_settings.username #=> String # resp.endpoint.postgre_sql_settings.slot_name #=> String + # resp.endpoint.postgre_sql_settings.plugin_name #=> String, one of "no-preference", "test-decoding", "pglogical" # resp.endpoint.postgre_sql_settings.secrets_manager_access_role_arn #=> String # resp.endpoint.postgre_sql_settings.secrets_manager_secret_id #=> String # resp.endpoint.my_sql_settings.after_connect_script #=> String # resp.endpoint.my_sql_settings.clean_source_metadata_on_mismatch #=> Boolean # resp.endpoint.my_sql_settings.database_name #=> String @@ -5602,11 +5696,15 @@ # resp.endpoint.oracle_settings.retry_interval #=> Integer # resp.endpoint.oracle_settings.security_db_encryption #=> String # resp.endpoint.oracle_settings.security_db_encryption_name #=> String # resp.endpoint.oracle_settings.server_name #=> String # resp.endpoint.oracle_settings.spatial_data_option_to_geo_json_function_name #=> String + # resp.endpoint.oracle_settings.standby_delay_time #=> Integer # resp.endpoint.oracle_settings.username #=> String + # resp.endpoint.oracle_settings.use_b_file #=> Boolean + # resp.endpoint.oracle_settings.use_direct_path_full_load #=> Boolean + # resp.endpoint.oracle_settings.use_logminer_reader #=> Boolean # resp.endpoint.oracle_settings.secrets_manager_access_role_arn #=> String # resp.endpoint.oracle_settings.secrets_manager_secret_id #=> String # resp.endpoint.oracle_settings.secrets_manager_oracle_asm_access_role_arn #=> String # resp.endpoint.oracle_settings.secrets_manager_oracle_asm_secret_id #=> String # resp.endpoint.sybase_settings.database_name #=> String @@ -5659,23 +5757,22 @@ def modify_endpoint(params = {}, options = {}) req = build_request(:modify_endpoint, params) req.send_request(options) end - # Modifies an existing AWS DMS event notification subscription. + # Modifies an existing DMS event notification subscription. # # @option params [required, String] :subscription_name - # The name of the AWS DMS event notification subscription to be - # modified. + # The name of the DMS event notification subscription to be modified. # # @option params [String] :sns_topic_arn # The Amazon Resource Name (ARN) of the Amazon SNS topic created for # event notification. The ARN is created by Amazon SNS when you create a # topic and subscribe to it. # # @option params [String] :source_type - # The type of AWS DMS resource that generates the events you want to + # The type of DMS resource that generates the events you want to # subscribe to. # # Valid values: replication-instance \| replication-task # # @option params [Array<String>] :event_categories @@ -5745,11 +5842,11 @@ # for the specified replication instance class. For example to specify # the instance class dms.c4.large, set this parameter to # `"dms.c4.large"`. # # For more information on the settings and capacities for the available - # replication instance classes, see [ Selecting the right AWS DMS + # replication instance classes, see [ Selecting the right DMS # replication instance for your migration][1]. # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth @@ -5807,11 +5904,11 @@ # # * This parameter is set to `true` during the maintenance window. # # * A newer minor version is available. # - # * AWS DMS has enabled automatic patching for the given engine version. + # * DMS has enabled automatic patching for the given engine version. # # @option params [String] :replication_instance_identifier # The replication instance identifier. This parameter is stored as a # lowercase string. # @@ -6023,12 +6120,12 @@ # Modifies the specified replication task. # # You can't modify the task endpoints. The task must be stopped before # you can modify it. # - # For more information about AWS DMS tasks, see [Working with Migration - # Tasks][1] in the *AWS Database Migration Service User Guide*. + # For more information about DMS tasks, see [Working with Migration + # Tasks][1] in the *Database Migration Service User Guide*. # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html # @@ -6049,12 +6146,12 @@ # @option params [String] :migration_type # The migration type. Valid values: `full-load` \| `cdc` \| # `full-load-and-cdc` # # @option params [String] :table_mappings - # When using the AWS CLI or boto3, provide the path of the JSON file - # that contains the table mappings. Precede the path with `file://`. For + # When using the CLI or boto3, provide the path of the JSON file that + # contains the table mappings. Precede the path with `file://`. For # example, `--table-mappings file://mappingfile.json`. When working with # the DMS API, provide the JSON as the parameter value. # # @option params [String] :replication_task_settings # JSON file that contains settings for the task, such as task metadata @@ -6085,11 +6182,11 @@ # <note markdown="1"> When you use this task setting with a source PostgreSQL database, a # logical replication slot should already be created and associated with # the source endpoint. You can verify this by setting the `slotName` # extra connection attribute to the name of this logical replication # slot. For more information, see [Extra Connection Attributes When - # Using PostgreSQL as a Source for AWS DMS][1]. + # Using PostgreSQL as a Source for DMS][1]. # # </note> # # # @@ -6106,12 +6203,12 @@ # 2018-02-09T12:12:12 “ # # @option params [String] :task_data # Supplemental information that the task requires to migrate the data # for certain source and target endpoints. For more information, see - # [Specifying Supplemental Data for Task Settings][1] in the *AWS - # Database Migration Service User Guide.* + # [Specifying Supplemental Data for Task Settings][1] in the *Database + # Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html # @@ -6175,11 +6272,11 @@ end # Moves a replication task from its current replication instance to a # different target replication instance using the specified parameters. # The target replication instance must be created with the same or later - # AWS DMS version as the current replication instance. + # DMS version as the current replication instance. # # @option params [required, String] :replication_task_arn # The Amazon Resource Name (ARN) of the task that you want to move. # # @option params [required, String] :target_replication_instance_arn @@ -6412,21 +6509,21 @@ def reload_tables(params = {}, options = {}) req = build_request(:reload_tables, params) req.send_request(options) end - # Removes metadata tags from an AWS DMS resource, including replication + # Removes metadata tags from an DMS resource, including replication # instance, endpoint, security group, and migration task. For more # information, see [ `Tag` ][1] data type description. # # # # [1]: https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html # # @option params [required, String] :resource_arn - # An AWS DMS resource from which you want to remove tag(s). The value - # for this parameter is an Amazon Resource Name (ARN). + # An DMS resource from which you want to remove tag(s). The value for + # this parameter is an Amazon Resource Name (ARN). # # @option params [required, Array<String>] :tag_keys # The tag key (name) of the tag to be removed. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -6462,12 +6559,12 @@ req.send_request(options) end # Starts the replication task. # - # For more information about AWS DMS tasks, see [Working with Migration - # Tasks ][1] in the *AWS Database Migration Service User Guide.* + # For more information about DMS tasks, see [Working with Migration + # Tasks ][1] in the *Database Migration Service User Guide.* # # # # [1]: https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html # @@ -6502,11 +6599,11 @@ # <note markdown="1"> When you use this task setting with a source PostgreSQL database, a # logical replication slot should already be created and associated with # the source endpoint. You can verify this by setting the `slotName` # extra connection attribute to the name of this logical replication # slot. For more information, see [Extra Connection Attributes When - # Using PostgreSQL as a Source for AWS DMS][1]. + # Using PostgreSQL as a Source for DMS][1]. # # </note> # # # @@ -6674,30 +6771,31 @@ # @option params [required, String] :replication_task_arn # Amazon Resource Name (ARN) of the migration task associated with the # premigration assessment run that you want to start. # # @option params [required, String] :service_access_role_arn - # ARN of a service role needed to start the assessment run. + # ARN of the service role needed to start the assessment run. The role + # must allow the `iam:PassRole` action. # # @option params [required, String] :result_location_bucket - # Amazon S3 bucket where you want AWS DMS to store the results of this + # Amazon S3 bucket where you want DMS to store the results of this # assessment run. # # @option params [String] :result_location_folder - # Folder within an Amazon S3 bucket where you want AWS DMS to store the + # Folder within an Amazon S3 bucket where you want DMS to store the # results of this assessment run. # # @option params [String] :result_encryption_mode # Encryption mode that you can specify to encrypt the results of this - # assessment run. If you don't specify this request parameter, AWS DMS + # assessment run. If you don't specify this request parameter, DMS # stores the assessment run results without encryption. You can specify # one of the options following: # # * `"SSE_S3"` – The server-side encryption provided as a default by # Amazon S3. # - # * `"SSE_KMS"` – AWS Key Management Service (AWS KMS) encryption. This + # * `"SSE_KMS"` – Key Management Service (KMS) encryption. This # encryption can use either a custom KMS encryption key that you # specify or the default KMS encryption key that DMS provides. # # @option params [String] :result_kms_key_arn # ARN of a custom KMS encryption key that you specify when you set @@ -6707,34 +6805,34 @@ # Unique name to identify the assessment run. # # @option params [Array<String>] :include_only # Space-separated list of names for specific individual assessments that # you want to include. These names come from the default list of - # individual assessments that AWS DMS supports for the associated - # migration task. This task is specified by `ReplicationTaskArn`. + # individual assessments that DMS supports for the associated migration + # task. This task is specified by `ReplicationTaskArn`. # # <note markdown="1"> You can't set a value for `IncludeOnly` if you also set a value for # `Exclude` in the API operation. # - # To identify the names of the default individual assessments that AWS - # DMS supports for the associated migration task, run the + # To identify the names of the default individual assessments that DMS + # supports for the associated migration task, run the # `DescribeApplicableIndividualAssessments` operation using its own # `ReplicationTaskArn` request parameter. # # </note> # # @option params [Array<String>] :exclude # Space-separated list of names for specific individual assessments that # you want to exclude. These names come from the default list of - # individual assessments that AWS DMS supports for the associated - # migration task. This task is specified by `ReplicationTaskArn`. + # individual assessments that DMS supports for the associated migration + # task. This task is specified by `ReplicationTaskArn`. # # <note markdown="1"> You can't set a value for `Exclude` if you also set a value for # `IncludeOnly` in the API operation. # - # To identify the names of the default individual assessments that AWS - # DMS supports for the associated migration task, run the + # To identify the names of the default individual assessments that DMS + # supports for the associated migration task, run the # `DescribeApplicableIndividualAssessments` operation using its own # `ReplicationTaskArn` request parameter. # # </note> # @@ -6928,10 +7026,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-databasemigrationservice' - context[:gem_version] = '1.53.0' + context[:gem_version] = '1.54.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #