Class: Aws::DatabaseMigrationService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DatabaseMigrationService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb
Overview
An API client for DatabaseMigrationService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::DatabaseMigrationService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_tags_to_resource(params = {}) ⇒ Struct
Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet group, and migration task.
-
#apply_pending_maintenance_action(params = {}) ⇒ Types::ApplyPendingMaintenanceActionResponse
Applies a pending maintenance action to a resource (for example, to a replication instance).
-
#batch_start_recommendations(params = {}) ⇒ Types::BatchStartRecommendationsResponse
Starts the analysis of up to 20 source databases to recommend target engines for each source database.
-
#cancel_replication_task_assessment_run(params = {}) ⇒ Types::CancelReplicationTaskAssessmentRunResponse
Cancels a single premigration assessment run.
-
#create_data_migration(params = {}) ⇒ Types::CreateDataMigrationResponse
Creates a data migration using the provided settings.
-
#create_data_provider(params = {}) ⇒ Types::CreateDataProviderResponse
Creates a data provider using the provided settings.
-
#create_endpoint(params = {}) ⇒ Types::CreateEndpointResponse
Creates an endpoint using the provided settings.
-
#create_event_subscription(params = {}) ⇒ Types::CreateEventSubscriptionResponse
Creates an DMS event notification subscription.
-
#create_fleet_advisor_collector(params = {}) ⇒ Types::CreateFleetAdvisorCollectorResponse
Creates a Fleet Advisor collector using the specified parameters.
-
#create_instance_profile(params = {}) ⇒ Types::CreateInstanceProfileResponse
Creates the instance profile using the specified parameters.
-
#create_migration_project(params = {}) ⇒ Types::CreateMigrationProjectResponse
Creates the migration project using the specified parameters.
-
#create_replication_config(params = {}) ⇒ Types::CreateReplicationConfigResponse
Creates a configuration that you can later provide to configure and start an DMS Serverless replication.
-
#create_replication_instance(params = {}) ⇒ Types::CreateReplicationInstanceResponse
Creates the replication instance using the specified parameters.
-
#create_replication_subnet_group(params = {}) ⇒ Types::CreateReplicationSubnetGroupResponse
Creates a replication subnet group given a list of the subnet IDs in a VPC.
-
#create_replication_task(params = {}) ⇒ Types::CreateReplicationTaskResponse
Creates a replication task using the specified parameters.
-
#delete_certificate(params = {}) ⇒ Types::DeleteCertificateResponse
Deletes the specified certificate.
-
#delete_connection(params = {}) ⇒ Types::DeleteConnectionResponse
Deletes the connection between a replication instance and an endpoint.
-
#delete_data_migration(params = {}) ⇒ Types::DeleteDataMigrationResponse
Deletes the specified data migration.
-
#delete_data_provider(params = {}) ⇒ Types::DeleteDataProviderResponse
Deletes the specified data provider.
-
#delete_endpoint(params = {}) ⇒ Types::DeleteEndpointResponse
Deletes the specified endpoint.
-
#delete_event_subscription(params = {}) ⇒ Types::DeleteEventSubscriptionResponse
Deletes an DMS event subscription.
-
#delete_fleet_advisor_collector(params = {}) ⇒ Struct
Deletes the specified Fleet Advisor collector.
-
#delete_fleet_advisor_databases(params = {}) ⇒ Types::DeleteFleetAdvisorDatabasesResponse
Deletes the specified Fleet Advisor collector databases.
-
#delete_instance_profile(params = {}) ⇒ Types::DeleteInstanceProfileResponse
Deletes the specified instance profile.
-
#delete_migration_project(params = {}) ⇒ Types::DeleteMigrationProjectResponse
Deletes the specified migration project.
-
#delete_replication_config(params = {}) ⇒ Types::DeleteReplicationConfigResponse
Deletes an DMS Serverless replication configuration.
-
#delete_replication_instance(params = {}) ⇒ Types::DeleteReplicationInstanceResponse
Deletes the specified replication instance.
-
#delete_replication_subnet_group(params = {}) ⇒ Struct
Deletes a subnet group.
-
#delete_replication_task(params = {}) ⇒ Types::DeleteReplicationTaskResponse
Deletes the specified replication task.
-
#delete_replication_task_assessment_run(params = {}) ⇒ Types::DeleteReplicationTaskAssessmentRunResponse
Deletes the record of a single premigration assessment run.
-
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResponse
Lists all of the DMS attributes for a customer account.
-
#describe_applicable_individual_assessments(params = {}) ⇒ Types::DescribeApplicableIndividualAssessmentsResponse
Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.
-
#describe_certificates(params = {}) ⇒ Types::DescribeCertificatesResponse
Provides a description of the certificate.
-
#describe_connections(params = {}) ⇒ Types::DescribeConnectionsResponse
Describes the status of the connections that have been made between the replication instance and an endpoint.
-
#describe_conversion_configuration(params = {}) ⇒ Types::DescribeConversionConfigurationResponse
Returns configuration parameters for a schema conversion project.
-
#describe_data_migrations(params = {}) ⇒ Types::DescribeDataMigrationsResponse
Returns information about data migrations.
-
#describe_data_providers(params = {}) ⇒ Types::DescribeDataProvidersResponse
Returns a paginated list of data providers for your account in the current region.
-
#describe_endpoint_settings(params = {}) ⇒ Types::DescribeEndpointSettingsResponse
Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
-
#describe_endpoint_types(params = {}) ⇒ Types::DescribeEndpointTypesResponse
Returns information about the type of endpoints available.
-
#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse
Returns information about the endpoints for your account in the current region.
-
#describe_engine_versions(params = {}) ⇒ Types::DescribeEngineVersionsResponse
Returns information about the replication instance versions used in the project.
-
#describe_event_categories(params = {}) ⇒ Types::DescribeEventCategoriesResponse
Lists categories for all event source types, or, if specified, for a specified source type.
-
#describe_event_subscriptions(params = {}) ⇒ Types::DescribeEventSubscriptionsResponse
Lists all the event subscriptions for a customer account.
-
#describe_events(params = {}) ⇒ Types::DescribeEventsResponse
Lists events for a given source identifier and source type.
-
#describe_extension_pack_associations(params = {}) ⇒ Types::DescribeExtensionPackAssociationsResponse
Returns a paginated list of extension pack associations for the specified migration project.
-
#describe_fleet_advisor_collectors(params = {}) ⇒ Types::DescribeFleetAdvisorCollectorsResponse
Returns a list of the Fleet Advisor collectors in your account.
-
#describe_fleet_advisor_databases(params = {}) ⇒ Types::DescribeFleetAdvisorDatabasesResponse
Returns a list of Fleet Advisor databases in your account.
-
#describe_fleet_advisor_lsa_analysis(params = {}) ⇒ Types::DescribeFleetAdvisorLsaAnalysisResponse
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.
-
#describe_fleet_advisor_schema_object_summary(params = {}) ⇒ Types::DescribeFleetAdvisorSchemaObjectSummaryResponse
Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
-
#describe_fleet_advisor_schemas(params = {}) ⇒ Types::DescribeFleetAdvisorSchemasResponse
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
-
#describe_instance_profiles(params = {}) ⇒ Types::DescribeInstanceProfilesResponse
Returns a paginated list of instance profiles for your account in the current region.
-
#describe_metadata_model_assessments(params = {}) ⇒ Types::DescribeMetadataModelAssessmentsResponse
Returns a paginated list of metadata model assessments for your account in the current region.
-
#describe_metadata_model_conversions(params = {}) ⇒ Types::DescribeMetadataModelConversionsResponse
Returns a paginated list of metadata model conversions for a migration project.
-
#describe_metadata_model_exports_as_script(params = {}) ⇒ Types::DescribeMetadataModelExportsAsScriptResponse
Returns a paginated list of metadata model exports.
-
#describe_metadata_model_exports_to_target(params = {}) ⇒ Types::DescribeMetadataModelExportsToTargetResponse
Returns a paginated list of metadata model exports.
-
#describe_metadata_model_imports(params = {}) ⇒ Types::DescribeMetadataModelImportsResponse
Returns a paginated list of metadata model imports.
-
#describe_migration_projects(params = {}) ⇒ Types::DescribeMigrationProjectsResponse
Returns a paginated list of migration projects for your account in the current region.
-
#describe_orderable_replication_instances(params = {}) ⇒ Types::DescribeOrderableReplicationInstancesResponse
Returns information about the replication instance types that can be created in the specified region.
-
#describe_pending_maintenance_actions(params = {}) ⇒ Types::DescribePendingMaintenanceActionsResponse
For internal use only.
-
#describe_recommendation_limitations(params = {}) ⇒ Types::DescribeRecommendationLimitationsResponse
Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.
-
#describe_recommendations(params = {}) ⇒ Types::DescribeRecommendationsResponse
Returns a paginated list of target engine recommendations for your source databases.
-
#describe_refresh_schemas_status(params = {}) ⇒ Types::DescribeRefreshSchemasStatusResponse
Returns the status of the RefreshSchemas operation.
-
#describe_replication_configs(params = {}) ⇒ Types::DescribeReplicationConfigsResponse
Returns one or more existing DMS Serverless replication configurations as a list of structures.
-
#describe_replication_instance_task_logs(params = {}) ⇒ Types::DescribeReplicationInstanceTaskLogsResponse
Returns information about the task logs for the specified task.
-
#describe_replication_instances(params = {}) ⇒ Types::DescribeReplicationInstancesResponse
Returns information about replication instances for your account in the current region.
-
#describe_replication_subnet_groups(params = {}) ⇒ Types::DescribeReplicationSubnetGroupsResponse
Returns information about the replication subnet groups.
-
#describe_replication_table_statistics(params = {}) ⇒ Types::DescribeReplicationTableStatisticsResponse
Returns table and schema statistics for one or more provisioned replications that use a given DMS Serverless replication configuration.
-
#describe_replication_task_assessment_results(params = {}) ⇒ Types::DescribeReplicationTaskAssessmentResultsResponse
Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account.
-
#describe_replication_task_assessment_runs(params = {}) ⇒ Types::DescribeReplicationTaskAssessmentRunsResponse
Returns a paginated list of premigration assessment runs based on filter settings.
-
#describe_replication_task_individual_assessments(params = {}) ⇒ Types::DescribeReplicationTaskIndividualAssessmentsResponse
Returns a paginated list of individual assessments based on filter settings.
-
#describe_replication_tasks(params = {}) ⇒ Types::DescribeReplicationTasksResponse
Returns information about replication tasks for your account in the current region.
-
#describe_replications(params = {}) ⇒ Types::DescribeReplicationsResponse
Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
-
#describe_schemas(params = {}) ⇒ Types::DescribeSchemasResponse
Returns information about the schema for the specified endpoint.
-
#describe_table_statistics(params = {}) ⇒ Types::DescribeTableStatisticsResponse
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
-
#export_metadata_model_assessment(params = {}) ⇒ Types::ExportMetadataModelAssessmentResponse
Saves a copy of a database migration assessment report to your Amazon S3 bucket.
-
#import_certificate(params = {}) ⇒ Types::ImportCertificateResponse
Uploads the specified certificate.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task.
-
#modify_conversion_configuration(params = {}) ⇒ Types::ModifyConversionConfigurationResponse
Modifies the specified schema conversion configuration using the provided parameters.
-
#modify_data_migration(params = {}) ⇒ Types::ModifyDataMigrationResponse
Modifies an existing DMS data migration.
-
#modify_data_provider(params = {}) ⇒ Types::ModifyDataProviderResponse
Modifies the specified data provider using the provided settings.
-
#modify_endpoint(params = {}) ⇒ Types::ModifyEndpointResponse
Modifies the specified endpoint.
-
#modify_event_subscription(params = {}) ⇒ Types::ModifyEventSubscriptionResponse
Modifies an existing DMS event notification subscription.
-
#modify_instance_profile(params = {}) ⇒ Types::ModifyInstanceProfileResponse
Modifies the specified instance profile using the provided parameters.
-
#modify_migration_project(params = {}) ⇒ Types::ModifyMigrationProjectResponse
Modifies the specified migration project using the provided parameters.
-
#modify_replication_config(params = {}) ⇒ Types::ModifyReplicationConfigResponse
Modifies an existing DMS Serverless replication configuration that you can use to start a replication.
-
#modify_replication_instance(params = {}) ⇒ Types::ModifyReplicationInstanceResponse
Modifies the replication instance to apply new settings.
-
#modify_replication_subnet_group(params = {}) ⇒ Types::ModifyReplicationSubnetGroupResponse
Modifies the settings for the specified replication subnet group.
-
#modify_replication_task(params = {}) ⇒ Types::ModifyReplicationTaskResponse
Modifies the specified replication task.
-
#move_replication_task(params = {}) ⇒ Types::MoveReplicationTaskResponse
Moves a replication task from its current replication instance to a different target replication instance using the specified parameters.
-
#reboot_replication_instance(params = {}) ⇒ Types::RebootReplicationInstanceResponse
Reboots a replication instance.
-
#refresh_schemas(params = {}) ⇒ Types::RefreshSchemasResponse
Populates the schema for the specified endpoint.
-
#reload_replication_tables(params = {}) ⇒ Types::ReloadReplicationTablesResponse
Reloads the target database table with the source data for a given DMS Serverless replication configuration.
-
#reload_tables(params = {}) ⇒ Types::ReloadTablesResponse
Reloads the target database table with the source data.
-
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration task.
-
#run_fleet_advisor_lsa_analysis(params = {}) ⇒ Types::RunFleetAdvisorLsaAnalysisResponse
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
-
#start_data_migration(params = {}) ⇒ Types::StartDataMigrationResponse
Starts the specified data migration.
-
#start_extension_pack_association(params = {}) ⇒ Types::StartExtensionPackAssociationResponse
Applies the extension pack to your target database.
-
#start_metadata_model_assessment(params = {}) ⇒ Types::StartMetadataModelAssessmentResponse
Creates a database migration assessment report by assessing the migration complexity for your source database.
-
#start_metadata_model_conversion(params = {}) ⇒ Types::StartMetadataModelConversionResponse
Converts your source database objects to a format compatible with the target database.
-
#start_metadata_model_export_as_script(params = {}) ⇒ Types::StartMetadataModelExportAsScriptResponse
Saves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.
-
#start_metadata_model_export_to_target(params = {}) ⇒ Types::StartMetadataModelExportToTargetResponse
Applies converted database objects to your target database.
-
#start_metadata_model_import(params = {}) ⇒ Types::StartMetadataModelImportResponse
Loads the metadata for all the dependent database objects of the parent object.
-
#start_recommendations(params = {}) ⇒ Struct
Starts the analysis of your source database to provide recommendations of target engines.
-
#start_replication(params = {}) ⇒ Types::StartReplicationResponse
For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload.
-
#start_replication_task(params = {}) ⇒ Types::StartReplicationTaskResponse
Starts the replication task.
-
#start_replication_task_assessment(params = {}) ⇒ Types::StartReplicationTaskAssessmentResponse
Starts the replication task assessment for unsupported data types in the source database.
-
#start_replication_task_assessment_run(params = {}) ⇒ Types::StartReplicationTaskAssessmentRunResponse
Starts a new premigration assessment run for one or more individual assessments of a migration task.
-
#stop_data_migration(params = {}) ⇒ Types::StopDataMigrationResponse
Stops the specified data migration.
-
#stop_replication(params = {}) ⇒ Types::StopReplicationResponse
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications.
-
#stop_replication_task(params = {}) ⇒ Types::StopReplicationTaskResponse
Stops the replication task.
-
#test_connection(params = {}) ⇒ Types::TestConnectionResponse
Tests the connection between the replication instance and the endpoint.
-
#update_subscriptions_to_event_bridge(params = {}) ⇒ Types::UpdateSubscriptionsToEventBridgeResponse
Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
451 452 453 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 451 def initialize(*args) super end |
Instance Method Details
#add_tags_to_resource(params = {}) ⇒ Struct
Adds metadata tags to an DMS resource, including replication instance,
endpoint, subnet group, and migration task. These tags can also be
used with cost allocation reporting to track cost associated with DMS
resources, or used in a Condition statement in an IAM policy for DMS.
For more information, see Tag
data type description.
517 518 519 520 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 517 def (params = {}, = {}) req = build_request(:add_tags_to_resource, params) req.send_request() end |
#apply_pending_maintenance_action(params = {}) ⇒ Types::ApplyPendingMaintenanceActionResponse
Applies a pending maintenance action to a resource (for example, to a replication instance).
575 576 577 578 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 575 def apply_pending_maintenance_action(params = {}, = {}) req = build_request(:apply_pending_maintenance_action, params) req.send_request() end |
#batch_start_recommendations(params = {}) ⇒ Types::BatchStartRecommendationsResponse
Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of StartRecommendations.
The result of analysis of each source database is reported
individually in the response. Because the batch request can result in
a combination of successful and unsuccessful actions, you should check
for batch errors even when the call returns an HTTP status code of
200
.
628 629 630 631 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 628 def batch_start_recommendations(params = {}, = {}) req = build_request(:batch_start_recommendations, params) req.send_request() end |
#cancel_replication_task_assessment_run(params = {}) ⇒ Types::CancelReplicationTaskAssessmentRunResponse
Cancels a single premigration assessment run.
This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
679 680 681 682 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 679 def cancel_replication_task_assessment_run(params = {}, = {}) req = build_request(:cancel_replication_task_assessment_run, params) req.send_request() end |
#create_data_migration(params = {}) ⇒ Types::CreateDataMigrationResponse
Creates a data migration using the provided settings.
795 796 797 798 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 795 def create_data_migration(params = {}, = {}) req = build_request(:create_data_migration, params) req.send_request() end |
#create_data_provider(params = {}) ⇒ Types::CreateDataProviderResponse
Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 1002 def create_data_provider(params = {}, = {}) req = build_request(:create_data_provider, params) req.send_request() end |
#create_endpoint(params = {}) ⇒ Types::CreateEndpointResponse
Creates an endpoint using the provided settings.
DatabaseName
request parameter on the
CreateEndpoint
API call. Specifying DatabaseName
when you create a
MySQL endpoint replicates all the task tables to this single database.
For MySQL endpoints, you specify the database only when you specify
the schema in the table-mapping rules of the DMS task.
1999 2000 2001 2002 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 1999 def create_endpoint(params = {}, = {}) req = build_request(:create_endpoint, params) req.send_request() end |
#create_event_subscription(params = {}) ⇒ Types::CreateEventSubscriptionResponse
Creates an DMS event notification subscription.
You can specify the type of source (SourceType
) you want to be
notified of, provide a list of DMS source IDs (SourceIds
) that
triggers the events, and provide a list of event categories
(EventCategories
) for events you want to be notified of. If you
specify both the SourceType
and SourceIds
, such as SourceType =
replication-instance
and SourceIdentifier = my-replinstance
, you
will be notified of all the replication instance events for the
specified source. If you specify a SourceType
but don't specify a
SourceIdentifier
, you receive notice of the events for that source
type for all your DMS sources. If you don't specify either
SourceType
nor SourceIdentifier
, you will be notified of events
generated from all DMS sources belonging to your customer account.
For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
2109 2110 2111 2112 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2109 def create_event_subscription(params = {}, = {}) req = build_request(:create_event_subscription, params) req.send_request() end |
#create_fleet_advisor_collector(params = {}) ⇒ Types::CreateFleetAdvisorCollectorResponse
Creates a Fleet Advisor collector using the specified parameters.
2160 2161 2162 2163 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2160 def create_fleet_advisor_collector(params = {}, = {}) req = build_request(:create_fleet_advisor_collector, params) req.send_request() end |
#create_instance_profile(params = {}) ⇒ Types::CreateInstanceProfileResponse
Creates the instance profile using the specified parameters.
2257 2258 2259 2260 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2257 def create_instance_profile(params = {}, = {}) req = build_request(:create_instance_profile, params) req.send_request() end |
#create_migration_project(params = {}) ⇒ Types::CreateMigrationProjectResponse
Creates the migration project using the specified parameters.
You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider.
2438 2439 2440 2441 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2438 def create_migration_project(params = {}, = {}) req = build_request(:create_migration_project, params) req.send_request() end |
#create_replication_config(params = {}) ⇒ Types::CreateReplicationConfigResponse
Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.
2590 2591 2592 2593 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2590 def create_replication_config(params = {}, = {}) req = build_request(:create_replication_config, params) req.send_request() end |
#create_replication_instance(params = {}) ⇒ Types::CreateReplicationInstanceResponse
Creates the replication instance using the specified parameters.
DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the CLI and DMS API. For information on the required permissions, see IAM Permissions Needed to Use DMS.
2902 2903 2904 2905 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2902 def create_replication_instance(params = {}, = {}) req = build_request(:create_replication_instance, params) req.send_request() end |
#create_replication_subnet_group(params = {}) ⇒ Types::CreateReplicationSubnetGroupResponse
Creates a replication subnet group given a list of the subnet IDs in a VPC.
The VPC needs to have at least one subnet in at least two availability
zones in the Amazon Web Services Region, otherwise the service will
throw a ReplicationSubnetGroupDoesNotCoverEnoughAZs
exception.
If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action returns the following error message: The Replication Subnet Group already exists. In this case, delete the existing replication subnet group. To do so, use the DeleteReplicationSubnetGroup action. Optionally, choose Subnet groups in the DMS console, then choose your subnet group. Next, choose Delete from Actions.
3006 3007 3008 3009 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3006 def create_replication_subnet_group(params = {}, = {}) req = build_request(:create_replication_subnet_group, params) req.send_request() end |
#create_replication_task(params = {}) ⇒ Types::CreateReplicationTaskResponse
Creates a replication task using the specified parameters.
3229 3230 3231 3232 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3229 def create_replication_task(params = {}, = {}) req = build_request(:create_replication_task, params) req.send_request() end |
#delete_certificate(params = {}) ⇒ Types::DeleteCertificateResponse
Deletes the specified certificate.
3281 3282 3283 3284 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3281 def delete_certificate(params = {}, = {}) req = build_request(:delete_certificate, params) req.send_request() end |
#delete_connection(params = {}) ⇒ Types::DeleteConnectionResponse
Deletes the connection between a replication instance and an endpoint.
3335 3336 3337 3338 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3335 def delete_connection(params = {}, = {}) req = build_request(:delete_connection, params) req.send_request() end |
#delete_data_migration(params = {}) ⇒ Types::DeleteDataMigrationResponse
Deletes the specified data migration.
3394 3395 3396 3397 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3394 def delete_data_migration(params = {}, = {}) req = build_request(:delete_data_migration, params) req.send_request() end |
#delete_data_provider(params = {}) ⇒ Types::DeleteDataProviderResponse
Deletes the specified data provider.
3502 3503 3504 3505 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3502 def delete_data_provider(params = {}, = {}) req = build_request(:delete_data_provider, params) req.send_request() end |
#delete_endpoint(params = {}) ⇒ Types::DeleteEndpointResponse
Deletes the specified endpoint.
3870 3871 3872 3873 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3870 def delete_endpoint(params = {}, = {}) req = build_request(:delete_endpoint, params) req.send_request() end |
#delete_event_subscription(params = {}) ⇒ Types::DeleteEventSubscriptionResponse
Deletes an DMS event subscription.
3908 3909 3910 3911 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3908 def delete_event_subscription(params = {}, = {}) req = build_request(:delete_event_subscription, params) req.send_request() end |
#delete_fleet_advisor_collector(params = {}) ⇒ Struct
Deletes the specified Fleet Advisor collector.
3930 3931 3932 3933 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3930 def delete_fleet_advisor_collector(params = {}, = {}) req = build_request(:delete_fleet_advisor_collector, params) req.send_request() end |
#delete_fleet_advisor_databases(params = {}) ⇒ Types::DeleteFleetAdvisorDatabasesResponse
Deletes the specified Fleet Advisor collector databases.
3959 3960 3961 3962 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3959 def delete_fleet_advisor_databases(params = {}, = {}) req = build_request(:delete_fleet_advisor_databases, params) req.send_request() end |
#delete_instance_profile(params = {}) ⇒ Types::DeleteInstanceProfileResponse
Deletes the specified instance profile.
4002 4003 4004 4005 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4002 def delete_instance_profile(params = {}, = {}) req = build_request(:delete_instance_profile, params) req.send_request() end |
#delete_migration_project(params = {}) ⇒ Types::DeleteMigrationProjectResponse
Deletes the specified migration project.
4093 4094 4095 4096 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4093 def delete_migration_project(params = {}, = {}) req = build_request(:delete_migration_project, params) req.send_request() end |
#delete_replication_config(params = {}) ⇒ Types::DeleteReplicationConfigResponse
Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
4144 4145 4146 4147 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4144 def delete_replication_config(params = {}, = {}) req = build_request(:delete_replication_config, params) req.send_request() end |
#delete_replication_instance(params = {}) ⇒ Types::DeleteReplicationInstanceResponse
Deletes the specified replication instance.
4284 4285 4286 4287 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4284 def delete_replication_instance(params = {}, = {}) req = build_request(:delete_replication_instance, params) req.send_request() end |
#delete_replication_subnet_group(params = {}) ⇒ Struct
Deletes a subnet group.
4319 4320 4321 4322 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4319 def delete_replication_subnet_group(params = {}, = {}) req = build_request(:delete_replication_subnet_group, params) req.send_request() end |
#delete_replication_task(params = {}) ⇒ Types::DeleteReplicationTaskResponse
Deletes the specified replication task.
4400 4401 4402 4403 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4400 def delete_replication_task(params = {}, = {}) req = build_request(:delete_replication_task, params) req.send_request() end |
#delete_replication_task_assessment_run(params = {}) ⇒ Types::DeleteReplicationTaskAssessmentRunResponse
Deletes the record of a single premigration assessment run.
This operation removes all metadata that DMS maintains about this assessment run. However, the operation leaves untouched all information about this assessment run that is stored in your Amazon S3 bucket.
4452 4453 4454 4455 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4452 def delete_replication_task_assessment_run(params = {}, = {}) req = build_request(:delete_replication_task_assessment_run, params) req.send_request() end |
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResponse
Lists all of the DMS attributes for a customer account. These attributes include DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.
This command does not take any parameters.
4516 4517 4518 4519 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4516 def describe_account_attributes(params = {}, = {}) req = build_request(:describe_account_attributes, params) req.send_request() end |
#describe_applicable_individual_assessments(params = {}) ⇒ Types::DescribeApplicableIndividualAssessmentsResponse
Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.
If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.
To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.
If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4604 4605 4606 4607 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4604 def describe_applicable_individual_assessments(params = {}, = {}) req = build_request(:describe_applicable_individual_assessments, params) req.send_request() end |
#describe_certificates(params = {}) ⇒ Types::DescribeCertificatesResponse
Provides a description of the certificate.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4693 4694 4695 4696 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4693 def describe_certificates(params = {}, = {}) req = build_request(:describe_certificates, params) req.send_request() end |
#describe_connections(params = {}) ⇒ Types::DescribeConnectionsResponse
Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- test_connection_succeeds
4796 4797 4798 4799 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4796 def describe_connections(params = {}, = {}) req = build_request(:describe_connections, params) req.send_request() end |
#describe_conversion_configuration(params = {}) ⇒ Types::DescribeConversionConfigurationResponse
Returns configuration parameters for a schema conversion project.
4842 4843 4844 4845 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4842 def describe_conversion_configuration(params = {}, = {}) req = build_request(:describe_conversion_configuration, params) req.send_request() end |
#describe_data_migrations(params = {}) ⇒ Types::DescribeDataMigrationsResponse
Returns information about data migrations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4937 4938 4939 4940 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4937 def describe_data_migrations(params = {}, = {}) req = build_request(:describe_data_migrations, params) req.send_request() end |
#describe_data_providers(params = {}) ⇒ Types::DescribeDataProvidersResponse
Returns a paginated list of data providers for your account in the current region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.