Struct aws_sdk_databasemigration::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Database Migration Service
Client for invoking operations on AWS Database Migration Service. Each operation on AWS Database Migration Service is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_databasemigration::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_databasemigration::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_databasemigration::Client::from_conf(config);
Implementations§
source§impl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
source§impl Client
impl Client
Constructs a fluent builder for the AddTagsToResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:Identifies the DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).
For DMS, you can tag a replication instance, an endpoint, or a replication task.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:One or more tags to be assigned to the resource.
- On success, responds with
AddTagsToResourceOutput
- On failure, responds with
SdkError<AddTagsToResourceError>
sourcepub fn apply_pending_maintenance_action(&self) -> ApplyPendingMaintenanceAction
pub fn apply_pending_maintenance_action(&self) -> ApplyPendingMaintenanceAction
Constructs a fluent builder for the ApplyPendingMaintenanceAction
operation.
- The fluent builder is configurable:
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to.
apply_action(impl Into<String>)
/set_apply_action(Option<String>)
:The pending maintenance action to apply to this resource.
Valid values:
os-upgrade
,system-update
,db-upgrade
opt_in_type(impl Into<String>)
/set_opt_in_type(Option<String>)
:A value that specifies the type of opt-in request, or undoes an opt-in request. You can’t undo an opt-in request of type
immediate
.Valid values:
-
immediate
- Apply the maintenance action immediately. -
next-maintenance
- Apply the maintenance action during the next maintenance window for the resource. -
undo-opt-in
- Cancel any existingnext-maintenance
opt-in requests.
-
- On success, responds with
ApplyPendingMaintenanceActionOutput
with field(s):resource_pending_maintenance_actions(Option<ResourcePendingMaintenanceActions>)
:The DMS resource that the pending maintenance action will be applied to.
- On failure, responds with
SdkError<ApplyPendingMaintenanceActionError>
sourcepub fn cancel_replication_task_assessment_run(
&self
) -> CancelReplicationTaskAssessmentRun
pub fn cancel_replication_task_assessment_run(
&self
) -> CancelReplicationTaskAssessmentRun
Constructs a fluent builder for the CancelReplicationTaskAssessmentRun
operation.
- The fluent builder is configurable:
replication_task_assessment_run_arn(impl Into<String>)
/set_replication_task_assessment_run_arn(Option<String>)
:Amazon Resource Name (ARN) of the premigration assessment run to be canceled.
- On success, responds with
CancelReplicationTaskAssessmentRunOutput
with field(s):replication_task_assessment_run(Option<ReplicationTaskAssessmentRun>)
:The
ReplicationTaskAssessmentRun
object for the canceled assessment run.
- On failure, responds with
SdkError<CancelReplicationTaskAssessmentRunError>
sourcepub fn create_endpoint(&self) -> CreateEndpoint
pub fn create_endpoint(&self) -> CreateEndpoint
Constructs a fluent builder for the CreateEndpoint
operation.
- The fluent builder is configurable:
endpoint_identifier(impl Into<String>)
/set_endpoint_identifier(Option<String>)
: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.
endpoint_type(ReplicationEndpointTypeValue)
/set_endpoint_type(Option<ReplicationEndpointTypeValue>)
:The type of endpoint. Valid values are
source
andtarget
.engine_name(impl Into<String>)
/set_engine_name(Option<String>)
:The type of engine for the endpoint. Valid values, depending on the
EndpointType
value, include“mysql”
,“oracle”
,“postgres”
,“mariadb”
,“aurora”
,“aurora-postgresql”
,“opensearch”
,“redshift”
,“s3”
,“db2”
,“db2-zos”
,“azuredb”
,“sybase”
,“dynamodb”
,“mongodb”
,“kinesis”
,“kafka”
,“elasticsearch”
,“docdb”
,“sqlserver”
,“neptune”
, and“babelfish”
.username(impl Into<String>)
/set_username(Option<String>)
:The user name to be used to log in to the endpoint database.
password(impl Into<String>)
/set_password(Option<String>)
:The password to be used to log in to the endpoint database.
server_name(impl Into<String>)
/set_server_name(Option<String>)
:The name of the server where the endpoint database resides.
port(i32)
/set_port(Option<i32>)
:The port used by the endpoint database.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and
targetDbType
.extra_connection_attributes(impl Into<String>)
/set_extra_connection_attributes(Option<String>)
: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 DMS Endpoints in the Database Migration Service User Guide.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
: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 DMS uses your default encryption key.KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:One or more tags to be assigned to the endpoint.
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:The Amazon Resource Name (ARN) for the certificate.
ssl_mode(DmsSslModeValue)
/set_ssl_mode(Option<DmsSslModeValue>)
:The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is
none
service_access_role_arn(impl Into<String>)
/set_service_access_role_arn(Option<String>)
:The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the
iam:PassRole
action.external_table_definition(impl Into<String>)
/set_external_table_definition(Option<String>)
:The external table definition.
dynamo_db_settings(DynamoDbSettings)
/set_dynamo_db_settings(Option<DynamoDbSettings>)
: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 in the Database Migration Service User Guide.
s3_settings(S3Settings)
/set_s3_settings(Option<S3Settings>)
: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 DMS in the Database Migration Service User Guide.
dms_transfer_settings(DmsTransferSettings)
/set_dms_transfer_settings(Option<DmsTransferSettings>)
:The settings in JSON format for the DMS transfer type of source endpoint.
Possible settings include the following:
-
ServiceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam:PassRole
action. -
BucketName
- The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string,BucketName=string
JSON syntax for these settings is as follows:
{ “ServiceAccessRoleArn”: “string”, “BucketName”: “string”, }
-
mongo_db_settings(MongoDbSettings)
/set_mongo_db_settings(Option<MongoDbSettings>)
:Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
kinesis_settings(KinesisSettings)
/set_kinesis_settings(Option<KinesisSettings>)
:Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
kafka_settings(KafkaSettings)
/set_kafka_settings(Option<KafkaSettings>)
:Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
elasticsearch_settings(ElasticsearchSettings)
/set_elasticsearch_settings(Option<ElasticsearchSettings>)
:Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.
neptune_settings(NeptuneSettings)
/set_neptune_settings(Option<NeptuneSettings>)
:Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
redshift_settings(RedshiftSettings)
/set_redshift_settings(Option<RedshiftSettings>)
:Provides information that defines an Amazon Redshift endpoint.
postgre_sql_settings(PostgreSqlSettings)
/set_postgre_sql_settings(Option<PostgreSqlSettings>)
: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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
my_sql_settings(MySqlSettings)
/set_my_sql_settings(Option<MySqlSettings>)
: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 DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
oracle_settings(OracleSettings)
/set_oracle_settings(Option<OracleSettings>)
: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 DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
sybase_settings(SybaseSettings)
/set_sybase_settings(Option<SybaseSettings>)
: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 DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
microsoft_sql_server_settings(MicrosoftSqlServerSettings)
/set_microsoft_sql_server_settings(Option<MicrosoftSqlServerSettings>)
: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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
ibm_db2_settings(IbmDb2Settings)
/set_ibm_db2_settings(Option<IbmDb2Settings>)
: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 DMS in the Database Migration Service User Guide.
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the createdEndpoint
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 asExample-App-ARN1
. For example, this value might result in theEndpointArn
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don’t specify aResourceIdentifier
value, DMS generates a default identifier value for the end ofEndpointArn
.doc_db_settings(DocDbSettings)
/set_doc_db_settings(Option<DocDbSettings>)
:Provides information that defines a DocumentDB endpoint.
redis_settings(RedisSettings)
/set_redis_settings(Option<RedisSettings>)
:Settings in JSON format for the target Redis endpoint.
gcp_my_sql_settings(GcpMySqlSettings)
/set_gcp_my_sql_settings(Option<GcpMySqlSettings>)
:Settings in JSON format for the source GCP MySQL endpoint.
- On success, responds with
CreateEndpointOutput
with field(s):endpoint(Option<Endpoint>)
:The endpoint that was created.
- On failure, responds with
SdkError<CreateEndpointError>
sourcepub fn create_event_subscription(&self) -> CreateEventSubscription
pub fn create_event_subscription(&self) -> CreateEventSubscription
Constructs a fluent builder for the CreateEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the DMS event notification subscription. This name must be less than 255 characters.
sns_topic_arn(impl Into<String>)
/set_sns_topic_arn(Option<String>)
: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.
source_type(impl Into<String>)
/set_source_type(Option<String>)
: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
event_categories(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.
source_ids(Vec<String>)
/set_source_ids(Option<Vec<String>>)
: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 example, if you specify a database instance ID, then all of the other values must be database instance IDs.
enabled(bool)
/set_enabled(Option<bool>)
:A Boolean value; set to
true
to activate the subscription, or set tofalse
to create the subscription but not activate it.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:One or more tags to be assigned to the event subscription.
- On success, responds with
CreateEventSubscriptionOutput
with field(s):event_subscription(Option<EventSubscription>)
:The event subscription that was created.
- On failure, responds with
SdkError<CreateEventSubscriptionError>
sourcepub fn create_fleet_advisor_collector(&self) -> CreateFleetAdvisorCollector
pub fn create_fleet_advisor_collector(&self) -> CreateFleetAdvisorCollector
Constructs a fluent builder for the CreateFleetAdvisorCollector
operation.
- The fluent builder is configurable:
collector_name(impl Into<String>)
/set_collector_name(Option<String>)
:The name of your Fleet Advisor collector (for example,
sample-collector
).description(impl Into<String>)
/set_description(Option<String>)
:A summary description of your Fleet Advisor collector.
service_access_role_arn(impl Into<String>)
/set_service_access_role_arn(Option<String>)
:The IAM role that grants permissions to access the specified Amazon S3 bucket.
s3_bucket_name(impl Into<String>)
/set_s3_bucket_name(Option<String>)
:The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.
- On success, responds with
CreateFleetAdvisorCollectorOutput
with field(s):collector_referenced_id(Option<String>)
:The unique ID of the new Fleet Advisor collector, for example:
22fda70c-40d5-4acf-b233-a495bd8eb7f5
collector_name(Option<String>)
:The name of the new Fleet Advisor collector.
description(Option<String>)
:A summary description of the Fleet Advisor collector.
service_access_role_arn(Option<String>)
:The IAM role that grants permissions to access the specified Amazon S3 bucket.
s3_bucket_name(Option<String>)
:The Amazon S3 bucket that the collector uses to store inventory metadata.
- On failure, responds with
SdkError<CreateFleetAdvisorCollectorError>
sourcepub fn create_replication_instance(&self) -> CreateReplicationInstance
pub fn create_replication_instance(&self) -> CreateReplicationInstance
Constructs a fluent builder for the CreateReplicationInstance
operation.
- The fluent builder is configurable:
replication_instance_identifier(impl Into<String>)
/set_replication_instance_identifier(Option<String>)
:The replication instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must contain 1-63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Can’t end with a hyphen or contain two consecutive hyphens.
Example:
myrepinstance
-
allocated_storage(i32)
/set_allocated_storage(Option<i32>)
:The amount of storage (in gigabytes) to be initially allocated for the replication instance.
replication_instance_class(impl Into<String>)
/set_replication_instance_class(Option<String>)
:The compute and memory capacity of the replication instance as defined 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 DMS replication instance for your migration.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint’s Amazon Web Services Region, for example:
us-east-1d
replication_subnet_group_identifier(impl Into<String>)
/set_replication_subnet_group_identifier(Option<String>)
:A subnet group to associate with the replication instance.
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:The weekly time range during which system maintenance can occur, in 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 Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
multi_az(bool)
/set_multi_az(Option<bool>)
:Specifies whether the replication instance is a Multi-AZ deployment. You can’t set the
AvailabilityZone
parameter if the Multi-AZ parameter is set totrue
.engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to
true
.Default:
true
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:One or more tags to be assigned to the replication instance.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
: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 DMS uses your default encryption key.KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:Specifies the accessibility options for the replication instance. A value of
true
represents an instance with a public IP address. A value offalse
represents an instance with a private IP address. The default value istrue
.dns_name_servers(impl Into<String>)
/set_dns_name_servers(Option<String>)
:A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example:
“1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4”
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the createdEndpoint
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 asExample-App-ARN1
. For example, this value might result in theEndpointArn
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don’t specify aResourceIdentifier
value, DMS generates a default identifier value for the end ofEndpointArn
.network_type(impl Into<String>)
/set_network_type(Option<String>)
:The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
- On success, responds with
CreateReplicationInstanceOutput
with field(s):replication_instance(Option<ReplicationInstance>)
:The replication instance that was created.
- On failure, responds with
SdkError<CreateReplicationInstanceError>
sourcepub fn create_replication_subnet_group(&self) -> CreateReplicationSubnetGroup
pub fn create_replication_subnet_group(&self) -> CreateReplicationSubnetGroup
Constructs a fluent builder for the CreateReplicationSubnetGroup
operation.
- The fluent builder is configurable:
replication_subnet_group_identifier(impl Into<String>)
/set_replication_subnet_group_identifier(Option<String>)
:The name for the replication subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be “default”.
Example:
mySubnetgroup
replication_subnet_group_description(impl Into<String>)
/set_replication_subnet_group_description(Option<String>)
:The description for the subnet group.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:One or more subnet IDs to be assigned to the subnet group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:One or more tags to be assigned to the subnet group.
- On success, responds with
CreateReplicationSubnetGroupOutput
with field(s):replication_subnet_group(Option<ReplicationSubnetGroup>)
:The replication subnet group that was created.
- On failure, responds with
SdkError<CreateReplicationSubnetGroupError>
sourcepub fn create_replication_task(&self) -> CreateReplicationTask
pub fn create_replication_task(&self) -> CreateReplicationTask
Constructs a fluent builder for the CreateReplicationTask
operation.
- The fluent builder is configurable:
replication_task_identifier(impl Into<String>)
/set_replication_task_identifier(Option<String>)
:An identifier for the replication task.
Constraints:
-
Must contain 1-255 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
-
source_endpoint_arn(impl Into<String>)
/set_source_endpoint_arn(Option<String>)
:An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
target_endpoint_arn(impl Into<String>)
/set_target_endpoint_arn(Option<String>)
:An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of a replication instance.
migration_type(MigrationTypeValue)
/set_migration_type(Option<MigrationTypeValue>)
:The migration type. Valid values:
full-load
|cdc
|full-load-and-cdc
table_mappings(impl Into<String>)
/set_table_mappings(Option<String>)
:The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the Database Migration Service User Guide.
replication_task_settings(impl Into<String>)
/set_replication_task_settings(Option<String>)
:Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for Database Migration Service Tasks in the Database Migration Service User Guide.
cdc_start_time(DateTime)
/set_cdc_start_time(Option<DateTime>)
:Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”
cdc_start_position(impl Into<String>)
/set_cdc_start_position(Option<String>)
:Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: –cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”
LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”
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 DMS.cdc_stop_position(impl Into<String>)
/set_cdc_stop_position(Option<String>)
:Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:One or more tags to be assigned to the replication task.
task_data(impl Into<String>)
/set_task_data(Option<String>)
: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 in the Database Migration Service User Guide.
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the createdEndpoint
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 asExample-App-ARN1
. For example, this value might result in theEndpointArn
valuearn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don’t specify aResourceIdentifier
value, DMS generates a default identifier value for the end ofEndpointArn
.
- On success, responds with
CreateReplicationTaskOutput
with field(s):replication_task(Option<ReplicationTask>)
:The replication task that was created.
- On failure, responds with
SdkError<CreateReplicationTaskError>
sourcepub fn delete_certificate(&self) -> DeleteCertificate
pub fn delete_certificate(&self) -> DeleteCertificate
Constructs a fluent builder for the DeleteCertificate
operation.
- The fluent builder is configurable:
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:The Amazon Resource Name (ARN) of the certificate.
- On success, responds with
DeleteCertificateOutput
with field(s):certificate(Option<Certificate>)
:The Secure Sockets Layer (SSL) certificate.
- On failure, responds with
SdkError<DeleteCertificateError>
sourcepub fn delete_connection(&self) -> DeleteConnection
pub fn delete_connection(&self) -> DeleteConnection
Constructs a fluent builder for the DeleteConnection
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance.
- On success, responds with
DeleteConnectionOutput
with field(s):connection(Option<Connection>)
:The connection that is being deleted.
- On failure, responds with
SdkError<DeleteConnectionError>
sourcepub fn delete_endpoint(&self) -> DeleteEndpoint
pub fn delete_endpoint(&self) -> DeleteEndpoint
Constructs a fluent builder for the DeleteEndpoint
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
- On success, responds with
DeleteEndpointOutput
with field(s):endpoint(Option<Endpoint>)
:The endpoint that was deleted.
- On failure, responds with
SdkError<DeleteEndpointError>
sourcepub fn delete_event_subscription(&self) -> DeleteEventSubscription
pub fn delete_event_subscription(&self) -> DeleteEventSubscription
Constructs a fluent builder for the DeleteEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the DMS event notification subscription to be deleted.
- On success, responds with
DeleteEventSubscriptionOutput
with field(s):event_subscription(Option<EventSubscription>)
:The event subscription that was deleted.
- On failure, responds with
SdkError<DeleteEventSubscriptionError>
sourcepub fn delete_fleet_advisor_collector(&self) -> DeleteFleetAdvisorCollector
pub fn delete_fleet_advisor_collector(&self) -> DeleteFleetAdvisorCollector
Constructs a fluent builder for the DeleteFleetAdvisorCollector
operation.
- The fluent builder is configurable:
collector_referenced_id(impl Into<String>)
/set_collector_referenced_id(Option<String>)
:The reference ID of the Fleet Advisor collector to delete.
- On success, responds with
DeleteFleetAdvisorCollectorOutput
- On failure, responds with
SdkError<DeleteFleetAdvisorCollectorError>
sourcepub fn delete_fleet_advisor_databases(&self) -> DeleteFleetAdvisorDatabases
pub fn delete_fleet_advisor_databases(&self) -> DeleteFleetAdvisorDatabases
Constructs a fluent builder for the DeleteFleetAdvisorDatabases
operation.
- The fluent builder is configurable:
database_ids(Vec<String>)
/set_database_ids(Option<Vec<String>>)
:The IDs of the Fleet Advisor collector databases to delete.
- On success, responds with
DeleteFleetAdvisorDatabasesOutput
with field(s):database_ids(Option<Vec<String>>)
:The IDs of the databases that the operation deleted.
- On failure, responds with
SdkError<DeleteFleetAdvisorDatabasesError>
sourcepub fn delete_replication_instance(&self) -> DeleteReplicationInstance
pub fn delete_replication_instance(&self) -> DeleteReplicationInstance
Constructs a fluent builder for the DeleteReplicationInstance
operation.
- The fluent builder is configurable:
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance to be deleted.
- On success, responds with
DeleteReplicationInstanceOutput
with field(s):replication_instance(Option<ReplicationInstance>)
:The replication instance that was deleted.
- On failure, responds with
SdkError<DeleteReplicationInstanceError>
sourcepub fn delete_replication_subnet_group(&self) -> DeleteReplicationSubnetGroup
pub fn delete_replication_subnet_group(&self) -> DeleteReplicationSubnetGroup
Constructs a fluent builder for the DeleteReplicationSubnetGroup
operation.
- The fluent builder is configurable:
replication_subnet_group_identifier(impl Into<String>)
/set_replication_subnet_group_identifier(Option<String>)
:The subnet group name of the replication instance.
- On success, responds with
DeleteReplicationSubnetGroupOutput
- On failure, responds with
SdkError<DeleteReplicationSubnetGroupError>
sourcepub fn delete_replication_task(&self) -> DeleteReplicationTask
pub fn delete_replication_task(&self) -> DeleteReplicationTask
Constructs a fluent builder for the DeleteReplicationTask
operation.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication task to be deleted.
- On success, responds with
DeleteReplicationTaskOutput
with field(s):replication_task(Option<ReplicationTask>)
:The deleted replication task.
- On failure, responds with
SdkError<DeleteReplicationTaskError>
sourcepub fn delete_replication_task_assessment_run(
&self
) -> DeleteReplicationTaskAssessmentRun
pub fn delete_replication_task_assessment_run(
&self
) -> DeleteReplicationTaskAssessmentRun
Constructs a fluent builder for the DeleteReplicationTaskAssessmentRun
operation.
- The fluent builder is configurable:
replication_task_assessment_run_arn(impl Into<String>)
/set_replication_task_assessment_run_arn(Option<String>)
:Amazon Resource Name (ARN) of the premigration assessment run to be deleted.
- On success, responds with
DeleteReplicationTaskAssessmentRunOutput
with field(s):replication_task_assessment_run(Option<ReplicationTaskAssessmentRun>)
:The
ReplicationTaskAssessmentRun
object for the deleted assessment run.
- On failure, responds with
SdkError<DeleteReplicationTaskAssessmentRunError>
sourcepub fn describe_account_attributes(&self) -> DescribeAccountAttributes
pub fn describe_account_attributes(&self) -> DescribeAccountAttributes
Constructs a fluent builder for the DescribeAccountAttributes
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DescribeAccountAttributesOutput
with field(s):account_quotas(Option<Vec<AccountQuota>>)
:Account quota information.
unique_account_identifier(Option<String>)
:A unique DMS identifier for an account in a particular Amazon Web Services Region. The value of this identifier has the following format:
c99999999999
. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given Amazon Web Services Region. The format of this S3 bucket name is the following:dms-AccountNumber-UniqueAccountIdentifier.
Here is an example name for this default S3 bucket:dms-111122223333-c44445555666
.DMS supports the
UniqueAccountIdentifier
parameter in versions 3.1.4 and later.
- On failure, responds with
SdkError<DescribeAccountAttributesError>
sourcepub fn describe_applicable_individual_assessments(
&self
) -> DescribeApplicableIndividualAssessments
pub fn describe_applicable_individual_assessments(
&self
) -> DescribeApplicableIndividualAssessments
Constructs a fluent builder for the DescribeApplicableIndividualAssessments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:ARN of a replication instance on which you want to base the default list of individual assessments.
source_engine_name(impl Into<String>)
/set_source_engine_name(Option<String>)
:Name of a database engine that the specified replication instance supports as a source.
target_engine_name(impl Into<String>)
/set_target_engine_name(Option<String>)
:Name of a database engine that the specified replication instance supports as a target.
migration_type(MigrationTypeValue)
/set_migration_type(Option<MigrationTypeValue>)
:Name of the migration type that each provided individual assessment must support.
max_records(i32)
/set_max_records(Option<i32>)
:Maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.marker(impl Into<String>)
/set_marker(Option<String>)
:Optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeApplicableIndividualAssessmentsOutput
with field(s):individual_assessment_names(Option<Vec<String>>)
:List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the Database Migration Service User Guide.
marker(Option<String>)
:Pagination token returned for you to pass to a subsequent request. If you pass this token as the
Marker
value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request byMaxRecords
.
- On failure, responds with
SdkError<DescribeApplicableIndividualAssessmentsError>
sourcepub fn describe_certificates(&self) -> DescribeCertificates
pub fn describe_certificates(&self) -> DescribeCertificates
Constructs a fluent builder for the DescribeCertificates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to the certificates described in the form of key-value pairs. Valid values are
certificate-arn
andcertificate-id
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 10
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeCertificatesOutput
with field(s):marker(Option<String>)
:The pagination token.
certificates(Option<Vec<Certificate>>)
:The Secure Sockets Layer (SSL) certificates associated with the replication instance.
- On failure, responds with
SdkError<DescribeCertificatesError>
sourcepub fn describe_connections(&self) -> DescribeConnections
pub fn describe_connections(&self) -> DescribeConnections
Constructs a fluent builder for the DescribeConnections
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:The filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeConnectionsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.connections(Option<Vec<Connection>>)
:A description of the connections.
- On failure, responds with
SdkError<DescribeConnectionsError>
sourcepub fn describe_endpoints(&self) -> DescribeEndpoints
pub fn describe_endpoints(&self) -> DescribeEndpoints
Constructs a fluent builder for the DescribeEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeEndpointsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.endpoints(Option<Vec<Endpoint>>)
:Endpoint description.
- On failure, responds with
SdkError<DescribeEndpointsError>
sourcepub fn describe_endpoint_settings(&self) -> DescribeEndpointSettings
pub fn describe_endpoint_settings(&self) -> DescribeEndpointSettings
Constructs a fluent builder for the DescribeEndpointSettings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
engine_name(impl Into<String>)
/set_engine_name(Option<String>)
:The databse engine used for your source or target endpoint.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeEndpointSettingsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.endpoint_settings(Option<Vec<EndpointSetting>>)
:Descriptions of the endpoint settings available for your source or target database engine.
- On failure, responds with
SdkError<DescribeEndpointSettingsError>
sourcepub fn describe_endpoint_types(&self) -> DescribeEndpointTypes
pub fn describe_endpoint_types(&self) -> DescribeEndpointTypes
Constructs a fluent builder for the DescribeEndpointTypes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to the endpoint types.
Valid filter names: engine-name | endpoint-type
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeEndpointTypesOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.supported_endpoint_types(Option<Vec<SupportedEndpointType>>)
:The types of endpoints that are supported.
- On failure, responds with
SdkError<DescribeEndpointTypesError>
sourcepub fn describe_event_categories(&self) -> DescribeEventCategories
pub fn describe_event_categories(&self) -> DescribeEventCategories
Constructs a fluent builder for the DescribeEventCategories
operation.
- The fluent builder is configurable:
source_type(impl Into<String>)
/set_source_type(Option<String>)
:The type of DMS resource that generates events.
Valid values: replication-instance | replication-task
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to the event categories.
- On success, responds with
DescribeEventCategoriesOutput
with field(s):event_category_group_list(Option<Vec<EventCategoryGroup>>)
:A list of event categories.
- On failure, responds with
SdkError<DescribeEventCategoriesError>
sourcepub fn describe_events(&self) -> DescribeEvents
pub fn describe_events(&self) -> DescribeEvents
Constructs a fluent builder for the DescribeEvents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
source_identifier(impl Into<String>)
/set_source_identifier(Option<String>)
:The identifier of an event source.
source_type(SourceType)
/set_source_type(Option<SourceType>)
:The type of DMS resource that generates events.
Valid values: replication-instance | replication-task
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The start time for the events to be listed.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The end time for the events to be listed.
duration(i32)
/set_duration(Option<i32>)
:The duration of the events to be listed.
event_categories(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories for the source type that you’ve chosen.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to events. The only valid filter is
replication-instance-id
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeEventsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.events(Option<Vec<Event>>)
:The events described.
- On failure, responds with
SdkError<DescribeEventsError>
sourcepub fn describe_event_subscriptions(&self) -> DescribeEventSubscriptions
pub fn describe_event_subscriptions(&self) -> DescribeEventSubscriptions
Constructs a fluent builder for the DescribeEventSubscriptions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the DMS event subscription to be described.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to event subscriptions.
Valid filter names: event-subscription-arn | event-subscription-id
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeEventSubscriptionsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.event_subscriptions_list(Option<Vec<EventSubscription>>)
:A list of event subscriptions.
- On failure, responds with
SdkError<DescribeEventSubscriptionsError>
sourcepub fn describe_fleet_advisor_collectors(
&self
) -> DescribeFleetAdvisorCollectors
pub fn describe_fleet_advisor_collectors(
&self
) -> DescribeFleetAdvisorCollectors
Constructs a fluent builder for the DescribeFleetAdvisorCollectors
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:
-
collector-referenced-id
– The ID of the collector agent, for exampled4610ac5-e323-4ad9-bc50-eaf7249dfe9d
. -
collector-name
– The name of the collector agent.
An example is:
describe-fleet-advisor-collectors –filter Name=“collector-referenced-id”,Values=“d4610ac5-e323-4ad9-bc50-eaf7249dfe9d”
-
max_records(i32)
/set_max_records(Option<i32>)
:Sets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
NextToken
is returned by a previous response, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On success, responds with
DescribeFleetAdvisorCollectorsOutput
with field(s):collectors(Option<Vec<CollectorResponse>>)
:Provides descriptions of the Fleet Advisor collectors, including the collectors’ name and ID, and the latest inventory data.
next_token(Option<String>)
:If
NextToken
is returned, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On failure, responds with
SdkError<DescribeFleetAdvisorCollectorsError>
sourcepub fn describe_fleet_advisor_databases(&self) -> DescribeFleetAdvisorDatabases
pub fn describe_fleet_advisor_databases(&self) -> DescribeFleetAdvisorDatabases
Constructs a fluent builder for the DescribeFleetAdvisorDatabases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:
-
database-id
– The ID of the database. -
database-name
– The name of the database. -
database-engine
– The name of the database engine. -
server-ip-address
– The IP address of the database server. -
database-ip-address
– The IP address of the database. -
collector-name
– The name of the associated Fleet Advisor collector.
An example is:
describe-fleet-advisor-databases –filter Name=“database-id”,Values=“45”
-
max_records(i32)
/set_max_records(Option<i32>)
:Sets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
NextToken
is returned by a previous response, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On success, responds with
DescribeFleetAdvisorDatabasesOutput
with field(s):databases(Option<Vec<DatabaseResponse>>)
:Provides descriptions of the Fleet Advisor collector databases, including the database’s collector, ID, and name.
next_token(Option<String>)
:If
NextToken
is returned, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On failure, responds with
SdkError<DescribeFleetAdvisorDatabasesError>
sourcepub fn describe_fleet_advisor_lsa_analysis(
&self
) -> DescribeFleetAdvisorLsaAnalysis
pub fn describe_fleet_advisor_lsa_analysis(
&self
) -> DescribeFleetAdvisorLsaAnalysis
Constructs a fluent builder for the DescribeFleetAdvisorLsaAnalysis
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_records(i32)
/set_max_records(Option<i32>)
:Sets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
NextToken
is returned by a previous response, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On success, responds with
DescribeFleetAdvisorLsaAnalysisOutput
with field(s):analysis(Option<Vec<FleetAdvisorLsaAnalysisResponse>>)
:A list of
FleetAdvisorLsaAnalysisResponse
objects.next_token(Option<String>)
:If
NextToken
is returned, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On failure, responds with
SdkError<DescribeFleetAdvisorLsaAnalysisError>
sourcepub fn describe_fleet_advisor_schema_object_summary(
&self
) -> DescribeFleetAdvisorSchemaObjectSummary
pub fn describe_fleet_advisor_schema_object_summary(
&self
) -> DescribeFleetAdvisorSchemaObjectSummary
Constructs a fluent builder for the DescribeFleetAdvisorSchemaObjectSummary
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:If you specify any of the following filters, the output includes information for only those schema objects that meet the filter criteria:
-
schema-id
– The ID of the schema, for exampled4610ac5-e323-4ad9-bc50-eaf7249dfe9d
.
Example:
describe-fleet-advisor-schema-object-summary –filter Name=“schema-id”,Values=“50”
-
max_records(i32)
/set_max_records(Option<i32>)
:Sets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
NextToken
is returned by a previous response, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On success, responds with
DescribeFleetAdvisorSchemaObjectSummaryOutput
with field(s):fleet_advisor_schema_objects(Option<Vec<FleetAdvisorSchemaObjectResponse>>)
:A collection of
FleetAdvisorSchemaObjectResponse
objects.next_token(Option<String>)
:If
NextToken
is returned, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On failure, responds with
SdkError<DescribeFleetAdvisorSchemaObjectSummaryError>
sourcepub fn describe_fleet_advisor_schemas(&self) -> DescribeFleetAdvisorSchemas
pub fn describe_fleet_advisor_schemas(&self) -> DescribeFleetAdvisorSchemas
Constructs a fluent builder for the DescribeFleetAdvisorSchemas
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:
-
complexity
– The schema’s complexity, for exampleSimple
. -
database-id
– The ID of the schema’s database. -
database-ip-address
– The IP address of the schema’s database. -
database-name
– The name of the schema’s database. -
database-engine
– The name of the schema database’s engine. -
original-schema-name
– The name of the schema’s database’s main schema. -
schema-id
– The ID of the schema, for example15
. -
schema-name
– The name of the schema. -
server-ip-address
– The IP address of the schema database’s server.
An example is:
describe-fleet-advisor-schemas –filter Name=“schema-id”,Values=“50”
-
max_records(i32)
/set_max_records(Option<i32>)
:Sets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If
NextToken
is returned by a previous response, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On success, responds with
DescribeFleetAdvisorSchemasOutput
with field(s):fleet_advisor_schemas(Option<Vec<SchemaResponse>>)
:A collection of
SchemaResponse
objects.next_token(Option<String>)
:If
NextToken
is returned, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
- On failure, responds with
SdkError<DescribeFleetAdvisorSchemasError>
sourcepub fn describe_orderable_replication_instances(
&self
) -> DescribeOrderableReplicationInstances
pub fn describe_orderable_replication_instances(
&self
) -> DescribeOrderableReplicationInstances
Constructs a fluent builder for the DescribeOrderableReplicationInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeOrderableReplicationInstancesOutput
with field(s):orderable_replication_instances(Option<Vec<OrderableReplicationInstance>>)
:The order-able replication instances available.
marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeOrderableReplicationInstancesError>
sourcepub fn describe_pending_maintenance_actions(
&self
) -> DescribePendingMaintenanceActions
pub fn describe_pending_maintenance_actions(
&self
) -> DescribePendingMaintenanceActions
Constructs a fluent builder for the DescribePendingMaintenanceActions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance.
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- On success, responds with
DescribePendingMaintenanceActionsOutput
with field(s):pending_maintenance_actions(Option<Vec<ResourcePendingMaintenanceActions>>)
:The pending maintenance action.
marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribePendingMaintenanceActionsError>
sourcepub fn describe_refresh_schemas_status(&self) -> DescribeRefreshSchemasStatus
pub fn describe_refresh_schemas_status(&self) -> DescribeRefreshSchemasStatus
Constructs a fluent builder for the DescribeRefreshSchemasStatus
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
- On success, responds with
DescribeRefreshSchemasStatusOutput
with field(s):refresh_schemas_status(Option<RefreshSchemasStatus>)
:The status of the schema.
- On failure, responds with
SdkError<DescribeRefreshSchemasStatusError>
sourcepub fn describe_replication_instances(&self) -> DescribeReplicationInstances
pub fn describe_replication_instances(&self) -> DescribeReplicationInstances
Constructs a fluent builder for the DescribeReplicationInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeReplicationInstancesOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.replication_instances(Option<Vec<ReplicationInstance>>)
:The replication instances described.
- On failure, responds with
SdkError<DescribeReplicationInstancesError>
sourcepub fn describe_replication_instance_task_logs(
&self
) -> DescribeReplicationInstanceTaskLogs
pub fn describe_replication_instance_task_logs(
&self
) -> DescribeReplicationInstanceTaskLogs
Constructs a fluent builder for the DescribeReplicationInstanceTaskLogs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeReplicationInstanceTaskLogsOutput
with field(s):replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance.
replication_instance_task_logs(Option<Vec<ReplicationInstanceTaskLog>>)
:An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).
marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeReplicationInstanceTaskLogsError>
sourcepub fn describe_replication_subnet_groups(
&self
) -> DescribeReplicationSubnetGroups
pub fn describe_replication_subnet_groups(
&self
) -> DescribeReplicationSubnetGroups
Constructs a fluent builder for the DescribeReplicationSubnetGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeReplicationSubnetGroupsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.replication_subnet_groups(Option<Vec<ReplicationSubnetGroup>>)
:A description of the replication subnet groups.
- On failure, responds with
SdkError<DescribeReplicationSubnetGroupsError>
sourcepub fn describe_replication_task_assessment_results(
&self
) -> DescribeReplicationTaskAssessmentResults
pub fn describe_replication_task_assessment_results(
&self
) -> DescribeReplicationTaskAssessmentResults
Constructs a fluent builder for the DescribeReplicationTaskAssessmentResults
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
: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
andMarker
parameters.max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeReplicationTaskAssessmentResultsOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.bucket_name(Option<String>)
:- The Amazon S3 bucket where the task assessment report is located.
replication_task_assessment_results(Option<Vec<ReplicationTaskAssessmentResult>>)
:The task assessment report.
- On failure, responds with
SdkError<DescribeReplicationTaskAssessmentResultsError>
sourcepub fn describe_replication_task_assessment_runs(
&self
) -> DescribeReplicationTaskAssessmentRuns
pub fn describe_replication_task_assessment_runs(
&self
) -> DescribeReplicationTaskAssessmentRuns
Constructs a fluent builder for the DescribeReplicationTaskAssessmentRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to the premigration assessment runs described in the form of key-value pairs.
Valid filter names:
replication-task-assessment-run-arn
,replication-task-arn
,replication-instance-arn
,status
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeReplicationTaskAssessmentRunsOutput
with field(s):marker(Option<String>)
:A pagination token returned for you to pass to a subsequent request. If you pass this token as the
Marker
value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request byMaxRecords
.replication_task_assessment_runs(Option<Vec<ReplicationTaskAssessmentRun>>)
:One or more premigration assessment runs as specified by
Filters
.
- On failure, responds with
SdkError<DescribeReplicationTaskAssessmentRunsError>
sourcepub fn describe_replication_task_individual_assessments(
&self
) -> DescribeReplicationTaskIndividualAssessments
pub fn describe_replication_task_individual_assessments(
&self
) -> DescribeReplicationTaskIndividualAssessments
Constructs a fluent builder for the DescribeReplicationTaskIndividualAssessments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to the individual assessments described in the form of key-value pairs.
Valid filter names:
replication-task-assessment-run-arn
,replication-task-arn
,status
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeReplicationTaskIndividualAssessmentsOutput
with field(s):marker(Option<String>)
:A pagination token returned for you to pass to a subsequent request. If you pass this token as the
Marker
value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request byMaxRecords
.replication_task_individual_assessments(Option<Vec<ReplicationTaskIndividualAssessment>>)
:One or more individual assessments as specified by
Filters
.
- On failure, responds with
SdkError<DescribeReplicationTaskIndividualAssessmentsError>
sourcepub fn describe_replication_tasks(&self) -> DescribeReplicationTasks
pub fn describe_replication_tasks(&self) -> DescribeReplicationTasks
Constructs a fluent builder for the DescribeReplicationTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.without_settings(bool)
/set_without_settings(Option<bool>)
:An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose
true
; otherwise, choosefalse
(the default).
- On success, responds with
DescribeReplicationTasksOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.replication_tasks(Option<Vec<ReplicationTask>>)
:A description of the replication tasks.
- On failure, responds with
SdkError<DescribeReplicationTasksError>
sourcepub fn describe_schemas(&self) -> DescribeSchemas
pub fn describe_schemas(&self) -> DescribeSchemas
Constructs a fluent builder for the DescribeSchemas
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On success, responds with
DescribeSchemasOutput
with field(s):marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.schemas(Option<Vec<String>>)
:The described schema.
- On failure, responds with
SdkError<DescribeSchemasError>
sourcepub fn describe_table_statistics(&self) -> DescribeTableStatistics
pub fn describe_table_statistics(&self) -> DescribeTableStatistics
Constructs a fluent builder for the DescribeTableStatistics
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication task.
max_records(i32)
/set_max_records(Option<i32>)
:The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 500.
marker(impl Into<String>)
/set_marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.filters(Vec<Filter>)
/set_filters(Option<Vec<Filter>>)
:Filters applied to table statistics.
Valid filter names: schema-name | table-name | table-state
A combination of filters creates an AND condition where each record matches all specified filters.
- On success, responds with
DescribeTableStatisticsOutput
with field(s):replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication task.
table_statistics(Option<Vec<TableStatistics>>)
:The table statistics.
marker(Option<String>)
:An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
- On failure, responds with
SdkError<DescribeTableStatisticsError>
sourcepub fn import_certificate(&self) -> ImportCertificate
pub fn import_certificate(&self) -> ImportCertificate
Constructs a fluent builder for the ImportCertificate
operation.
- The fluent builder is configurable:
certificate_identifier(impl Into<String>)
/set_certificate_identifier(Option<String>)
:A customer-assigned name for the certificate. 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.
certificate_pem(impl Into<String>)
/set_certificate_pem(Option<String>)
:The contents of a
.pem
file, which contains an X.509 certificate.certificate_wallet(Blob)
/set_certificate_wallet(Option<Blob>)
:The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a
.sso
file using thefileb://
prefix. You can’t provide the certificate inline.Example:
filebase64(“${path.root}/rds-ca-2019-root.sso”)
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags associated with the certificate.
- On success, responds with
ImportCertificateOutput
with field(s):certificate(Option<Certificate>)
:The certificate to be uploaded.
- On failure, responds with
SdkError<ImportCertificateError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) string that uniquely identifies the DMS resource to list tags for. This returns a list of keys (names of tags) created for the resource and their associated tag values.
resource_arn_list(Vec<String>)
/set_resource_arn_list(Option<Vec<String>>)
:List of ARNs that identify multiple DMS resources that you want to list tags for. This returns a list of keys (tag names) and their associated tag values. It also returns each tag’s associated
ResourceArn
value, which is the ARN of the resource for which each listed tag is created.
- On success, responds with
ListTagsForResourceOutput
with field(s):tag_list(Option<Vec<Tag>>)
:A list of tags for the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn modify_endpoint(&self) -> ModifyEndpoint
pub fn modify_endpoint(&self) -> ModifyEndpoint
Constructs a fluent builder for the ModifyEndpoint
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
endpoint_identifier(impl Into<String>)
/set_endpoint_identifier(Option<String>)
: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.
endpoint_type(ReplicationEndpointTypeValue)
/set_endpoint_type(Option<ReplicationEndpointTypeValue>)
:The type of endpoint. Valid values are
source
andtarget
.engine_name(impl Into<String>)
/set_engine_name(Option<String>)
:The database engine name. Valid values, depending on the EndpointType, include
“mysql”
,“oracle”
,“postgres”
,“mariadb”
,“aurora”
,“aurora-postgresql”
,“redshift”
,“s3”
,“db2”
,“db2-zos”
,“azuredb”
,“sybase”
,“dynamodb”
,“mongodb”
,“kinesis”
,“kafka”
,“elasticsearch”
,“documentdb”
,“sqlserver”
,“neptune”
, and“babelfish”
.username(impl Into<String>)
/set_username(Option<String>)
:The user name to be used to login to the endpoint database.
password(impl Into<String>)
/set_password(Option<String>)
:The password to be used to login to the endpoint database.
server_name(impl Into<String>)
/set_server_name(Option<String>)
:The name of the server where the endpoint database resides.
port(i32)
/set_port(Option<i32>)
:The port used by the endpoint database.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
extra_connection_attributes(impl Into<String>)
/set_extra_connection_attributes(Option<String>)
:Additional attributes associated with the connection. To reset this parameter, pass the empty string (“”) as an argument.
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:The Amazon Resource Name (ARN) of the certificate used for SSL connection.
ssl_mode(DmsSslModeValue)
/set_ssl_mode(Option<DmsSslModeValue>)
:The SSL mode used to connect to the endpoint. The default value is
none
.service_access_role_arn(impl Into<String>)
/set_service_access_role_arn(Option<String>)
: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.external_table_definition(impl Into<String>)
/set_external_table_definition(Option<String>)
:The external table definition.
dynamo_db_settings(DynamoDbSettings)
/set_dynamo_db_settings(Option<DynamoDbSettings>)
: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 in the Database Migration Service User Guide.
s3_settings(S3Settings)
/set_s3_settings(Option<S3Settings>)
: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 DMS in the Database Migration Service User Guide.
dms_transfer_settings(DmsTransferSettings)
/set_dms_transfer_settings(Option<DmsTransferSettings>)
:The settings in JSON format for the DMS transfer type of source endpoint.
Attributes include the following:
-
serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the
iam:PassRole
action. -
BucketName - The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string ,BucketName=string
JSON syntax for these settings is as follows:
{ “ServiceAccessRoleArn”: “string”, “BucketName”: “string”}
-
mongo_db_settings(MongoDbSettings)
/set_mongo_db_settings(Option<MongoDbSettings>)
:Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.
kinesis_settings(KinesisSettings)
/set_kinesis_settings(Option<KinesisSettings>)
:Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.
kafka_settings(KafkaSettings)
/set_kafka_settings(Option<KafkaSettings>)
:Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.
elasticsearch_settings(ElasticsearchSettings)
/set_elasticsearch_settings(Option<ElasticsearchSettings>)
:Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.
neptune_settings(NeptuneSettings)
/set_neptune_settings(Option<NeptuneSettings>)
:Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.
redshift_settings(RedshiftSettings)
/set_redshift_settings(Option<RedshiftSettings>)
:Provides information that defines an Amazon Redshift endpoint.
postgre_sql_settings(PostgreSqlSettings)
/set_postgre_sql_settings(Option<PostgreSqlSettings>)
: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 DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.
my_sql_settings(MySqlSettings)
/set_my_sql_settings(Option<MySqlSettings>)
: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 DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.
oracle_settings(OracleSettings)
/set_oracle_settings(Option<OracleSettings>)
: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 DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.
sybase_settings(SybaseSettings)
/set_sybase_settings(Option<SybaseSettings>)
: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 DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.
microsoft_sql_server_settings(MicrosoftSqlServerSettings)
/set_microsoft_sql_server_settings(Option<MicrosoftSqlServerSettings>)
: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 DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.
ibm_db2_settings(IbmDb2Settings)
/set_ibm_db2_settings(Option<IbmDb2Settings>)
: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 DMS in the Database Migration Service User Guide.
doc_db_settings(DocDbSettings)
/set_doc_db_settings(Option<DocDbSettings>)
: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 Database Migration Service in the Database Migration Service User Guide.
redis_settings(RedisSettings)
/set_redis_settings(Option<RedisSettings>)
:Settings in JSON format for the Redis target endpoint.
exact_settings(bool)
/set_exact_settings(Option<bool>)
: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 toModifyEndpoint
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 callmodify-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.-
gcp_my_sql_settings(GcpMySqlSettings)
/set_gcp_my_sql_settings(Option<GcpMySqlSettings>)
:Settings in JSON format for the source GCP MySQL endpoint.
- On success, responds with
ModifyEndpointOutput
with field(s):endpoint(Option<Endpoint>)
:The modified endpoint.
- On failure, responds with
SdkError<ModifyEndpointError>
sourcepub fn modify_event_subscription(&self) -> ModifyEventSubscription
pub fn modify_event_subscription(&self) -> ModifyEventSubscription
Constructs a fluent builder for the ModifyEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:The name of the DMS event notification subscription to be modified.
sns_topic_arn(impl Into<String>)
/set_sns_topic_arn(Option<String>)
: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.
source_type(impl Into<String>)
/set_source_type(Option<String>)
:The type of DMS resource that generates the events you want to subscribe to.
Valid values: replication-instance | replication-task
event_categories(Vec<String>)
/set_event_categories(Option<Vec<String>>)
:A list of event categories for a source type that you want to subscribe to. Use the
DescribeEventCategories
action to see a list of event categories.enabled(bool)
/set_enabled(Option<bool>)
:A Boolean value; set to true to activate the subscription.
- On success, responds with
ModifyEventSubscriptionOutput
with field(s):event_subscription(Option<EventSubscription>)
:The modified event subscription.
- On failure, responds with
SdkError<ModifyEventSubscriptionError>
sourcepub fn modify_replication_instance(&self) -> ModifyReplicationInstance
pub fn modify_replication_instance(&self) -> ModifyReplicationInstance
Constructs a fluent builder for the ModifyReplicationInstance
operation.
- The fluent builder is configurable:
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance.
allocated_storage(i32)
/set_allocated_storage(Option<i32>)
:The amount of storage (in gigabytes) to be allocated for the replication instance.
apply_immediately(bool)
/set_apply_immediately(bool)
:Indicates whether the changes should be applied immediately or during the next maintenance window.
replication_instance_class(impl Into<String>)
/set_replication_instance_class(Option<String>)
:The compute and memory capacity of the replication instance as defined 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 DMS replication instance for your migration.
vpc_security_group_ids(Vec<String>)
/set_vpc_security_group_ids(Option<Vec<String>>)
:Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
multi_az(bool)
/set_multi_az(Option<bool>)
:Specifies whether the replication instance is a Multi-AZ deployment. You can’t set the
AvailabilityZone
parameter if the Multi-AZ parameter is set totrue
.engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The engine version number of the replication instance.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgrade
totrue
.allow_major_version_upgrade(bool)
/set_allow_major_version_upgrade(bool)
:Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.
This parameter must be set to
true
when specifying a value for theEngineVersion
parameter that is a different major version than the replication instance’s current version.auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(Option<bool>)
:A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn’t result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
-
This parameter is set to
true
during the maintenance window. -
A newer minor version is available.
-
DMS has enabled automatic patching for the given engine version.
-
replication_instance_identifier(impl Into<String>)
/set_replication_instance_identifier(Option<String>)
:The replication instance identifier. This parameter is stored as a lowercase string.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
- On success, responds with
ModifyReplicationInstanceOutput
with field(s):replication_instance(Option<ReplicationInstance>)
:The modified replication instance.
- On failure, responds with
SdkError<ModifyReplicationInstanceError>
sourcepub fn modify_replication_subnet_group(&self) -> ModifyReplicationSubnetGroup
pub fn modify_replication_subnet_group(&self) -> ModifyReplicationSubnetGroup
Constructs a fluent builder for the ModifyReplicationSubnetGroup
operation.
- The fluent builder is configurable:
replication_subnet_group_identifier(impl Into<String>)
/set_replication_subnet_group_identifier(Option<String>)
:The name of the replication instance subnet group.
replication_subnet_group_description(impl Into<String>)
/set_replication_subnet_group_description(Option<String>)
:A description for the replication instance subnet group.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:A list of subnet IDs.
- On success, responds with
ModifyReplicationSubnetGroupOutput
with field(s):replication_subnet_group(Option<ReplicationSubnetGroup>)
:The modified replication subnet group.
- On failure, responds with
SdkError<ModifyReplicationSubnetGroupError>
sourcepub fn modify_replication_task(&self) -> ModifyReplicationTask
pub fn modify_replication_task(&self) -> ModifyReplicationTask
Constructs a fluent builder for the ModifyReplicationTask
operation.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication task.
replication_task_identifier(impl Into<String>)
/set_replication_task_identifier(Option<String>)
:The replication task identifier.
Constraints:
-
Must contain 1-255 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
-
migration_type(MigrationTypeValue)
/set_migration_type(Option<MigrationTypeValue>)
:The migration type. Valid values:
full-load
|cdc
|full-load-and-cdc
table_mappings(impl Into<String>)
/set_table_mappings(Option<String>)
: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.replication_task_settings(impl Into<String>)
/set_replication_task_settings(Option<String>)
:JSON file that contains settings for the task, such as task metadata settings.
cdc_start_time(DateTime)
/set_cdc_start_time(Option<DateTime>)
:Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”
cdc_start_position(impl Into<String>)
/set_cdc_start_position(Option<String>)
:Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: –cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”
LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”
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 DMS.cdc_stop_position(impl Into<String>)
/set_cdc_stop_position(Option<String>)
:Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
task_data(impl Into<String>)
/set_task_data(Option<String>)
: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 in the Database Migration Service User Guide.
- On success, responds with
ModifyReplicationTaskOutput
with field(s):replication_task(Option<ReplicationTask>)
:The replication task that was modified.
- On failure, responds with
SdkError<ModifyReplicationTaskError>
sourcepub fn move_replication_task(&self) -> MoveReplicationTask
pub fn move_replication_task(&self) -> MoveReplicationTask
Constructs a fluent builder for the MoveReplicationTask
operation.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the task that you want to move.
target_replication_instance_arn(impl Into<String>)
/set_target_replication_instance_arn(Option<String>)
:The ARN of the replication instance where you want to move the task to.
- On success, responds with
MoveReplicationTaskOutput
with field(s):replication_task(Option<ReplicationTask>)
:The replication task that was moved.
- On failure, responds with
SdkError<MoveReplicationTaskError>
sourcepub fn reboot_replication_instance(&self) -> RebootReplicationInstance
pub fn reboot_replication_instance(&self) -> RebootReplicationInstance
Constructs a fluent builder for the RebootReplicationInstance
operation.
- The fluent builder is configurable:
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance.
force_failover(bool)
/set_force_failover(Option<bool>)
:If this parameter is
true
, the reboot is conducted through a Multi-AZ failover. If the instance isn’t configured for Multi-AZ, then you can’t specifytrue
. (–force-planned-failover
and–force-failover
can’t both be set totrue
.)force_planned_failover(bool)
/set_force_planned_failover(Option<bool>)
:If this parameter is
true
, the reboot is conducted through a planned Multi-AZ failover where resources are released and cleaned up prior to conducting the failover. If the instance isn’’t configured for Multi-AZ, then you can’t specifytrue
. (–force-planned-failover
and–force-failover
can’t both be set totrue
.)
- On success, responds with
RebootReplicationInstanceOutput
with field(s):replication_instance(Option<ReplicationInstance>)
:The replication instance that is being rebooted.
- On failure, responds with
SdkError<RebootReplicationInstanceError>
sourcepub fn refresh_schemas(&self) -> RefreshSchemas
pub fn refresh_schemas(&self) -> RefreshSchemas
Constructs a fluent builder for the RefreshSchemas
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance.
- On success, responds with
RefreshSchemasOutput
with field(s):refresh_schemas_status(Option<RefreshSchemasStatus>)
:The status of the refreshed schema.
- On failure, responds with
SdkError<RefreshSchemasError>
sourcepub fn reload_tables(&self) -> ReloadTables
pub fn reload_tables(&self) -> ReloadTables
Constructs a fluent builder for the ReloadTables
operation.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication task.
tables_to_reload(Vec<TableToReload>)
/set_tables_to_reload(Option<Vec<TableToReload>>)
:The name and schema of the table to be reloaded.
reload_option(ReloadOptionValue)
/set_reload_option(Option<ReloadOptionValue>)
:Options for reload. Specify
data-reload
to reload the data and re-validate it if validation is enabled. Specifyvalidate-only
to re-validate the table. This option applies only when validation is enabled for the task.Valid values: data-reload, validate-only
Default value is data-reload.
- On success, responds with
ReloadTablesOutput
with field(s):replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication task.
- On failure, responds with
SdkError<ReloadTablesError>
Constructs a fluent builder for the RemoveTagsFromResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:An DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag key (name) of the tag to be removed.
- On success, responds with
RemoveTagsFromResourceOutput
- On failure, responds with
SdkError<RemoveTagsFromResourceError>
sourcepub fn run_fleet_advisor_lsa_analysis(&self) -> RunFleetAdvisorLsaAnalysis
pub fn run_fleet_advisor_lsa_analysis(&self) -> RunFleetAdvisorLsaAnalysis
Constructs a fluent builder for the RunFleetAdvisorLsaAnalysis
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
RunFleetAdvisorLsaAnalysisOutput
with field(s):lsa_analysis_id(Option<String>)
:The ID of the LSA analysis run.
status(Option<String>)
:The status of the LSA analysis, for example
COMPLETED
.
- On failure, responds with
SdkError<RunFleetAdvisorLsaAnalysisError>
sourcepub fn start_replication_task(&self) -> StartReplicationTask
pub fn start_replication_task(&self) -> StartReplicationTask
Constructs a fluent builder for the StartReplicationTask
operation.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication task to be started.
start_replication_task_type(StartReplicationTaskTypeValue)
/set_start_replication_task_type(Option<StartReplicationTaskTypeValue>)
:The type of replication task to start.
When the migration type is
full-load
orfull-load-and-cdc
, the only valid value for the first run of the task isstart-replication
. You usereload-target
to restart the task andresume-processing
to resume the task.When the migration type is
cdc
, you usestart-replication
to start or restart the task, andresume-processing
to resume the task.reload-target
is not a valid value for a task with migration type ofcdc
.cdc_start_time(DateTime)
/set_cdc_start_time(Option<DateTime>)
:Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.
Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”
cdc_start_position(impl Into<String>)
/set_cdc_start_position(Option<String>)
:Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: –cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”
LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”
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 DMS.cdc_stop_position(impl Into<String>)
/set_cdc_stop_position(Option<String>)
:Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
- On success, responds with
StartReplicationTaskOutput
with field(s):replication_task(Option<ReplicationTask>)
:The replication task started.
- On failure, responds with
SdkError<StartReplicationTaskError>
sourcepub fn start_replication_task_assessment(
&self
) -> StartReplicationTaskAssessment
pub fn start_replication_task_assessment(
&self
) -> StartReplicationTaskAssessment
Constructs a fluent builder for the StartReplicationTaskAssessment
operation.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication task.
- On success, responds with
StartReplicationTaskAssessmentOutput
with field(s):replication_task(Option<ReplicationTask>)
:The assessed replication task.
- On failure, responds with
SdkError<StartReplicationTaskAssessmentError>
sourcepub fn start_replication_task_assessment_run(
&self
) -> StartReplicationTaskAssessmentRun
pub fn start_replication_task_assessment_run(
&self
) -> StartReplicationTaskAssessmentRun
Constructs a fluent builder for the StartReplicationTaskAssessmentRun
operation.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.
service_access_role_arn(impl Into<String>)
/set_service_access_role_arn(Option<String>)
:ARN of the service role needed to start the assessment run. The role must allow the
iam:PassRole
action.result_location_bucket(impl Into<String>)
/set_result_location_bucket(Option<String>)
:Amazon S3 bucket where you want DMS to store the results of this assessment run.
result_location_folder(impl Into<String>)
/set_result_location_folder(Option<String>)
:Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.
result_encryption_mode(impl Into<String>)
/set_result_encryption_mode(Option<String>)
:Encryption mode that you can specify to encrypt the results of this 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”
– 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.
-
result_kms_key_arn(impl Into<String>)
/set_result_kms_key_arn(Option<String>)
:ARN of a custom KMS encryption key that you specify when you set
ResultEncryptionMode
to“SSE_KMS
”.assessment_run_name(impl Into<String>)
/set_assessment_run_name(Option<String>)
:Unique name to identify the assessment run.
include_only(Vec<String>)
/set_include_only(Option<Vec<String>>)
: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 DMS supports for the associated migration task. This task is specified by
ReplicationTaskArn
.You can’t set a value for
IncludeOnly
if you also set a value forExclude
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.exclude(Vec<String>)
/set_exclude(Option<Vec<String>>)
: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 DMS supports for the associated migration task. This task is specified by
ReplicationTaskArn
.You can’t set a value for
Exclude
if you also set a value forIncludeOnly
in the API operation.To identify the names of the default individual assessments that DMS supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its ownReplicationTaskArn
request parameter.
- On success, responds with
StartReplicationTaskAssessmentRunOutput
with field(s):replication_task_assessment_run(Option<ReplicationTaskAssessmentRun>)
:The premigration assessment run that was started.
- On failure, responds with
SdkError<StartReplicationTaskAssessmentRunError>
sourcepub fn stop_replication_task(&self) -> StopReplicationTask
pub fn stop_replication_task(&self) -> StopReplicationTask
Constructs a fluent builder for the StopReplicationTask
operation.
- The fluent builder is configurable:
replication_task_arn(impl Into<String>)
/set_replication_task_arn(Option<String>)
:The Amazon Resource Name(ARN) of the replication task to be stopped.
- On success, responds with
StopReplicationTaskOutput
with field(s):replication_task(Option<ReplicationTask>)
:The replication task stopped.
- On failure, responds with
SdkError<StopReplicationTaskError>
sourcepub fn test_connection(&self) -> TestConnection
pub fn test_connection(&self) -> TestConnection
Constructs a fluent builder for the TestConnection
operation.
- The fluent builder is configurable:
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:The Amazon Resource Name (ARN) of the replication instance.
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
- On success, responds with
TestConnectionOutput
with field(s):connection(Option<Connection>)
:The connection tested.
- On failure, responds with
SdkError<TestConnectionError>
sourcepub fn update_subscriptions_to_event_bridge(
&self
) -> UpdateSubscriptionsToEventBridge
pub fn update_subscriptions_to_event_bridge(
&self
) -> UpdateSubscriptionsToEventBridge
Constructs a fluent builder for the UpdateSubscriptionsToEventBridge
operation.
- The fluent builder is configurable:
force_move(bool)
/set_force_move(Option<bool>)
:When set to true, this operation migrates DMS subscriptions for Amazon SNS notifications no matter what your replication instance version is. If not set or set to false, this operation runs only when all your replication instances are from DMS version 3.4.6 or higher.
- On success, responds with
UpdateSubscriptionsToEventBridgeOutput
with field(s):result(Option<String>)
:A string that indicates how many event subscriptions were migrated and how many remain to be migrated.
- On failure, responds with
SdkError<UpdateSubscriptionsToEventBridgeError>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
Panics
- This method will panic if the
conf
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
conf
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.