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.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_databasemigration::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_databasemigration::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AddTagsToResource
operation has
a Client::add_tags_to_resource
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.add_tags_to_resource()
.resource_arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
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>)
:
required: trueIdentifies 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueOne or more tags to be assigned to the resource.
- On success, responds with
AddTagsToResourceOutput
- On failure, responds with
SdkError<AddTagsToResourceError>
Source§impl Client
impl Client
Sourcepub fn apply_pending_maintenance_action(
&self,
) -> ApplyPendingMaintenanceActionFluentBuilder
pub fn apply_pending_maintenance_action( &self, ) -> ApplyPendingMaintenanceActionFluentBuilder
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>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: trueA 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>
Source§impl Client
impl Client
Sourcepub fn batch_start_recommendations(
&self,
) -> BatchStartRecommendationsFluentBuilder
pub fn batch_start_recommendations( &self, ) -> BatchStartRecommendationsFluentBuilder
Constructs a fluent builder for the BatchStartRecommendations
operation.
- The fluent builder is configurable:
data(StartRecommendationsRequestEntry)
/set_data(Option<Vec::<StartRecommendationsRequestEntry>>)
:
required: falseProvides information about source databases to analyze. After this analysis, Fleet Advisor recommends target engines for each source database.
- On success, responds with
BatchStartRecommendationsOutput
with field(s):error_entries(Option<Vec::<BatchStartRecommendationsErrorEntry>>)
:A list with error details about the analysis of each source database.
- On failure, responds with
SdkError<BatchStartRecommendationsError>
Source§impl Client
impl Client
Sourcepub fn cancel_replication_task_assessment_run(
&self,
) -> CancelReplicationTaskAssessmentRunFluentBuilder
pub fn cancel_replication_task_assessment_run( &self, ) -> CancelReplicationTaskAssessmentRunFluentBuilder
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>)
:
required: trueAmazon 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>
Source§impl Client
impl Client
Sourcepub fn create_data_migration(&self) -> CreateDataMigrationFluentBuilder
pub fn create_data_migration(&self) -> CreateDataMigrationFluentBuilder
Constructs a fluent builder for the CreateDataMigration
operation.
- The fluent builder is configurable:
data_migration_name(impl Into<String>)
/set_data_migration_name(Option<String>)
:
required: falseA user-friendly name for the data migration. Data migration names have the following constraints:
-
Must begin with a letter, and can only contain ASCII letters, digits, and hyphens.
-
Can’t end with a hyphen or contain two consecutive hyphens.
-
Length must be from 1 to 255 characters.
-
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueAn identifier for the migration project.
data_migration_type(MigrationTypeValue)
/set_data_migration_type(Option<MigrationTypeValue>)
:
required: trueSpecifies if the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
service_access_role_arn(impl Into<String>)
/set_service_access_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.
enable_cloudwatch_logs(bool)
/set_enable_cloudwatch_logs(Option<bool>)
:
required: falseSpecifies whether to enable CloudWatch logs for the data migration.
source_data_settings(SourceDataSetting)
/set_source_data_settings(Option<Vec::<SourceDataSetting>>)
:
required: falseSpecifies information about the source data provider.
number_of_jobs(i32)
/set_number_of_jobs(Option<i32>)
:
required: falseThe number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tags to be assigned to the data migration.
selection_rules(impl Into<String>)
/set_selection_rules(Option<String>)
:
required: falseAn optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.
- On success, responds with
CreateDataMigrationOutput
with field(s):data_migration(Option<DataMigration>)
:Information about the created data migration.
- On failure, responds with
SdkError<CreateDataMigrationError>
Source§impl Client
impl Client
Sourcepub fn create_data_provider(&self) -> CreateDataProviderFluentBuilder
pub fn create_data_provider(&self) -> CreateDataProviderFluentBuilder
Constructs a fluent builder for the CreateDataProvider
operation.
- The fluent builder is configurable:
data_provider_name(impl Into<String>)
/set_data_provider_name(Option<String>)
:
required: falseA user-friendly name for the data provider.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA user-friendly description of the data provider.
engine(impl Into<String>)
/set_engine(Option<String>)
:
required: trueThe type of database engine for the data provider. Valid values include
“aurora”
,“aurora-postgresql”
,“mysql”
,“oracle”
,“postgres”
,“sqlserver”
,redshift
,mariadb
,mongodb
, anddocdb
. A value of“aurora”
represents Amazon Aurora MySQL-Compatible Edition.settings(DataProviderSettings)
/set_settings(Option<DataProviderSettings>)
:
required: trueThe settings in JSON format for a data provider.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tags to be assigned to the data provider.
- On success, responds with
CreateDataProviderOutput
with field(s):data_provider(Option<DataProvider>)
:The data provider that was created.
- On failure, responds with
SdkError<CreateDataProviderError>
Source§impl Client
impl Client
Sourcepub fn create_endpoint(&self) -> CreateEndpointFluentBuilder
pub fn create_endpoint(&self) -> CreateEndpointFluentBuilder
Constructs a fluent builder for the CreateEndpoint
operation.
- The fluent builder is configurable:
endpoint_identifier(impl Into<String>)
/set_endpoint_identifier(Option<String>)
:
required: trueThe 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>)
:
required: trueThe type of endpoint. Valid values are
source
andtarget
.engine_name(impl Into<String>)
/set_engine_name(Option<String>)
:
required: trueThe 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”
,“babelfish”
,redshift-serverless
,aurora-serverless
,aurora-postgresql-serverless
,gcp-mysql
,azure-sql-managed-instance
,redis
,dms-transfer
.username(impl Into<String>)
/set_username(Option<String>)
:
required: falseThe user name to be used to log in to the endpoint database.
password(impl Into<String>)
/set_password(Option<String>)
:
required: falseThe password to be used to log in to the endpoint database.
server_name(impl Into<String>)
/set_server_name(Option<String>)
:
required: falseThe name of the server where the endpoint database resides.
port(i32)
/set_port(Option<i32>)
:
required: falseThe port used by the endpoint database.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: falseThe 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>)
:
required: falseAdditional 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>)
:
required: falseAn 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tags to be assigned to the endpoint.
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) for the certificate.
ssl_mode(DmsSslModeValue)
/set_ssl_mode(Option<DmsSslModeValue>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe external table definition.
dynamo_db_settings(DynamoDbSettings)
/set_dynamo_db_settings(Option<DynamoDbSettings>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseThe 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseProvides information that defines an Amazon Redshift endpoint.
postgre_sql_settings(PostgreSqlSettings)
/set_postgre_sql_settings(Option<PostgreSqlSettings>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseA 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>)
:
required: falseProvides information that defines a DocumentDB endpoint.
redis_settings(RedisSettings)
/set_redis_settings(Option<RedisSettings>)
:
required: falseSettings in JSON format for the target Redis endpoint.
gcp_my_sql_settings(GcpMySqlSettings)
/set_gcp_my_sql_settings(Option<GcpMySqlSettings>)
:
required: falseSettings in JSON format for the source GCP MySQL endpoint.
timestream_settings(TimestreamSettings)
/set_timestream_settings(Option<TimestreamSettings>)
:
required: falseSettings in JSON format for the target Amazon Timestream endpoint.
- On success, responds with
CreateEndpointOutput
with field(s):endpoint(Option<Endpoint>)
:The endpoint that was created.
- On failure, responds with
SdkError<CreateEndpointError>
Source§impl Client
impl Client
Sourcepub fn create_event_subscription(&self) -> CreateEventSubscriptionFluentBuilder
pub fn create_event_subscription(&self) -> CreateEventSubscriptionFluentBuilder
Constructs a fluent builder for the CreateEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:
required: trueThe 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>)
:
required: trueThe 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>)
:
required: falseThe 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(impl Into<String>)
/set_event_categories(Option<Vec::<String>>)
:
required: falseA 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(impl Into<String>)
/set_source_ids(Option<Vec::<String>>)
:
required: falseA 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>)
:
required: falseA Boolean value; set to
true
to activate the subscription, or set tofalse
to create the subscription but not activate it.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne 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>
Source§impl Client
impl Client
Sourcepub fn create_fleet_advisor_collector(
&self,
) -> CreateFleetAdvisorCollectorFluentBuilder
pub fn create_fleet_advisor_collector( &self, ) -> CreateFleetAdvisorCollectorFluentBuilder
Constructs a fluent builder for the CreateFleetAdvisorCollector
operation.
- The fluent builder is configurable:
collector_name(impl Into<String>)
/set_collector_name(Option<String>)
:
required: trueThe name of your Fleet Advisor collector (for example,
sample-collector
).description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA summary description of your Fleet Advisor collector.
service_access_role_arn(impl Into<String>)
/set_service_access_role_arn(Option<String>)
:
required: trueThe IAM role that grants permissions to access the specified Amazon S3 bucket.
s3_bucket_name(impl Into<String>)
/set_s3_bucket_name(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn create_instance_profile(&self) -> CreateInstanceProfileFluentBuilder
pub fn create_instance_profile(&self) -> CreateInstanceProfileFluentBuilder
Constructs a fluent builder for the CreateInstanceProfile
operation.
- The fluent builder is configurable:
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:
required: falseThe Availability Zone where the instance profile will be created. The default value is a random, system-chosen Availability Zone in the Amazon Web Services Region where your data provider is created, for examplem
us-east-1d
.kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
If you don’t specify a value for the
KmsKeyArn
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>)
:
required: falseSpecifies the accessibility options for the instance profile. A value of
true
represents an instance profile with a public IP address. A value offalse
represents an instance profile with a private IP address. The default value istrue
.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tags to be assigned to the instance profile.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:
required: falseSpecifies the network type for the instance profile. A value of
IPV4
represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value ofIPV6
represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value ofDUAL
represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.instance_profile_name(impl Into<String>)
/set_instance_profile_name(Option<String>)
:
required: falseA user-friendly name for the instance profile.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA user-friendly description of the instance profile.
subnet_group_identifier(impl Into<String>)
/set_subnet_group_identifier(Option<String>)
:
required: falseA subnet group to associate with the instance profile.
vpc_security_groups(impl Into<String>)
/set_vpc_security_groups(Option<Vec::<String>>)
:
required: falseSpecifies the VPC security group names to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
- On success, responds with
CreateInstanceProfileOutput
with field(s):instance_profile(Option<InstanceProfile>)
:The instance profile that was created.
- On failure, responds with
SdkError<CreateInstanceProfileError>
Source§impl Client
impl Client
Sourcepub fn create_migration_project(&self) -> CreateMigrationProjectFluentBuilder
pub fn create_migration_project(&self) -> CreateMigrationProjectFluentBuilder
Constructs a fluent builder for the CreateMigrationProject
operation.
- The fluent builder is configurable:
migration_project_name(impl Into<String>)
/set_migration_project_name(Option<String>)
:
required: falseA user-friendly name for the migration project.
source_data_provider_descriptors(DataProviderDescriptorDefinition)
/set_source_data_provider_descriptors(Option<Vec::<DataProviderDescriptorDefinition>>)
:
required: trueInformation about the source data provider, including the name, ARN, and Secrets Manager parameters.
target_data_provider_descriptors(DataProviderDescriptorDefinition)
/set_target_data_provider_descriptors(Option<Vec::<DataProviderDescriptorDefinition>>)
:
required: trueInformation about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
instance_profile_identifier(impl Into<String>)
/set_instance_profile_identifier(Option<String>)
:
required: trueThe identifier of the associated instance profile. 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.
transformation_rules(impl Into<String>)
/set_transformation_rules(Option<String>)
:
required: falseThe settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA user-friendly description of the migration project.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tags to be assigned to the migration project.
schema_conversion_application_attributes(ScApplicationAttributes)
/set_schema_conversion_application_attributes(Option<ScApplicationAttributes>)
:
required: falseThe schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
- On success, responds with
CreateMigrationProjectOutput
with field(s):migration_project(Option<MigrationProject>)
:The migration project that was created.
- On failure, responds with
SdkError<CreateMigrationProjectError>
Source§impl Client
impl Client
Sourcepub fn create_replication_config(&self) -> CreateReplicationConfigFluentBuilder
pub fn create_replication_config(&self) -> CreateReplicationConfigFluentBuilder
Constructs a fluent builder for the CreateReplicationConfig
operation.
- The fluent builder is configurable:
replication_config_identifier(impl Into<String>)
/set_replication_config_identifier(Option<String>)
:
required: trueA unique identifier that you want to use to create a
ReplicationConfigArn
that is returned as part of the output from this action. You can then pass this outputReplicationConfigArn
as the value of theReplicationConfigArn
option for other actions to identify both DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.source_endpoint_arn(impl Into<String>)
/set_source_endpoint_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the source endpoint for this DMS Serverless replication configuration.
target_endpoint_arn(impl Into<String>)
/set_target_endpoint_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.
compute_config(ComputeConfig)
/set_compute_config(Option<ComputeConfig>)
:
required: trueConfiguration parameters for provisioning an DMS Serverless replication.
replication_type(MigrationTypeValue)
/set_replication_type(Option<MigrationTypeValue>)
:
required: trueThe type of DMS Serverless replication to provision using this replication configuration.
Possible values:
-
“full-load”
-
“cdc”
-
“full-load-and-cdc”
-
table_mappings(impl Into<String>)
/set_table_mappings(Option<String>)
:
required: trueJSON table mappings for DMS Serverless replications that are provisioned using this replication configuration. For more information, see Specifying table selection and transformations rules using JSON.
replication_settings(impl Into<String>)
/set_replication_settings(Option<String>)
:
required: falseOptional JSON settings for DMS Serverless replications that are provisioned using this replication configuration. For example, see Change processing tuning settings.
supplemental_settings(impl Into<String>)
/set_supplemental_settings(Option<String>)
:
required: falseOptional JSON settings for specifying supplemental data. For more information, see Specifying supplemental data for task settings.
resource_identifier(impl Into<String>)
/set_resource_identifier(Option<String>)
:
required: falseOptional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more optional tags associated with resources used by the DMS Serverless replication. For more information, see Tagging resources in Database Migration Service.
- On success, responds with
CreateReplicationConfigOutput
with field(s):replication_config(Option<ReplicationConfig>)
:Configuration parameters returned from the DMS Serverless replication after it is created.
- On failure, responds with
SdkError<CreateReplicationConfigError>
Source§impl Client
impl Client
Sourcepub fn create_replication_instance(
&self,
) -> CreateReplicationInstanceFluentBuilder
pub fn create_replication_instance( &self, ) -> CreateReplicationInstanceFluentBuilder
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>)
:
required: trueThe 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>)
:
required: falseThe 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>)
:
required: trueThe 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 Choosing the right DMS replication instance; and, Selecting the best size for a replication instance.
vpc_security_group_ids(impl Into<String>)
/set_vpc_security_group_ids(Option<Vec::<String>>)
:
required: falseSpecifies 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>)
:
required: falseThe 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>)
:
required: falseA subnet group to associate with the replication instance.
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:
required: falseThe 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>)
:
required: falseSpecifies 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>)
:
required: falseThe 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>)
:
required: falseA 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tags to be assigned to the replication instance.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseAn 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>)
:
required: falseSpecifies 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>)
:
required: falseA 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>)
:
required: falseA 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>)
:
required: falseThe 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.
kerberos_authentication_settings(KerberosAuthenticationSettings)
/set_kerberos_authentication_settings(Option<KerberosAuthenticationSettings>)
:
required: falseSpecifies the ID of the secret that stores the key cache file required for kerberos authentication, when creating a replication instance.
- On success, responds with
CreateReplicationInstanceOutput
with field(s):replication_instance(Option<ReplicationInstance>)
:The replication instance that was created.
- On failure, responds with
SdkError<CreateReplicationInstanceError>
Source§impl Client
impl Client
Sourcepub fn create_replication_subnet_group(
&self,
) -> CreateReplicationSubnetGroupFluentBuilder
pub fn create_replication_subnet_group( &self, ) -> CreateReplicationSubnetGroupFluentBuilder
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>)
:
required: trueThe name for the replication subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, or hyphens. Must not be “default”.
Example:
mySubnetgroup
replication_subnet_group_description(impl Into<String>)
/set_replication_subnet_group_description(Option<String>)
:
required: trueThe description for the subnet group.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueTwo or more subnet IDs to be assigned to the subnet group.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne 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>
Source§impl Client
impl Client
Sourcepub fn create_replication_task(&self) -> CreateReplicationTaskFluentBuilder
pub fn create_replication_task(&self) -> CreateReplicationTaskFluentBuilder
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>)
:
required: trueAn 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>)
:
required: trueAn Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
target_endpoint_arn(impl Into<String>)
/set_target_endpoint_arn(Option<String>)
:
required: trueAn Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of a replication instance.
migration_type(MigrationTypeValue)
/set_migration_type(Option<MigrationTypeValue>)
:
required: trueThe migration type. Valid values:
full-load
|cdc
|full-load-and-cdc
table_mappings(impl Into<String>)
/set_table_mappings(Option<String>)
:
required: trueThe 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>)
:
required: falseOverall 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>)
:
required: falseIndicates 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>)
:
required: falseIndicates 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>)
:
required: falseIndicates 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tags to be assigned to the replication task.
task_data(impl Into<String>)
/set_task_data(Option<String>)
:
required: falseSupplemental 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>)
:
required: falseA 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>
Source§impl Client
impl Client
Sourcepub fn delete_certificate(&self) -> DeleteCertificateFluentBuilder
pub fn delete_certificate(&self) -> DeleteCertificateFluentBuilder
Constructs a fluent builder for the DeleteCertificate
operation.
- The fluent builder is configurable:
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_connection(&self) -> DeleteConnectionFluentBuilder
pub fn delete_connection(&self) -> DeleteConnectionFluentBuilder
Constructs a fluent builder for the DeleteConnection
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_data_migration(&self) -> DeleteDataMigrationFluentBuilder
pub fn delete_data_migration(&self) -> DeleteDataMigrationFluentBuilder
Constructs a fluent builder for the DeleteDataMigration
operation.
- The fluent builder is configurable:
data_migration_identifier(impl Into<String>)
/set_data_migration_identifier(Option<String>)
:
required: trueThe identifier (name or ARN) of the data migration to delete.
- On success, responds with
DeleteDataMigrationOutput
with field(s):data_migration(Option<DataMigration>)
:The deleted data migration.
- On failure, responds with
SdkError<DeleteDataMigrationError>
Source§impl Client
impl Client
Sourcepub fn delete_data_provider(&self) -> DeleteDataProviderFluentBuilder
pub fn delete_data_provider(&self) -> DeleteDataProviderFluentBuilder
Constructs a fluent builder for the DeleteDataProvider
operation.
- The fluent builder is configurable:
data_provider_identifier(impl Into<String>)
/set_data_provider_identifier(Option<String>)
:
required: trueThe identifier of the data provider to delete.
- On success, responds with
DeleteDataProviderOutput
with field(s):data_provider(Option<DataProvider>)
:The data provider that was deleted.
- On failure, responds with
SdkError<DeleteDataProviderError>
Source§impl Client
impl Client
Sourcepub fn delete_endpoint(&self) -> DeleteEndpointFluentBuilder
pub fn delete_endpoint(&self) -> DeleteEndpointFluentBuilder
Constructs a fluent builder for the DeleteEndpoint
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_event_subscription(&self) -> DeleteEventSubscriptionFluentBuilder
pub fn delete_event_subscription(&self) -> DeleteEventSubscriptionFluentBuilder
Constructs a fluent builder for the DeleteEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_fleet_advisor_collector(
&self,
) -> DeleteFleetAdvisorCollectorFluentBuilder
pub fn delete_fleet_advisor_collector( &self, ) -> DeleteFleetAdvisorCollectorFluentBuilder
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>)
:
required: trueThe reference ID of the Fleet Advisor collector to delete.
- On success, responds with
DeleteFleetAdvisorCollectorOutput
- On failure, responds with
SdkError<DeleteFleetAdvisorCollectorError>
Source§impl Client
impl Client
Sourcepub fn delete_fleet_advisor_databases(
&self,
) -> DeleteFleetAdvisorDatabasesFluentBuilder
pub fn delete_fleet_advisor_databases( &self, ) -> DeleteFleetAdvisorDatabasesFluentBuilder
Constructs a fluent builder for the DeleteFleetAdvisorDatabases
operation.
- The fluent builder is configurable:
database_ids(impl Into<String>)
/set_database_ids(Option<Vec::<String>>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_instance_profile(&self) -> DeleteInstanceProfileFluentBuilder
pub fn delete_instance_profile(&self) -> DeleteInstanceProfileFluentBuilder
Constructs a fluent builder for the DeleteInstanceProfile
operation.
- The fluent builder is configurable:
instance_profile_identifier(impl Into<String>)
/set_instance_profile_identifier(Option<String>)
:
required: trueThe identifier of the instance profile to delete.
- On success, responds with
DeleteInstanceProfileOutput
with field(s):instance_profile(Option<InstanceProfile>)
:The instance profile that was deleted.
- On failure, responds with
SdkError<DeleteInstanceProfileError>
Source§impl Client
impl Client
Sourcepub fn delete_migration_project(&self) -> DeleteMigrationProjectFluentBuilder
pub fn delete_migration_project(&self) -> DeleteMigrationProjectFluentBuilder
Constructs a fluent builder for the DeleteMigrationProject
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe name or Amazon Resource Name (ARN) of the migration project to delete.
- On success, responds with
DeleteMigrationProjectOutput
with field(s):migration_project(Option<MigrationProject>)
:The migration project that was deleted.
- On failure, responds with
SdkError<DeleteMigrationProjectError>
Source§impl Client
impl Client
Sourcepub fn delete_replication_config(&self) -> DeleteReplicationConfigFluentBuilder
pub fn delete_replication_config(&self) -> DeleteReplicationConfigFluentBuilder
Constructs a fluent builder for the DeleteReplicationConfig
operation.
- The fluent builder is configurable:
replication_config_arn(impl Into<String>)
/set_replication_config_arn(Option<String>)
:
required: trueThe replication config to delete.
- On success, responds with
DeleteReplicationConfigOutput
with field(s):replication_config(Option<ReplicationConfig>)
:Configuration parameters returned for the DMS Serverless replication after it is deleted.
- On failure, responds with
SdkError<DeleteReplicationConfigError>
Source§impl Client
impl Client
Sourcepub fn delete_replication_instance(
&self,
) -> DeleteReplicationInstanceFluentBuilder
pub fn delete_replication_instance( &self, ) -> DeleteReplicationInstanceFluentBuilder
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>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_replication_subnet_group(
&self,
) -> DeleteReplicationSubnetGroupFluentBuilder
pub fn delete_replication_subnet_group( &self, ) -> DeleteReplicationSubnetGroupFluentBuilder
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>)
:
required: trueThe subnet group name of the replication instance.
- On success, responds with
DeleteReplicationSubnetGroupOutput
- On failure, responds with
SdkError<DeleteReplicationSubnetGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_replication_task(&self) -> DeleteReplicationTaskFluentBuilder
pub fn delete_replication_task(&self) -> DeleteReplicationTaskFluentBuilder
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>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_replication_task_assessment_run(
&self,
) -> DeleteReplicationTaskAssessmentRunFluentBuilder
pub fn delete_replication_task_assessment_run( &self, ) -> DeleteReplicationTaskAssessmentRunFluentBuilder
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>)
:
required: trueAmazon 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>
Source§impl Client
impl Client
Sourcepub fn describe_account_attributes(
&self,
) -> DescribeAccountAttributesFluentBuilder
pub fn describe_account_attributes( &self, ) -> DescribeAccountAttributesFluentBuilder
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>
Source§impl Client
impl Client
Sourcepub fn describe_applicable_individual_assessments(
&self,
) -> DescribeApplicableIndividualAssessmentsFluentBuilder
pub fn describe_applicable_individual_assessments( &self, ) -> DescribeApplicableIndividualAssessmentsFluentBuilder
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>)
:
required: falseAmazon 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>)
:
required: falseARN 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>)
:
required: falseName 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>)
:
required: falseName of a database engine that the specified replication instance supports as a target.
migration_type(MigrationTypeValue)
/set_migration_type(Option<MigrationTypeValue>)
:
required: falseName of the migration type that each provided individual assessment must support.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseMaximum 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>)
:
required: falseOptional 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>
Source§impl Client
impl Client
Sourcepub fn describe_certificates(&self) -> DescribeCertificatesFluentBuilder
pub fn describe_certificates(&self) -> DescribeCertificatesFluentBuilder
Constructs a fluent builder for the DescribeCertificates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters 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>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_connections(&self) -> DescribeConnectionsFluentBuilder
pub fn describe_connections(&self) -> DescribeConnectionsFluentBuilder
Constructs a fluent builder for the DescribeConnections
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseThe filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_conversion_configuration(
&self,
) -> DescribeConversionConfigurationFluentBuilder
pub fn describe_conversion_configuration( &self, ) -> DescribeConversionConfigurationFluentBuilder
Constructs a fluent builder for the DescribeConversionConfiguration
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe name or Amazon Resource Name (ARN) for the schema conversion project to describe.
- On success, responds with
DescribeConversionConfigurationOutput
with field(s):migration_project_identifier(Option<String>)
:The name or Amazon Resource Name (ARN) for the schema conversion project.
conversion_configuration(Option<String>)
:The configuration parameters for the schema conversion project.
- On failure, responds with
SdkError<DescribeConversionConfigurationError>
Source§impl Client
impl Client
Sourcepub fn describe_data_migrations(&self) -> DescribeDataMigrationsFluentBuilder
pub fn describe_data_migrations(&self) -> DescribeDataMigrationsFluentBuilder
Constructs a fluent builder for the DescribeDataMigrations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the data migrations.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>)
:
required: falseAn 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).without_statistics(bool)
/set_without_statistics(Option<bool>)
:
required: falseAn option to set to avoid returning information about statistics. Use this to reduce overhead when statistics information is too large. To use this option, choose
true
; otherwise, choosefalse
(the default).
- On success, responds with
DescribeDataMigrationsOutput
with field(s):data_migrations(Option<Vec::<DataMigration>>)
:Returns information about the data migrations used in the project.
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<DescribeDataMigrationsError>
Source§impl Client
impl Client
Sourcepub fn describe_data_providers(&self) -> DescribeDataProvidersFluentBuilder
pub fn describe_data_providers(&self) -> DescribeDataProvidersFluentBuilder
Constructs a fluent builder for the DescribeDataProviders
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the data providers described in the form of key-value pairs.
Valid filter names and values: data-provider-identifier, data provider arn or name
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, DMS includes a pagination token in the response so that you can retrieve the remaining results.marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
- On success, responds with
DescribeDataProvidersOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.data_providers(Option<Vec::<DataProvider>>)
:A description of data providers.
- On failure, responds with
SdkError<DescribeDataProvidersError>
Source§impl Client
impl Client
Sourcepub fn describe_endpoint_settings(
&self,
) -> DescribeEndpointSettingsFluentBuilder
pub fn describe_endpoint_settings( &self, ) -> DescribeEndpointSettingsFluentBuilder
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>)
:
required: trueThe database engine used for your source or target endpoint.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_endpoint_types(&self) -> DescribeEndpointTypesFluentBuilder
pub fn describe_endpoint_types(&self) -> DescribeEndpointTypesFluentBuilder
Constructs a fluent builder for the DescribeEndpointTypes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the endpoint types.
Valid filter names: engine-name | endpoint-type
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_endpoints(&self) -> DescribeEndpointsFluentBuilder
pub fn describe_endpoints(&self) -> DescribeEndpointsFluentBuilder
Constructs a fluent builder for the DescribeEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_engine_versions(&self) -> DescribeEngineVersionsFluentBuilder
pub fn describe_engine_versions(&self) -> DescribeEngineVersionsFluentBuilder
Constructs a fluent builder for the DescribeEngineVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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
DescribeEngineVersionsOutput
with field(s):engine_versions(Option<Vec::<EngineVersion>>)
:Returned
EngineVersion
objects that describe the replication instance engine versions used in the project.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<DescribeEngineVersionsError>
Source§impl Client
impl Client
Sourcepub fn describe_event_categories(&self) -> DescribeEventCategoriesFluentBuilder
pub fn describe_event_categories(&self) -> DescribeEventCategoriesFluentBuilder
Constructs a fluent builder for the DescribeEventCategories
operation.
- The fluent builder is configurable:
source_type(impl Into<String>)
/set_source_type(Option<String>)
:
required: falseThe type of DMS resource that generates events.
Valid values: replication-instance | replication-task
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters 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>
Source§impl Client
impl Client
Sourcepub fn describe_event_subscriptions(
&self,
) -> DescribeEventSubscriptionsFluentBuilder
pub fn describe_event_subscriptions( &self, ) -> DescribeEventSubscriptionsFluentBuilder
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>)
:
required: falseThe name of the DMS event subscription to be described.
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to event subscriptions.
Valid filter names: event-subscription-arn | event-subscription-id
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_events(&self) -> DescribeEventsFluentBuilder
pub fn describe_events(&self) -> DescribeEventsFluentBuilder
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>)
:
required: falseThe identifier of an event source.
source_type(SourceType)
/set_source_type(Option<SourceType>)
:
required: falseThe type of DMS resource that generates events.
Valid values: replication-instance | replication-task
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe start time for the events to be listed.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseThe end time for the events to be listed.
duration(i32)
/set_duration(Option<i32>)
:
required: falseThe duration of the events to be listed.
event_categories(impl Into<String>)
/set_event_categories(Option<Vec::<String>>)
:
required: falseA list of event categories for the source type that you’ve chosen.
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to events. The only valid filter is
replication-instance-id
.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_extension_pack_associations(
&self,
) -> DescribeExtensionPackAssociationsFluentBuilder
pub fn describe_extension_pack_associations( &self, ) -> DescribeExtensionPackAssociationsFluentBuilder
Constructs a fluent builder for the DescribeExtensionPackAssociations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe name or Amazon Resource Name (ARN) for the migration project.
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the extension pack associations described in the form of key-value pairs.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
- On success, responds with
DescribeExtensionPackAssociationsOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.requests(Option<Vec::<SchemaConversionRequest>>)
:A paginated list of extension pack associations for the specified migration project.
- On failure, responds with
SdkError<DescribeExtensionPackAssociationsError>
Source§impl Client
impl Client
Sourcepub fn describe_fleet_advisor_collectors(
&self,
) -> DescribeFleetAdvisorCollectorsFluentBuilder
pub fn describe_fleet_advisor_collectors( &self, ) -> DescribeFleetAdvisorCollectorsFluentBuilder
Constructs a fluent builder for the DescribeFleetAdvisorCollectors
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseIf 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>)
:
required: falseSets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
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>
Source§impl Client
impl Client
Sourcepub fn describe_fleet_advisor_databases(
&self,
) -> DescribeFleetAdvisorDatabasesFluentBuilder
pub fn describe_fleet_advisor_databases( &self, ) -> DescribeFleetAdvisorDatabasesFluentBuilder
Constructs a fluent builder for the DescribeFleetAdvisorDatabases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseIf 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>)
:
required: falseSets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
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>
Source§impl Client
impl Client
Sourcepub fn describe_fleet_advisor_lsa_analysis(
&self,
) -> DescribeFleetAdvisorLsaAnalysisFluentBuilder
pub fn describe_fleet_advisor_lsa_analysis( &self, ) -> DescribeFleetAdvisorLsaAnalysisFluentBuilder
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>)
:
required: falseSets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
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>
Source§impl Client
impl Client
Sourcepub fn describe_fleet_advisor_schema_object_summary(
&self,
) -> DescribeFleetAdvisorSchemaObjectSummaryFluentBuilder
pub fn describe_fleet_advisor_schema_object_summary( &self, ) -> DescribeFleetAdvisorSchemaObjectSummaryFluentBuilder
Constructs a fluent builder for the DescribeFleetAdvisorSchemaObjectSummary
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseIf 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>)
:
required: falseSets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
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>
Source§impl Client
impl Client
Sourcepub fn describe_fleet_advisor_schemas(
&self,
) -> DescribeFleetAdvisorSchemasFluentBuilder
pub fn describe_fleet_advisor_schemas( &self, ) -> DescribeFleetAdvisorSchemasFluentBuilder
Constructs a fluent builder for the DescribeFleetAdvisorSchemas
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseIf 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>)
:
required: falseSets the maximum number of records returned in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
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>
Source§impl Client
impl Client
Sourcepub fn describe_instance_profiles(
&self,
) -> DescribeInstanceProfilesFluentBuilder
pub fn describe_instance_profiles( &self, ) -> DescribeInstanceProfilesFluentBuilder
Constructs a fluent builder for the DescribeInstanceProfiles
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the instance profiles described in the form of key-value pairs.
Valid filter names and values: instance-profile-identifier, instance profile arn or name
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, DMS includes a pagination token in the response so that you can retrieve the remaining results.marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
- On success, responds with
DescribeInstanceProfilesOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.instance_profiles(Option<Vec::<InstanceProfile>>)
:A description of instance profiles.
- On failure, responds with
SdkError<DescribeInstanceProfilesError>
Source§impl Client
impl Client
Sourcepub fn describe_metadata_model_assessments(
&self,
) -> DescribeMetadataModelAssessmentsFluentBuilder
pub fn describe_metadata_model_assessments( &self, ) -> DescribeMetadataModelAssessmentsFluentBuilder
Constructs a fluent builder for the DescribeMetadataModelAssessments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe name or Amazon Resource Name (ARN) of the migration project.
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the metadata model assessments described in the form of key-value pairs.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
- On success, responds with
DescribeMetadataModelAssessmentsOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.requests(Option<Vec::<SchemaConversionRequest>>)
:A paginated list of metadata model assessments for the specified migration project.
- On failure, responds with
SdkError<DescribeMetadataModelAssessmentsError>
Source§impl Client
impl Client
Sourcepub fn describe_metadata_model_conversions(
&self,
) -> DescribeMetadataModelConversionsFluentBuilder
pub fn describe_metadata_model_conversions( &self, ) -> DescribeMetadataModelConversionsFluentBuilder
Constructs a fluent builder for the DescribeMetadataModelConversions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the metadata model conversions described in the form of key-value pairs.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
- On success, responds with
DescribeMetadataModelConversionsOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.requests(Option<Vec::<SchemaConversionRequest>>)
:A paginated list of metadata model conversions.
- On failure, responds with
SdkError<DescribeMetadataModelConversionsError>
Source§impl Client
impl Client
Sourcepub fn describe_metadata_model_exports_as_script(
&self,
) -> DescribeMetadataModelExportsAsScriptFluentBuilder
pub fn describe_metadata_model_exports_as_script( &self, ) -> DescribeMetadataModelExportsAsScriptFluentBuilder
Constructs a fluent builder for the DescribeMetadataModelExportsAsScript
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the metadata model exports described in the form of key-value pairs.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
- On success, responds with
DescribeMetadataModelExportsAsScriptOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.requests(Option<Vec::<SchemaConversionRequest>>)
:A paginated list of metadata model exports.
- On failure, responds with
SdkError<DescribeMetadataModelExportsAsScriptError>
Source§impl Client
impl Client
Sourcepub fn describe_metadata_model_exports_to_target(
&self,
) -> DescribeMetadataModelExportsToTargetFluentBuilder
pub fn describe_metadata_model_exports_to_target( &self, ) -> DescribeMetadataModelExportsToTargetFluentBuilder
Constructs a fluent builder for the DescribeMetadataModelExportsToTarget
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the metadata model exports described in the form of key-value pairs.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, DMS includes a pagination token in the response so that you can retrieve the remaining results.
- On success, responds with
DescribeMetadataModelExportsToTargetOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.requests(Option<Vec::<SchemaConversionRequest>>)
:A paginated list of metadata model exports.
- On failure, responds with
SdkError<DescribeMetadataModelExportsToTargetError>
Source§impl Client
impl Client
Sourcepub fn describe_metadata_model_imports(
&self,
) -> DescribeMetadataModelImportsFluentBuilder
pub fn describe_metadata_model_imports( &self, ) -> DescribeMetadataModelImportsFluentBuilder
Constructs a fluent builder for the DescribeMetadataModelImports
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the metadata model imports described in the form of key-value pairs.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseA paginated list of metadata model imports.
- On success, responds with
DescribeMetadataModelImportsOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.requests(Option<Vec::<SchemaConversionRequest>>)
:A paginated list of metadata model imports.
- On failure, responds with
SdkError<DescribeMetadataModelImportsError>
Source§impl Client
impl Client
Sourcepub fn describe_migration_projects(
&self,
) -> DescribeMigrationProjectsFluentBuilder
pub fn describe_migration_projects( &self, ) -> DescribeMigrationProjectsFluentBuilder
Constructs a fluent builder for the DescribeMigrationProjects
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the migration projects described in the form of key-value pairs.
Valid filter names and values:
-
instance-profile-identifier, instance profile arn or name
-
data-provider-identifier, data provider arn or name
-
migration-project-identifier, migration project arn or name
-
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, DMS includes a pagination token in the response so that you can retrieve the remaining results.marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
- On success, responds with
DescribeMigrationProjectsOutput
with field(s):marker(Option<String>)
:Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.If
Marker
is returned by a previous response, there are more results available. The value ofMarker
is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.migration_projects(Option<Vec::<MigrationProject>>)
:A description of migration projects.
- On failure, responds with
SdkError<DescribeMigrationProjectsError>
Source§impl Client
impl Client
Sourcepub fn describe_orderable_replication_instances(
&self,
) -> DescribeOrderableReplicationInstancesFluentBuilder
pub fn describe_orderable_replication_instances( &self, ) -> DescribeOrderableReplicationInstancesFluentBuilder
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>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_pending_maintenance_actions(
&self,
) -> DescribePendingMaintenanceActionsFluentBuilder
pub fn describe_pending_maintenance_actions( &self, ) -> DescribePendingMaintenanceActionsFluentBuilder
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>)
:
required: falseThe Amazon Resource Name (ARN) of the replication instance.
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falsemarker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseAn 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_recommendation_limitations(
&self,
) -> DescribeRecommendationLimitationsFluentBuilder
pub fn describe_recommendation_limitations( &self, ) -> DescribeRecommendationLimitationsFluentBuilder
Constructs a fluent builder for the DescribeRecommendationLimitations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the limitations described in the form of key-value pairs.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.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
DescribeRecommendationLimitationsOutput
with field(s):next_token(Option<String>)
:The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than the
MaxRecords
value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.limitations(Option<Vec::<Limitation>>)
:The list of limitations for recommendations of target Amazon Web Services engines.
- On failure, responds with
SdkError<DescribeRecommendationLimitationsError>
Source§impl Client
impl Client
Sourcepub fn describe_recommendations(&self) -> DescribeRecommendationsFluentBuilder
pub fn describe_recommendations(&self) -> DescribeRecommendationsFluentBuilder
Constructs a fluent builder for the DescribeRecommendations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the target engine recommendations described in the form of key-value pairs.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.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
DescribeRecommendationsOutput
with field(s):next_token(Option<String>)
:The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than the
MaxRecords
value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.recommendations(Option<Vec::<Recommendation>>)
:The list of recommendations of target engines that Fleet Advisor created for the source database.
- On failure, responds with
SdkError<DescribeRecommendationsError>
Source§impl Client
impl Client
Sourcepub fn describe_refresh_schemas_status(
&self,
) -> DescribeRefreshSchemasStatusFluentBuilder
pub fn describe_refresh_schemas_status( &self, ) -> DescribeRefreshSchemasStatusFluentBuilder
Constructs a fluent builder for the DescribeRefreshSchemasStatus
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_replication_configs(
&self,
) -> DescribeReplicationConfigsFluentBuilder
pub fn describe_replication_configs( &self, ) -> DescribeReplicationConfigsFluentBuilder
Constructs a fluent builder for the DescribeReplicationConfigs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the replication configs.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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
DescribeReplicationConfigsOutput
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_configs(Option<Vec::<ReplicationConfig>>)
:Returned configuration parameters that describe each provisioned DMS Serverless replication.
- On failure, responds with
SdkError<DescribeReplicationConfigsError>
Source§impl Client
impl Client
Sourcepub fn describe_replication_instance_task_logs(
&self,
) -> DescribeReplicationInstanceTaskLogsFluentBuilder
pub fn describe_replication_instance_task_logs( &self, ) -> DescribeReplicationInstanceTaskLogsFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the replication instance.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_replication_instances(
&self,
) -> DescribeReplicationInstancesFluentBuilder
pub fn describe_replication_instances( &self, ) -> DescribeReplicationInstancesFluentBuilder
Constructs a fluent builder for the DescribeReplicationInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters 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>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_replication_subnet_groups(
&self,
) -> DescribeReplicationSubnetGroupsFluentBuilder
pub fn describe_replication_subnet_groups( &self, ) -> DescribeReplicationSubnetGroupsFluentBuilder
Constructs a fluent builder for the DescribeReplicationSubnetGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_replication_table_statistics(
&self,
) -> DescribeReplicationTableStatisticsFluentBuilder
pub fn describe_replication_table_statistics( &self, ) -> DescribeReplicationTableStatisticsFluentBuilder
Constructs a fluent builder for the DescribeReplicationTableStatistics
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
replication_config_arn(impl Into<String>)
/set_replication_config_arn(Option<String>)
:
required: trueThe replication config to describe.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the replication table statistics.
- On success, responds with
DescribeReplicationTableStatisticsOutput
with field(s):replication_config_arn(Option<String>)
:The Amazon Resource Name of the replication config.
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_table_statistics(Option<Vec::<TableStatistics>>)
:Returns table statistics on the replication, including table name, rows inserted, rows updated, and rows deleted.
- On failure, responds with
SdkError<DescribeReplicationTableStatisticsError>
Source§impl Client
impl Client
Sourcepub fn describe_replication_task_assessment_results(
&self,
) -> DescribeReplicationTaskAssessmentResultsFluentBuilder
pub fn describe_replication_task_assessment_results( &self, ) -> DescribeReplicationTaskAssessmentResultsFluentBuilder
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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_replication_task_assessment_runs(
&self,
) -> DescribeReplicationTaskAssessmentRunsFluentBuilder
pub fn describe_replication_task_assessment_runs( &self, ) -> DescribeReplicationTaskAssessmentRunsFluentBuilder
Constructs a fluent builder for the DescribeReplicationTaskAssessmentRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters 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>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_replication_task_individual_assessments(
&self,
) -> DescribeReplicationTaskIndividualAssessmentsFluentBuilder
pub fn describe_replication_task_individual_assessments( &self, ) -> DescribeReplicationTaskIndividualAssessmentsFluentBuilder
Constructs a fluent builder for the DescribeReplicationTaskIndividualAssessments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters 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>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_replication_tasks(
&self,
) -> DescribeReplicationTasksFluentBuilder
pub fn describe_replication_tasks( &self, ) -> DescribeReplicationTasksFluentBuilder
Constructs a fluent builder for the DescribeReplicationTasks
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters 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>)
:
required: falseThe 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>)
:
required: falseAn 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_replications(&self) -> DescribeReplicationsFluentBuilder
pub fn describe_replications(&self) -> DescribeReplicationsFluentBuilder
Constructs a fluent builder for the DescribeReplications
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters applied to the replications.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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
DescribeReplicationsOutput
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
.replications(Option<Vec::<Replication>>)
:The replication descriptions.
- On failure, responds with
SdkError<DescribeReplicationsError>
Source§impl Client
impl Client
Sourcepub fn describe_schemas(&self) -> DescribeSchemasFluentBuilder
pub fn describe_schemas(&self) -> DescribeSchemasFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn describe_table_statistics(&self) -> DescribeTableStatisticsFluentBuilder
pub fn describe_table_statistics(&self) -> DescribeTableStatisticsFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the replication task.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe 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>)
:
required: falseAn 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(Filter)
/set_filters(Option<Vec::<Filter>>)
:
required: falseFilters 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>
Source§impl Client
impl Client
Sourcepub fn export_metadata_model_assessment(
&self,
) -> ExportMetadataModelAssessmentFluentBuilder
pub fn export_metadata_model_assessment( &self, ) -> ExportMetadataModelAssessmentFluentBuilder
Constructs a fluent builder for the ExportMetadataModelAssessment
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
selection_rules(impl Into<String>)
/set_selection_rules(Option<String>)
:
required: trueA value that specifies the database objects to assess.
file_name(impl Into<String>)
/set_file_name(Option<String>)
:
required: falseThe name of the assessment file to create in your Amazon S3 bucket.
assessment_report_types(AssessmentReportType)
/set_assessment_report_types(Option<Vec::<AssessmentReportType>>)
:
required: falseThe file format of the assessment file.
- On success, responds with
ExportMetadataModelAssessmentOutput
with field(s):pdf_report(Option<ExportMetadataModelAssessmentResultEntry>)
:The Amazon S3 details for an assessment exported in PDF format.
csv_report(Option<ExportMetadataModelAssessmentResultEntry>)
:The Amazon S3 details for an assessment exported in CSV format.
- On failure, responds with
SdkError<ExportMetadataModelAssessmentError>
Source§impl Client
impl Client
Sourcepub fn import_certificate(&self) -> ImportCertificateFluentBuilder
pub fn import_certificate(&self) -> ImportCertificateFluentBuilder
Constructs a fluent builder for the ImportCertificate
operation.
- The fluent builder is configurable:
certificate_identifier(impl Into<String>)
/set_certificate_identifier(Option<String>)
:
required: trueA 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>)
:
required: falseThe contents of a
.pem
file, which contains an X.509 certificate.certificate_wallet(Blob)
/set_certificate_wallet(Option<Blob>)
:
required: falseThe 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseThe 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>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: falseThe 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(impl Into<String>)
/set_resource_arn_list(Option<Vec::<String>>)
:
required: falseList 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>
Source§impl Client
impl Client
Sourcepub fn modify_conversion_configuration(
&self,
) -> ModifyConversionConfigurationFluentBuilder
pub fn modify_conversion_configuration( &self, ) -> ModifyConversionConfigurationFluentBuilder
Constructs a fluent builder for the ModifyConversionConfiguration
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
conversion_configuration(impl Into<String>)
/set_conversion_configuration(Option<String>)
:
required: trueThe new conversion configuration.
- On success, responds with
ModifyConversionConfigurationOutput
with field(s):migration_project_identifier(Option<String>)
:The name or Amazon Resource Name (ARN) of the modified configuration.
- On failure, responds with
SdkError<ModifyConversionConfigurationError>
Source§impl Client
impl Client
Sourcepub fn modify_data_migration(&self) -> ModifyDataMigrationFluentBuilder
pub fn modify_data_migration(&self) -> ModifyDataMigrationFluentBuilder
Constructs a fluent builder for the ModifyDataMigration
operation.
- The fluent builder is configurable:
data_migration_identifier(impl Into<String>)
/set_data_migration_identifier(Option<String>)
:
required: trueThe identifier (name or ARN) of the data migration to modify.
data_migration_name(impl Into<String>)
/set_data_migration_name(Option<String>)
:
required: falseThe new name for the data migration.
enable_cloudwatch_logs(bool)
/set_enable_cloudwatch_logs(Option<bool>)
:
required: falseWhether to enable Cloudwatch logs for the data migration.
service_access_role_arn(impl Into<String>)
/set_service_access_role_arn(Option<String>)
:
required: falseThe new service access role ARN for the data migration.
data_migration_type(MigrationTypeValue)
/set_data_migration_type(Option<MigrationTypeValue>)
:
required: falseThe new migration type for the data migration.
source_data_settings(SourceDataSetting)
/set_source_data_settings(Option<Vec::<SourceDataSetting>>)
:
required: falseThe new information about the source data provider for the data migration.
number_of_jobs(i32)
/set_number_of_jobs(Option<i32>)
:
required: falseThe number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
selection_rules(impl Into<String>)
/set_selection_rules(Option<String>)
:
required: falseA JSON-formatted string that defines what objects to include and exclude from the migration.
- On success, responds with
ModifyDataMigrationOutput
with field(s):data_migration(Option<DataMigration>)
:Information about the modified data migration.
- On failure, responds with
SdkError<ModifyDataMigrationError>
Source§impl Client
impl Client
Sourcepub fn modify_data_provider(&self) -> ModifyDataProviderFluentBuilder
pub fn modify_data_provider(&self) -> ModifyDataProviderFluentBuilder
Constructs a fluent builder for the ModifyDataProvider
operation.
- The fluent builder is configurable:
data_provider_identifier(impl Into<String>)
/set_data_provider_identifier(Option<String>)
:
required: trueThe identifier of the data provider. 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.
data_provider_name(impl Into<String>)
/set_data_provider_name(Option<String>)
:
required: falseThe name of the data provider.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA user-friendly description of the data provider.
engine(impl Into<String>)
/set_engine(Option<String>)
:
required: falseThe type of database engine for the data provider. Valid values include
“aurora”
,“aurora-postgresql”
,“mysql”
,“oracle”
,“postgres”
,“sqlserver”
,redshift
,mariadb
,mongodb
, anddocdb
. A value of“aurora”
represents Amazon Aurora MySQL-Compatible Edition.exact_settings(bool)
/set_exact_settings(Option<bool>)
:
required: falseIf this attribute is Y, the current call to
ModifyDataProvider
replaces all existing data provider settings with the exact settings that you specify in this call. If this attribute is N, the current call toModifyDataProvider
does two things:-
It replaces any data provider settings that already exist with new values, for settings with the same names.
-
It creates new data provider settings that you specify in the call, for settings with different names.
-
settings(DataProviderSettings)
/set_settings(Option<DataProviderSettings>)
:
required: falseThe settings in JSON format for a data provider.
- On success, responds with
ModifyDataProviderOutput
with field(s):data_provider(Option<DataProvider>)
:The data provider that was modified.
- On failure, responds with
SdkError<ModifyDataProviderError>
Source§impl Client
impl Client
Sourcepub fn modify_endpoint(&self) -> ModifyEndpointFluentBuilder
pub fn modify_endpoint(&self) -> ModifyEndpointFluentBuilder
Constructs a fluent builder for the ModifyEndpoint
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
endpoint_identifier(impl Into<String>)
/set_endpoint_identifier(Option<String>)
:
required: falseThe 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>)
:
required: falseThe type of endpoint. Valid values are
source
andtarget
.engine_name(impl Into<String>)
/set_engine_name(Option<String>)
:
required: falseThe 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>)
:
required: falseThe user name to be used to login to the endpoint database.
password(impl Into<String>)
/set_password(Option<String>)
:
required: falseThe password to be used to login to the endpoint database.
server_name(impl Into<String>)
/set_server_name(Option<String>)
:
required: falseThe name of the server where the endpoint database resides.
port(i32)
/set_port(Option<i32>)
:
required: falseThe port used by the endpoint database.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: falseThe 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>)
:
required: falseAdditional 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>)
:
required: falseThe Amazon Resource Name (ARN) of the certificate used for SSL connection.
ssl_mode(DmsSslModeValue)
/set_ssl_mode(Option<DmsSslModeValue>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe external table definition.
dynamo_db_settings(DynamoDbSettings)
/set_dynamo_db_settings(Option<DynamoDbSettings>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseThe 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseProvides information that defines an Amazon Redshift endpoint.
postgre_sql_settings(PostgreSqlSettings)
/set_postgre_sql_settings(Option<PostgreSqlSettings>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings 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>)
:
required: falseSettings in JSON format for the Redis target endpoint.
exact_settings(bool)
/set_exact_settings(Option<bool>)
:
required: falseIf 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>)
:
required: falseSettings in JSON format for the source GCP MySQL endpoint.
timestream_settings(TimestreamSettings)
/set_timestream_settings(Option<TimestreamSettings>)
:
required: falseSettings in JSON format for the target Amazon Timestream endpoint.
- On success, responds with
ModifyEndpointOutput
with field(s):endpoint(Option<Endpoint>)
:The modified endpoint.
- On failure, responds with
SdkError<ModifyEndpointError>
Source§impl Client
impl Client
Sourcepub fn modify_event_subscription(&self) -> ModifyEventSubscriptionFluentBuilder
pub fn modify_event_subscription(&self) -> ModifyEventSubscriptionFluentBuilder
Constructs a fluent builder for the ModifyEventSubscription
operation.
- The fluent builder is configurable:
subscription_name(impl Into<String>)
/set_subscription_name(Option<String>)
:
required: trueThe name of the DMS event notification subscription to be modified.
sns_topic_arn(impl Into<String>)
/set_sns_topic_arn(Option<String>)
:
required: falseThe 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>)
:
required: falseThe type of DMS resource that generates the events you want to subscribe to.
Valid values: replication-instance | replication-task
event_categories(impl Into<String>)
/set_event_categories(Option<Vec::<String>>)
:
required: falseA 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>)
:
required: falseA 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>
Source§impl Client
impl Client
Sourcepub fn modify_instance_profile(&self) -> ModifyInstanceProfileFluentBuilder
pub fn modify_instance_profile(&self) -> ModifyInstanceProfileFluentBuilder
Constructs a fluent builder for the ModifyInstanceProfile
operation.
- The fluent builder is configurable:
instance_profile_identifier(impl Into<String>)
/set_instance_profile_identifier(Option<String>)
:
required: trueThe identifier of the instance profile. 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.
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:
required: falseThe Availability Zone where the instance profile runs.
kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the KMS key that is used to encrypt the connection parameters for the instance profile.
If you don’t specify a value for the
KmsKeyArn
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>)
:
required: falseSpecifies the accessibility options for the instance profile. A value of
true
represents an instance profile with a public IP address. A value offalse
represents an instance profile with a private IP address. The default value istrue
.network_type(impl Into<String>)
/set_network_type(Option<String>)
:
required: falseSpecifies the network type for the instance profile. A value of
IPV4
represents an instance profile with IPv4 network type and only supports IPv4 addressing. A value ofIPV6
represents an instance profile with IPv6 network type and only supports IPv6 addressing. A value ofDUAL
represents an instance profile with dual network type that supports IPv4 and IPv6 addressing.instance_profile_name(impl Into<String>)
/set_instance_profile_name(Option<String>)
:
required: falseA user-friendly name for the instance profile.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA user-friendly description for the instance profile.
subnet_group_identifier(impl Into<String>)
/set_subnet_group_identifier(Option<String>)
:
required: falseA subnet group to associate with the instance profile.
vpc_security_groups(impl Into<String>)
/set_vpc_security_groups(Option<Vec::<String>>)
:
required: falseSpecifies the VPC security groups to be used with the instance profile. The VPC security group must work with the VPC containing the instance profile.
- On success, responds with
ModifyInstanceProfileOutput
with field(s):instance_profile(Option<InstanceProfile>)
:The instance profile that was modified.
- On failure, responds with
SdkError<ModifyInstanceProfileError>
Source§impl Client
impl Client
Sourcepub fn modify_migration_project(&self) -> ModifyMigrationProjectFluentBuilder
pub fn modify_migration_project(&self) -> ModifyMigrationProjectFluentBuilder
Constructs a fluent builder for the ModifyMigrationProject
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe identifier of the migration project. 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.
migration_project_name(impl Into<String>)
/set_migration_project_name(Option<String>)
:
required: falseA user-friendly name for the migration project.
source_data_provider_descriptors(DataProviderDescriptorDefinition)
/set_source_data_provider_descriptors(Option<Vec::<DataProviderDescriptorDefinition>>)
:
required: falseInformation about the source data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
target_data_provider_descriptors(DataProviderDescriptorDefinition)
/set_target_data_provider_descriptors(Option<Vec::<DataProviderDescriptorDefinition>>)
:
required: falseInformation about the target data provider, including the name, ARN, and Amazon Web Services Secrets Manager parameters.
instance_profile_identifier(impl Into<String>)
/set_instance_profile_identifier(Option<String>)
:
required: falseThe name or Amazon Resource Name (ARN) for the instance profile.
transformation_rules(impl Into<String>)
/set_transformation_rules(Option<String>)
:
required: falseThe settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA user-friendly description of the migration project.
schema_conversion_application_attributes(ScApplicationAttributes)
/set_schema_conversion_application_attributes(Option<ScApplicationAttributes>)
:
required: falseThe schema conversion application attributes, including the Amazon S3 bucket name and Amazon S3 role ARN.
- On success, responds with
ModifyMigrationProjectOutput
with field(s):migration_project(Option<MigrationProject>)
:The migration project that was modified.
- On failure, responds with
SdkError<ModifyMigrationProjectError>
Source§impl Client
impl Client
Sourcepub fn modify_replication_config(&self) -> ModifyReplicationConfigFluentBuilder
pub fn modify_replication_config(&self) -> ModifyReplicationConfigFluentBuilder
Constructs a fluent builder for the ModifyReplicationConfig
operation.
- The fluent builder is configurable:
replication_config_arn(impl Into<String>)
/set_replication_config_arn(Option<String>)
:
required: trueThe Amazon Resource Name of the replication to modify.
replication_config_identifier(impl Into<String>)
/set_replication_config_identifier(Option<String>)
:
required: falseThe new replication config to apply to the replication.
replication_type(MigrationTypeValue)
/set_replication_type(Option<MigrationTypeValue>)
:
required: falseThe type of replication.
table_mappings(impl Into<String>)
/set_table_mappings(Option<String>)
:
required: falseTable mappings specified in the replication.
replication_settings(impl Into<String>)
/set_replication_settings(Option<String>)
:
required: falseThe settings for the replication.
supplemental_settings(impl Into<String>)
/set_supplemental_settings(Option<String>)
:
required: falseAdditional settings for the replication.
compute_config(ComputeConfig)
/set_compute_config(Option<ComputeConfig>)
:
required: falseConfiguration parameters for provisioning an DMS Serverless replication.
source_endpoint_arn(impl Into<String>)
/set_source_endpoint_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the source endpoint for this DMS serverless replication configuration.
target_endpoint_arn(impl Into<String>)
/set_target_endpoint_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.
- On success, responds with
ModifyReplicationConfigOutput
with field(s):replication_config(Option<ReplicationConfig>)
:Information about the serverless replication config that was modified.
- On failure, responds with
SdkError<ModifyReplicationConfigError>
Source§impl Client
impl Client
Sourcepub fn modify_replication_instance(
&self,
) -> ModifyReplicationInstanceFluentBuilder
pub fn modify_replication_instance( &self, ) -> ModifyReplicationInstanceFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the replication instance.
allocated_storage(i32)
/set_allocated_storage(Option<i32>)
:
required: falseThe amount of storage (in gigabytes) to be allocated for the replication instance.
apply_immediately(bool)
/set_apply_immediately(Option<bool>)
:
required: falseIndicates 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>)
:
required: falseThe 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(impl Into<String>)
/set_vpc_security_group_ids(Option<Vec::<String>>)
:
required: falseSpecifies 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>)
:
required: falseThe 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>)
:
required: falseSpecifies 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>)
:
required: falseThe 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(Option<bool>)
:
required: falseIndicates 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>)
:
required: falseA 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>)
:
required: falseThe replication instance identifier. This parameter is stored as a lowercase string.
network_type(impl Into<String>)
/set_network_type(Option<String>)
:
required: falseThe 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.
kerberos_authentication_settings(KerberosAuthenticationSettings)
/set_kerberos_authentication_settings(Option<KerberosAuthenticationSettings>)
:
required: falseSpecifies the ID of the secret that stores the key cache file required for kerberos authentication, when modifying a replication instance.
- On success, responds with
ModifyReplicationInstanceOutput
with field(s):replication_instance(Option<ReplicationInstance>)
:The modified replication instance.
- On failure, responds with
SdkError<ModifyReplicationInstanceError>
Source§impl Client
impl Client
Sourcepub fn modify_replication_subnet_group(
&self,
) -> ModifyReplicationSubnetGroupFluentBuilder
pub fn modify_replication_subnet_group( &self, ) -> ModifyReplicationSubnetGroupFluentBuilder
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>)
:
required: trueThe name of the replication instance subnet group.
replication_subnet_group_description(impl Into<String>)
/set_replication_subnet_group_description(Option<String>)
:
required: falseA description for the replication instance subnet group.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: trueA 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>
Source§impl Client
impl Client
Sourcepub fn modify_replication_task(&self) -> ModifyReplicationTaskFluentBuilder
pub fn modify_replication_task(&self) -> ModifyReplicationTaskFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the replication task.
replication_task_identifier(impl Into<String>)
/set_replication_task_identifier(Option<String>)
:
required: falseThe 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>)
:
required: falseThe migration type. Valid values:
full-load
|cdc
|full-load-and-cdc
table_mappings(impl Into<String>)
/set_table_mappings(Option<String>)
:
required: falseWhen 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>)
:
required: falseJSON file that contains settings for the task, such as task metadata settings.
cdc_start_time(DateTime)
/set_cdc_start_time(Option<DateTime>)
:
required: falseIndicates 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>)
:
required: falseIndicates 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>)
:
required: falseIndicates 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>)
:
required: falseSupplemental 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>
Source§impl Client
impl Client
Sourcepub fn move_replication_task(&self) -> MoveReplicationTaskFluentBuilder
pub fn move_replication_task(&self) -> MoveReplicationTaskFluentBuilder
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>)
:
required: trueThe 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>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn reboot_replication_instance(
&self,
) -> RebootReplicationInstanceFluentBuilder
pub fn reboot_replication_instance( &self, ) -> RebootReplicationInstanceFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the replication instance.
force_failover(bool)
/set_force_failover(Option<bool>)
:
required: falseIf 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>)
:
required: falseIf 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>
Source§impl Client
impl Client
Sourcepub fn refresh_schemas(&self) -> RefreshSchemasFluentBuilder
pub fn refresh_schemas(&self) -> RefreshSchemasFluentBuilder
Constructs a fluent builder for the RefreshSchemas
operation.
- The fluent builder is configurable:
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
replication_instance_arn(impl Into<String>)
/set_replication_instance_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn reload_replication_tables(&self) -> ReloadReplicationTablesFluentBuilder
pub fn reload_replication_tables(&self) -> ReloadReplicationTablesFluentBuilder
Constructs a fluent builder for the ReloadReplicationTables
operation.
- The fluent builder is configurable:
replication_config_arn(impl Into<String>)
/set_replication_config_arn(Option<String>)
:
required: trueThe Amazon Resource Name of the replication config for which to reload tables.
tables_to_reload(TableToReload)
/set_tables_to_reload(Option<Vec::<TableToReload>>)
:
required: trueThe list of tables to reload.
reload_option(ReloadOptionValue)
/set_reload_option(Option<ReloadOptionValue>)
:
required: falseOptions 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 replication.
- On success, responds with
ReloadReplicationTablesOutput
with field(s):replication_config_arn(Option<String>)
:The Amazon Resource Name of the replication config for which to reload tables.
- On failure, responds with
SdkError<ReloadReplicationTablesError>
Source§impl Client
impl Client
Sourcepub fn reload_tables(&self) -> ReloadTablesFluentBuilder
pub fn reload_tables(&self) -> ReloadTablesFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the replication task.
tables_to_reload(TableToReload)
/set_tables_to_reload(Option<Vec::<TableToReload>>)
:
required: trueThe name and schema of the table to be reloaded.
reload_option(ReloadOptionValue)
/set_reload_option(Option<ReloadOptionValue>)
:
required: falseOptions 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>
Source§impl Client
impl Client
Constructs a fluent builder for the RemoveTagsFromResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueAn DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag key (name) of the tag to be removed.
- On success, responds with
RemoveTagsFromResourceOutput
- On failure, responds with
SdkError<RemoveTagsFromResourceError>
Source§impl Client
impl Client
Sourcepub fn run_fleet_advisor_lsa_analysis(
&self,
) -> RunFleetAdvisorLsaAnalysisFluentBuilder
pub fn run_fleet_advisor_lsa_analysis( &self, ) -> RunFleetAdvisorLsaAnalysisFluentBuilder
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>
Source§impl Client
impl Client
Sourcepub fn start_data_migration(&self) -> StartDataMigrationFluentBuilder
pub fn start_data_migration(&self) -> StartDataMigrationFluentBuilder
Constructs a fluent builder for the StartDataMigration
operation.
- The fluent builder is configurable:
data_migration_identifier(impl Into<String>)
/set_data_migration_identifier(Option<String>)
:
required: trueThe identifier (name or ARN) of the data migration to start.
start_type(StartReplicationMigrationTypeValue)
/set_start_type(Option<StartReplicationMigrationTypeValue>)
:
required: trueSpecifies the start type for the data migration. Valid values include
start-replication
,reload-target
, andresume-processing
.
- On success, responds with
StartDataMigrationOutput
with field(s):data_migration(Option<DataMigration>)
:The data migration that DMS started.
- On failure, responds with
SdkError<StartDataMigrationError>
Source§impl Client
impl Client
Sourcepub fn start_extension_pack_association(
&self,
) -> StartExtensionPackAssociationFluentBuilder
pub fn start_extension_pack_association( &self, ) -> StartExtensionPackAssociationFluentBuilder
Constructs a fluent builder for the StartExtensionPackAssociation
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
- On success, responds with
StartExtensionPackAssociationOutput
with field(s):request_identifier(Option<String>)
:The identifier for the request operation.
- On failure, responds with
SdkError<StartExtensionPackAssociationError>
Source§impl Client
impl Client
Sourcepub fn start_metadata_model_assessment(
&self,
) -> StartMetadataModelAssessmentFluentBuilder
pub fn start_metadata_model_assessment( &self, ) -> StartMetadataModelAssessmentFluentBuilder
Constructs a fluent builder for the StartMetadataModelAssessment
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
selection_rules(impl Into<String>)
/set_selection_rules(Option<String>)
:
required: trueA value that specifies the database objects to assess.
- On success, responds with
StartMetadataModelAssessmentOutput
with field(s):request_identifier(Option<String>)
:The identifier for the assessment operation.
- On failure, responds with
SdkError<StartMetadataModelAssessmentError>
Source§impl Client
impl Client
Sourcepub fn start_metadata_model_conversion(
&self,
) -> StartMetadataModelConversionFluentBuilder
pub fn start_metadata_model_conversion( &self, ) -> StartMetadataModelConversionFluentBuilder
Constructs a fluent builder for the StartMetadataModelConversion
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
selection_rules(impl Into<String>)
/set_selection_rules(Option<String>)
:
required: trueA value that specifies the database objects to convert.
- On success, responds with
StartMetadataModelConversionOutput
with field(s):request_identifier(Option<String>)
:The identifier for the conversion operation.
- On failure, responds with
SdkError<StartMetadataModelConversionError>
Source§impl Client
impl Client
Sourcepub fn start_metadata_model_export_as_script(
&self,
) -> StartMetadataModelExportAsScriptFluentBuilder
pub fn start_metadata_model_export_as_script( &self, ) -> StartMetadataModelExportAsScriptFluentBuilder
Constructs a fluent builder for the StartMetadataModelExportAsScript
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
selection_rules(impl Into<String>)
/set_selection_rules(Option<String>)
:
required: trueA value that specifies the database objects to export.
origin(OriginTypeValue)
/set_origin(Option<OriginTypeValue>)
:
required: trueWhether to export the metadata model from the source or the target.
file_name(impl Into<String>)
/set_file_name(Option<String>)
:
required: falseThe name of the model file to create in the Amazon S3 bucket.
- On success, responds with
StartMetadataModelExportAsScriptOutput
with field(s):request_identifier(Option<String>)
:The identifier for the export operation.
- On failure, responds with
SdkError<StartMetadataModelExportAsScriptError>
Source§impl Client
impl Client
Sourcepub fn start_metadata_model_export_to_target(
&self,
) -> StartMetadataModelExportToTargetFluentBuilder
pub fn start_metadata_model_export_to_target( &self, ) -> StartMetadataModelExportToTargetFluentBuilder
Constructs a fluent builder for the StartMetadataModelExportToTarget
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
selection_rules(impl Into<String>)
/set_selection_rules(Option<String>)
:
required: trueA value that specifies the database objects to export.
overwrite_extension_pack(bool)
/set_overwrite_extension_pack(Option<bool>)
:
required: falseWhether to overwrite the migration project extension pack. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.
- On success, responds with
StartMetadataModelExportToTargetOutput
with field(s):request_identifier(Option<String>)
:The identifier for the export operation.
- On failure, responds with
SdkError<StartMetadataModelExportToTargetError>
Source§impl Client
impl Client
Sourcepub fn start_metadata_model_import(
&self,
) -> StartMetadataModelImportFluentBuilder
pub fn start_metadata_model_import( &self, ) -> StartMetadataModelImportFluentBuilder
Constructs a fluent builder for the StartMetadataModelImport
operation.
- The fluent builder is configurable:
migration_project_identifier(impl Into<String>)
/set_migration_project_identifier(Option<String>)
:
required: trueThe migration project name or Amazon Resource Name (ARN).
selection_rules(impl Into<String>)
/set_selection_rules(Option<String>)
:
required: trueA value that specifies the database objects to import.
origin(OriginTypeValue)
/set_origin(Option<OriginTypeValue>)
:
required: trueWhether to load metadata to the source or target database.
refresh(bool)
/set_refresh(Option<bool>)
:
required: falseIf
true
, DMS loads metadata for the specified objects from the source database.
- On success, responds with
StartMetadataModelImportOutput
with field(s):request_identifier(Option<String>)
:The identifier for the import operation.
- On failure, responds with
SdkError<StartMetadataModelImportError>
Source§impl Client
impl Client
Sourcepub fn start_recommendations(&self) -> StartRecommendationsFluentBuilder
pub fn start_recommendations(&self) -> StartRecommendationsFluentBuilder
Constructs a fluent builder for the StartRecommendations
operation.
- The fluent builder is configurable:
database_id(impl Into<String>)
/set_database_id(Option<String>)
:
required: trueThe identifier of the source database to analyze and provide recommendations for.
settings(RecommendationSettings)
/set_settings(Option<RecommendationSettings>)
:
required: trueThe settings in JSON format that Fleet Advisor uses to determine target engine recommendations. These parameters include target instance sizing and availability and durability settings. For target instance sizing, Fleet Advisor supports the following two options: total capacity and resource utilization. For availability and durability, Fleet Advisor supports the following two options: production (Multi-AZ deployments) and Dev/Test (Single-AZ deployments).
- On success, responds with
StartRecommendationsOutput
- On failure, responds with
SdkError<StartRecommendationsError>
Source§impl Client
impl Client
Sourcepub fn start_replication(&self) -> StartReplicationFluentBuilder
pub fn start_replication(&self) -> StartReplicationFluentBuilder
Constructs a fluent builder for the StartReplication
operation.
- The fluent builder is configurable:
replication_config_arn(impl Into<String>)
/set_replication_config_arn(Option<String>)
:
required: trueThe Amazon Resource Name of the replication for which to start replication.
start_replication_type(impl Into<String>)
/set_start_replication_type(Option<String>)
:
required: trueThe replication type.
When the replication type is
full-load
orfull-load-and-cdc
, the only valid value for the first run of the replication isstart-replication
. This option will start the replication.You can also use
ReloadTables
to reload specific tables that failed during replication instead of restarting the replication.The
resume-processing
option isn’t applicable for a full-load replication, because you can’t resume partially loaded tables during the full load phase.For a
full-load-and-cdc
replication, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, usereload-target
. Otherwise useresume-processing
, to replicate the changes from the last stop position.cdc_start_time(DateTime)
/set_cdc_start_time(Option<DateTime>)
:
required: falseIndicates the start time for a change data capture (CDC) operation. Use either
CdcStartTime
orCdcStartPosition
to specify when you want a CDC operation to start. Specifying both values results in an error.cdc_start_position(impl Into<String>)
/set_cdc_start_position(Option<String>)
:
required: falseIndicates when you want a change data capture (CDC) operation to start. Use either
CdcStartPosition
orCdcStartTime
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.
cdc_stop_position(impl Into<String>)
/set_cdc_stop_position(Option<String>)
:
required: falseIndicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.
- On success, responds with
StartReplicationOutput
with field(s):replication(Option<Replication>)
:The replication that DMS started.
- On failure, responds with
SdkError<StartReplicationError>
Source§impl Client
impl Client
Sourcepub fn start_replication_task(&self) -> StartReplicationTaskFluentBuilder
pub fn start_replication_task(&self) -> StartReplicationTaskFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the replication task to be started.
start_replication_task_type(StartReplicationTaskTypeValue)
/set_start_replication_task_type(Option<StartReplicationTaskTypeValue>)
:
required: trueThe 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
. This option will start the migration.You can also use
ReloadTables
to reload specific tables that failed during migration instead of restarting the task.The
resume-processing
option isn’t applicable for a full-load task, because you can’t resume partially loaded tables during the full load phase.For a
full-load-and-cdc
task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, usereload-target
. Otherwise useresume-processing
, to replicate the changes from the last stop position.cdc_start_time(DateTime)
/set_cdc_start_time(Option<DateTime>)
:
required: falseIndicates 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>)
:
required: falseIndicates 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>)
:
required: falseIndicates 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>
Source§impl Client
impl Client
Sourcepub fn start_replication_task_assessment(
&self,
) -> StartReplicationTaskAssessmentFluentBuilder
pub fn start_replication_task_assessment( &self, ) -> StartReplicationTaskAssessmentFluentBuilder
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>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn start_replication_task_assessment_run(
&self,
) -> StartReplicationTaskAssessmentRunFluentBuilder
pub fn start_replication_task_assessment_run( &self, ) -> StartReplicationTaskAssessmentRunFluentBuilder
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>)
:
required: trueAmazon 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>)
:
required: trueARN 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>)
:
required: trueAmazon 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>)
:
required: falseFolder 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>)
:
required: falseEncryption 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>)
:
required: falseARN 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>)
:
required: trueUnique name to identify the assessment run.
include_only(impl Into<String>)
/set_include_only(Option<Vec::<String>>)
:
required: falseSpace-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(impl Into<String>)
/set_exclude(Option<Vec::<String>>)
:
required: falseSpace-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.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tags to be assigned to the premigration assessment run that you want to start.
- 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>
Source§impl Client
impl Client
Sourcepub fn stop_data_migration(&self) -> StopDataMigrationFluentBuilder
pub fn stop_data_migration(&self) -> StopDataMigrationFluentBuilder
Constructs a fluent builder for the StopDataMigration
operation.
- The fluent builder is configurable:
data_migration_identifier(impl Into<String>)
/set_data_migration_identifier(Option<String>)
:
required: trueThe identifier (name or ARN) of the data migration to stop.
- On success, responds with
StopDataMigrationOutput
with field(s):data_migration(Option<DataMigration>)
:The data migration that DMS stopped.
- On failure, responds with
SdkError<StopDataMigrationError>
Source§impl Client
impl Client
Sourcepub fn stop_replication(&self) -> StopReplicationFluentBuilder
pub fn stop_replication(&self) -> StopReplicationFluentBuilder
Constructs a fluent builder for the StopReplication
operation.
- The fluent builder is configurable:
replication_config_arn(impl Into<String>)
/set_replication_config_arn(Option<String>)
:
required: trueThe Amazon Resource Name of the replication to stop.
- On success, responds with
StopReplicationOutput
with field(s):replication(Option<Replication>)
:The replication that DMS stopped.
- On failure, responds with
SdkError<StopReplicationError>
Source§impl Client
impl Client
Sourcepub fn stop_replication_task(&self) -> StopReplicationTaskFluentBuilder
pub fn stop_replication_task(&self) -> StopReplicationTaskFluentBuilder
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>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn test_connection(&self) -> TestConnectionFluentBuilder
pub fn test_connection(&self) -> TestConnectionFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the replication instance.
endpoint_arn(impl Into<String>)
/set_endpoint_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn update_subscriptions_to_event_bridge(
&self,
) -> UpdateSubscriptionsToEventBridgeFluentBuilder
pub fn update_subscriptions_to_event_bridge( &self, ) -> UpdateSubscriptionsToEventBridgeFluentBuilder
Constructs a fluent builder for the UpdateSubscriptionsToEventBridge
operation.
- The fluent builder is configurable:
force_move(bool)
/set_force_move(Option<bool>)
:
required: falseWhen 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.5 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 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 in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
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. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_test_connection_succeeds(
&self,
) -> TestConnectionSucceedsFluentBuilder
fn wait_until_test_connection_succeeds( &self, ) -> TestConnectionSucceedsFluentBuilder
Source§fn wait_until_endpoint_deleted(&self) -> EndpointDeletedFluentBuilder
fn wait_until_endpoint_deleted(&self) -> EndpointDeletedFluentBuilder
Source§fn wait_until_replication_instance_available(
&self,
) -> ReplicationInstanceAvailableFluentBuilder
fn wait_until_replication_instance_available( &self, ) -> ReplicationInstanceAvailableFluentBuilder
Source§fn wait_until_replication_instance_deleted(
&self,
) -> ReplicationInstanceDeletedFluentBuilder
fn wait_until_replication_instance_deleted( &self, ) -> ReplicationInstanceDeletedFluentBuilder
Source§fn wait_until_replication_task_deleted(
&self,
) -> ReplicationTaskDeletedFluentBuilder
fn wait_until_replication_task_deleted( &self, ) -> ReplicationTaskDeletedFluentBuilder
Source§fn wait_until_replication_task_ready(&self) -> ReplicationTaskReadyFluentBuilder
fn wait_until_replication_task_ready(&self) -> ReplicationTaskReadyFluentBuilder
Source§fn wait_until_replication_task_running(
&self,
) -> ReplicationTaskRunningFluentBuilder
fn wait_until_replication_task_running( &self, ) -> ReplicationTaskRunningFluentBuilder
Source§fn wait_until_replication_task_stopped(
&self,
) -> ReplicationTaskStoppedFluentBuilder
fn wait_until_replication_task_stopped( &self, ) -> ReplicationTaskStoppedFluentBuilder
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);