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_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_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_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_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_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_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.
429 430 431 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 429 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.
495 496 497 498 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 495 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).
553 554 555 556 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 553 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
.
606 607 608 609 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 606 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.
651 652 653 654 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 651 def cancel_replication_task_assessment_run(params = {}, = {}) req = build_request(:cancel_replication_task_assessment_run, 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.
858 859 860 861 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 858 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.
1852 1853 1854 1855 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 1852 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.
1962 1963 1964 1965 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 1962 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.
2013 2014 2015 2016 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2013 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.
2110 2111 2112 2113 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2110 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.
2291 2292 2293 2294 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2291 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.
2443 2444 2445 2446 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2443 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.
2755 2756 2757 2758 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2755 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.
2859 2860 2861 2862 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 2859 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.
3082 3083 3084 3085 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3082 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.
3134 3135 3136 3137 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3134 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.
3188 3189 3190 3191 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3188 def delete_connection(params = {}, = {}) req = build_request(:delete_connection, params) req.send_request() end |
#delete_data_provider(params = {}) ⇒ Types::DeleteDataProviderResponse
Deletes the specified data provider.
3296 3297 3298 3299 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3296 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.
3664 3665 3666 3667 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3664 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.
3702 3703 3704 3705 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3702 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.
3724 3725 3726 3727 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3724 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.
3753 3754 3755 3756 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3753 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.
3796 3797 3798 3799 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3796 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.
3887 3888 3889 3890 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3887 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.
3938 3939 3940 3941 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 3938 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.
4078 4079 4080 4081 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4078 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.
4113 4114 4115 4116 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4113 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.
4194 4195 4196 4197 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4194 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.
4240 4241 4242 4243 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4240 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.
4304 4305 4306 4307 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4304 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.
4392 4393 4394 4395 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4392 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.
4481 4482 4483 4484 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4481 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
4584 4585 4586 4587 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4584 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.
4630 4631 4632 4633 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4630 def describe_conversion_configuration(params = {}, = {}) req = build_request(:describe_conversion_configuration, 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.
4776 4777 4778 4779 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4776 def describe_data_providers(params = {}, = {}) req = build_request(:describe_data_providers, params) req.send_request() end |
#describe_endpoint_settings(params = {}) ⇒ Types::DescribeEndpointSettingsResponse
Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4832 4833 4834 4835 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4832 def describe_endpoint_settings(params = {}, = {}) req = build_request(:describe_endpoint_settings, params) req.send_request() end |
#describe_endpoint_types(params = {}) ⇒ Types::DescribeEndpointTypesResponse
Returns information about the type of endpoints available.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4919 4920 4921 4922 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 4919 def describe_endpoint_types(params = {}, = {}) req = build_request(:describe_endpoint_types, params) req.send_request() end |
#describe_endpoints(params = {}) ⇒ Types::DescribeEndpointsResponse
Returns information about the endpoints for your account in the current region.
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):
- endpoint_deleted
5318 5319 5320 5321 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5318 def describe_endpoints(params = {}, = {}) req = build_request(:describe_endpoints, params) req.send_request() end |
#describe_engine_versions(params = {}) ⇒ Types::DescribeEngineVersionsResponse
Returns information about the replication instance versions used in the project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5369 5370 5371 5372 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5369 def describe_engine_versions(params = {}, = {}) req = build_request(:describe_engine_versions, params) req.send_request() end |
#describe_event_categories(params = {}) ⇒ Types::DescribeEventCategoriesResponse
Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the Database Migration Service User Guide.
5418 5419 5420 5421 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5418 def describe_event_categories(params = {}, = {}) req = build_request(:describe_event_categories, params) req.send_request() end |
#describe_event_subscriptions(params = {}) ⇒ Types::DescribeEventSubscriptionsResponse
Lists all the event subscriptions for a customer account. The
description of a subscription includes SubscriptionName
,
SNSTopicARN
, CustomerID
, SourceType
, SourceID
, CreationTime
,
and Status
.
If you specify SubscriptionName
, this action lists the description
for that subscription.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5495 5496 5497 5498 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5495 def describe_event_subscriptions(params = {}, = {}) req = build_request(:describe_event_subscriptions, params) req.send_request() end |
#describe_events(params = {}) ⇒ Types::DescribeEventsResponse
Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5589 5590 5591 5592 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5589 def describe_events(params = {}, = {}) req = build_request(:describe_events, params) req.send_request() end |
#describe_extension_pack_associations(params = {}) ⇒ Types::DescribeExtensionPackAssociationsResponse
Returns a paginated list of extension pack associations for the specified migration project. 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5690 5691 5692 5693 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5690 def describe_extension_pack_associations(params = {}, = {}) req = build_request(:describe_extension_pack_associations, params) req.send_request() end |
#describe_fleet_advisor_collectors(params = {}) ⇒ Types::DescribeFleetAdvisorCollectorsResponse
Returns a list of the Fleet Advisor collectors in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5764 5765 5766 5767 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5764 def describe_fleet_advisor_collectors(params = {}, = {}) req = build_request(:describe_fleet_advisor_collectors, params) req.send_request() end |
#describe_fleet_advisor_databases(params = {}) ⇒ Types::DescribeFleetAdvisorDatabasesResponse
Returns a list of Fleet Advisor databases in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5846 5847 5848 5849 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5846 def describe_fleet_advisor_databases(params = {}, = {}) req = build_request(:describe_fleet_advisor_databases, params) req.send_request() end |
#describe_fleet_advisor_lsa_analysis(params = {}) ⇒ Types::DescribeFleetAdvisorLsaAnalysisResponse
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5888 5889 5890 5891 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5888 def describe_fleet_advisor_lsa_analysis(params = {}, = {}) req = build_request(:describe_fleet_advisor_lsa_analysis, params) req.send_request() end |
#describe_fleet_advisor_schema_object_summary(params = {}) ⇒ Types::DescribeFleetAdvisorSchemaObjectSummaryResponse
Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5952 5953 5954 5955 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 5952 def describe_fleet_advisor_schema_object_summary(params = {}, = {}) req = build_request(:describe_fleet_advisor_schema_object_summary, params) req.send_request() end |
#describe_fleet_advisor_schemas(params = {}) ⇒ Types::DescribeFleetAdvisorSchemasResponse
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6043 6044 6045 6046 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6043 def describe_fleet_advisor_schemas(params = {}, = {}) req = build_request(:describe_fleet_advisor_schemas, params) req.send_request() end |
#describe_instance_profiles(params = {}) ⇒ Types::DescribeInstanceProfilesResponse
Returns a paginated list of instance profiles for your account in the current region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6112 6113 6114 6115 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6112 def describe_instance_profiles(params = {}, = {}) req = build_request(:describe_instance_profiles, params) req.send_request() end |
#describe_metadata_model_assessments(params = {}) ⇒ Types::DescribeMetadataModelAssessmentsResponse
Returns a paginated list of metadata model assessments for your account in the current region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6211 6212 6213 6214 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6211 def (params = {}, = {}) req = build_request(:describe_metadata_model_assessments, params) req.send_request() end |
#describe_metadata_model_conversions(params = {}) ⇒ Types::DescribeMetadataModelConversionsResponse
Returns a paginated list of metadata model conversions for a migration project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6310 6311 6312 6313 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6310 def (params = {}, = {}) req = build_request(:describe_metadata_model_conversions, params) req.send_request() end |
#describe_metadata_model_exports_as_script(params = {}) ⇒ Types::DescribeMetadataModelExportsAsScriptResponse
Returns a paginated list of metadata model exports.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6408 6409 6410 6411 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6408 def (params = {}, = {}) req = build_request(:describe_metadata_model_exports_as_script, params) req.send_request() end |
#describe_metadata_model_exports_to_target(params = {}) ⇒ Types::DescribeMetadataModelExportsToTargetResponse
Returns a paginated list of metadata model exports.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6506 6507 6508 6509 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6506 def (params = {}, = {}) req = build_request(:describe_metadata_model_exports_to_target, params) req.send_request() end |
#describe_metadata_model_imports(params = {}) ⇒ Types::DescribeMetadataModelImportsResponse
Returns a paginated list of metadata model imports.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6601 6602 6603 6604 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6601 def (params = {}, = {}) req = build_request(:describe_metadata_model_imports, params) req.send_request() end |
#describe_migration_projects(params = {}) ⇒ Types::DescribeMigrationProjectsResponse
Returns a paginated list of migration projects for your account in the current region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6730 6731 6732 6733 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6730 def describe_migration_projects(params = {}, = {}) req = build_request(:describe_migration_projects, params) req.send_request() end |
#describe_orderable_replication_instances(params = {}) ⇒ Types::DescribeOrderableReplicationInstancesResponse
Returns information about the replication instance types that can be created in the specified region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6803 6804 6805 6806 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6803 def describe_orderable_replication_instances(params = {}, = {}) req = build_request(:describe_orderable_replication_instances, params) req.send_request() end |
#describe_pending_maintenance_actions(params = {}) ⇒ Types::DescribePendingMaintenanceActionsResponse
For internal use only
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6868 6869 6870 6871 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6868 def describe_pending_maintenance_actions(params = {}, = {}) req = build_request(:describe_pending_maintenance_actions, params) req.send_request() end |
#describe_recommendation_limitations(params = {}) ⇒ Types::DescribeRecommendationLimitationsResponse
Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6932 6933 6934 6935 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 6932 def describe_recommendation_limitations(params = {}, = {}) req = build_request(:describe_recommendation_limitations, params) req.send_request() end |
#describe_recommendations(params = {}) ⇒ Types::DescribeRecommendationsResponse
Returns a paginated list of target engine recommendations for your source databases.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7013 7014 7015 7016 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7013 def describe_recommendations(params = {}, = {}) req = build_request(:describe_recommendations, params) req.send_request() end |
#describe_refresh_schemas_status(params = {}) ⇒ Types::DescribeRefreshSchemasStatusResponse
Returns the status of the RefreshSchemas operation.
7061 7062 7063 7064 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7061 def describe_refresh_schemas_status(params = {}, = {}) req = build_request(:describe_refresh_schemas_status, params) req.send_request() end |
#describe_replication_configs(params = {}) ⇒ Types::DescribeReplicationConfigsResponse
Returns one or more existing DMS Serverless replication configurations as a list of structures.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7132 7133 7134 7135 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7132 def describe_replication_configs(params = {}, = {}) req = build_request(:describe_replication_configs, params) req.send_request() end |
#describe_replication_instance_task_logs(params = {}) ⇒ Types::DescribeReplicationInstanceTaskLogsResponse
Returns information about the task logs for the specified task.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7186 7187 7188 7189 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7186 def describe_replication_instance_task_logs(params = {}, = {}) req = build_request(:describe_replication_instance_task_logs, params) req.send_request() end |
#describe_replication_instances(params = {}) ⇒ Types::DescribeReplicationInstancesResponse
Returns information about replication instances for your account in the current region.
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):
- replication_instance_available
- replication_instance_deleted
7320 7321 7322 7323 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7320 def describe_replication_instances(params = {}, = {}) req = build_request(:describe_replication_instances, params) req.send_request() end |
#describe_replication_subnet_groups(params = {}) ⇒ Types::DescribeReplicationSubnetGroupsResponse
Returns information about the replication subnet groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7412 7413 7414 7415 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7412 def describe_replication_subnet_groups(params = {}, = {}) req = build_request(:describe_replication_subnet_groups, params) req.send_request() end |
#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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7493 7494 7495 7496 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7493 def describe_replication_table_statistics(params = {}, = {}) req = build_request(:describe_replication_table_statistics, params) req.send_request() end |
#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. This action always returns the latest results.
For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7563 7564 7565 7566 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7563 def describe_replication_task_assessment_results(params = {}, = {}) req = build_request(:describe_replication_task_assessment_results, params) req.send_request() end |
#describe_replication_task_assessment_runs(params = {}) ⇒ Types::DescribeReplicationTaskAssessmentRunsResponse
Returns a paginated list of premigration assessment runs based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, replication instances, and assessment run status values.
DescribeReplicationTaskIndividualAssessments
operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7641 7642 7643 7644 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7641 def describe_replication_task_assessment_runs(params = {}, = {}) req = build_request(:describe_replication_task_assessment_runs, params) req.send_request() end |
#describe_replication_task_individual_assessments(params = {}) ⇒ Types::DescribeReplicationTaskIndividualAssessmentsResponse
Returns a paginated list of individual assessments based on filter settings.
These filter settings can specify a combination of premigration assessment runs, migration tasks, and assessment status values.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7704 7705 7706 7707 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7704 def describe_replication_task_individual_assessments(params = {}, = {}) req = build_request(:describe_replication_task_individual_assessments, params) req.send_request() end |
#describe_replication_tasks(params = {}) ⇒ Types::DescribeReplicationTasksResponse
Returns information about replication tasks for your account in the current region.
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):
- replication_task_deleted
- replication_task_ready
- replication_task_running
- replication_task_stopped
7831 7832 7833 7834 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7831 def describe_replication_tasks(params = {}, = {}) req = build_request(:describe_replication_tasks, params) req.send_request() end |
#describe_replications(params = {}) ⇒ Types::DescribeReplicationsResponse
Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7917 7918 7919 7920 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7917 def describe_replications(params = {}, = {}) req = build_request(:describe_replications, params) req.send_request() end |
#describe_schemas(params = {}) ⇒ Types::DescribeSchemasResponse
Returns information about the schema for the specified endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7986 7987 7988 7989 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 7986 def describe_schemas(params = {}, = {}) req = build_request(:describe_schemas, params) req.send_request() end |
#describe_table_statistics(params = {}) ⇒ Types::DescribeTableStatisticsResponse
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
Note that the "last updated" column the DMS console only indicates the time that DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8099 8100 8101 8102 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 8099 def describe_table_statistics(params = {}, = {}) req = build_request(:describe_table_statistics, params) req.send_request() end |
#export_metadata_model_assessment(params = {}) ⇒ Types::ExportMetadataModelAssessmentResponse
Saves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.
8172 8173 8174 8175 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 8172 def (params = {}, = {}) req = build_request(:export_metadata_model_assessment, params) req.send_request() end |
#import_certificate(params = {}) ⇒ Types::ImportCertificateResponse
Uploads the specified certificate.
8250 8251 8252 8253 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 8250 def import_certificate(params = {}, = {}) req = build_request(:import_certificate, params) req.send_request() end |
#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. For
more information, see Tag
data type description.
8312 8313 8314 8315 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 8312 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#modify_conversion_configuration(params = {}) ⇒ Types::ModifyConversionConfigurationResponse
Modifies the specified schema conversion configuration using the provided parameters.
8360 8361 8362 8363 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 8360 def modify_conversion_configuration(params = {}, = {}) req = build_request(:modify_conversion_configuration, params) req.send_request() end |
#modify_data_provider(params = {}) ⇒ Types::ModifyDataProviderResponse
Modifies the specified data provider using the provided settings.
8575 8576 8577 8578 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 8575 def modify_data_provider(params = {}, = {}) req = build_request(:modify_data_provider, params) req.send_request() end |
#modify_endpoint(params = {}) ⇒ Types::ModifyEndpointResponse
Modifies the specified endpoint.
DatabaseName
request parameter on the
ModifyEndpoint
API call. Specifying DatabaseName
when you modify a
MySQL endpoint replicates all the task tables to this single database.
For MySQL endpoints, you specify the database only when you specify
the schema in the table-mapping rules of the DMS task.
9548 9549 9550 9551 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 9548 def modify_endpoint(params = {}, = {}) req = build_request(:modify_endpoint, params) req.send_request() end |
#modify_event_subscription(params = {}) ⇒ Types::ModifyEventSubscriptionResponse
Modifies an existing DMS event notification subscription.
9609 9610 9611 9612 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 9609 def modify_event_subscription(params = {}, = {}) req = build_request(:modify_event_subscription, params) req.send_request() end |
#modify_instance_profile(params = {}) ⇒ Types::ModifyInstanceProfileResponse
Modifies the specified instance profile using the provided parameters.
9704 9705 9706 9707 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 9704 def modify_instance_profile(params = {}, = {}) req = build_request(:modify_instance_profile, params) req.send_request() end |
#modify_migration_project(params = {}) ⇒ Types::ModifyMigrationProjectResponse
Modifies the specified migration project using the provided parameters.
9868 9869 9870 9871 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 9868 def modify_migration_project(params = {}, = {}) req = build_request(:modify_migration_project, params) req.send_request() end |
#modify_replication_config(params = {}) ⇒ Types::ModifyReplicationConfigResponse
Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it.
Other run statuses that allow you to run this command include FAILED and CREATED. A provisioning state that allows you to run this command is FAILED_PROVISION.
9970 9971 9972 9973 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 9970 def modify_replication_config(params = {}, = {}) req = build_request(:modify_replication_config, params) req.send_request() end |
#modify_replication_instance(params = {}) ⇒ Types::ModifyReplicationInstanceResponse
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
10218 10219 10220 10221 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10218 def modify_replication_instance(params = {}, = {}) req = build_request(:modify_replication_instance, params) req.send_request() end |
#modify_replication_subnet_group(params = {}) ⇒ Types::ModifyReplicationSubnetGroupResponse
Modifies the settings for the specified replication subnet group.
10281 10282 10283 10284 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10281 def modify_replication_subnet_group(params = {}, = {}) req = build_request(:modify_replication_subnet_group, params) req.send_request() end |
#modify_replication_task(params = {}) ⇒ Types::ModifyReplicationTaskResponse
Modifies the specified replication task.
You can't modify the task endpoints. The task must be stopped before you can modify it.
For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
10435 10436 10437 10438 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10435 def modify_replication_task(params = {}, = {}) req = build_request(:modify_replication_task, params) req.send_request() end |
#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. The target replication instance must be created with the same or later DMS version as the current replication instance.
10499 10500 10501 10502 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10499 def move_replication_task(params = {}, = {}) req = build_request(:move_replication_task, params) req.send_request() end |
#reboot_replication_instance(params = {}) ⇒ Types::RebootReplicationInstanceResponse
Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
10585 10586 10587 10588 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10585 def reboot_replication_instance(params = {}, = {}) req = build_request(:reboot_replication_instance, params) req.send_request() end |
#refresh_schemas(params = {}) ⇒ Types::RefreshSchemasResponse
Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
10642 10643 10644 10645 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10642 def refresh_schemas(params = {}, = {}) req = build_request(:refresh_schemas, params) req.send_request() end |
#reload_replication_tables(params = {}) ⇒ Types::ReloadReplicationTablesResponse
Reloads the target database table with the source data for a given DMS Serverless replication configuration.
You can only use this operation with a task in the RUNNING state,
otherwise the service will throw an InvalidResourceStateFault
exception.
10692 10693 10694 10695 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10692 def reload_replication_tables(params = {}, = {}) req = build_request(:reload_replication_tables, params) req.send_request() end |
#reload_tables(params = {}) ⇒ Types::ReloadTablesResponse
Reloads the target database table with the source data.
You can only use this operation with a task in the RUNNING
state,
otherwise the service will throw an InvalidResourceStateFault
exception.
10744 10745 10746 10747 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10744 def reload_tables(params = {}, = {}) req = build_request(:reload_tables, params) req.send_request() end |
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes metadata tags from an DMS resource, including replication
instance, endpoint, subnet group, and migration task. For more
information, see Tag
data type description.
10792 10793 10794 10795 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10792 def (params = {}, = {}) req = build_request(:remove_tags_from_resource, params) req.send_request() end |
#run_fleet_advisor_lsa_analysis(params = {}) ⇒ Types::RunFleetAdvisorLsaAnalysisResponse
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
10814 10815 10816 10817 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10814 def run_fleet_advisor_lsa_analysis(params = {}, = {}) req = build_request(:run_fleet_advisor_lsa_analysis, params) req.send_request() end |
#start_extension_pack_association(params = {}) ⇒ Types::StartExtensionPackAssociationResponse
Applies the extension pack to your target database. 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.
10859 10860 10861 10862 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10859 def start_extension_pack_association(params = {}, = {}) req = build_request(:start_extension_pack_association, params) req.send_request() end |
#start_metadata_model_assessment(params = {}) ⇒ Types::StartMetadataModelAssessmentResponse
Creates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance.
10911 10912 10913 10914 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10911 def (params = {}, = {}) req = build_request(:start_metadata_model_assessment, params) req.send_request() end |
#start_metadata_model_conversion(params = {}) ⇒ Types::StartMetadataModelConversionResponse
Converts your source database objects to a format compatible with the target database.
10959 10960 10961 10962 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 10959 def (params = {}, = {}) req = build_request(:start_metadata_model_conversion, params) req.send_request() end |
#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.
11017 11018 11019 11020 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11017 def (params = {}, = {}) req = build_request(:start_metadata_model_export_as_script, params) req.send_request() end |
#start_metadata_model_export_to_target(params = {}) ⇒ Types::StartMetadataModelExportToTargetResponse
Applies converted database objects to your target database.
11072 11073 11074 11075 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11072 def (params = {}, = {}) req = build_request(:start_metadata_model_export_to_target, params) req.send_request() end |
#start_metadata_model_import(params = {}) ⇒ Types::StartMetadataModelImportResponse
Loads the metadata for all the dependent database objects of the parent object.
This operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.
11134 11135 11136 11137 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11134 def (params = {}, = {}) req = build_request(:start_metadata_model_import, params) req.send_request() end |
#start_recommendations(params = {}) ⇒ Struct
Starts the analysis of your source database to provide recommendations of target engines.
You can create recommendations for multiple source databases using BatchStartRecommendations.
11179 11180 11181 11182 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11179 def start_recommendations(params = {}, = {}) req = build_request(:start_recommendations, params) req.send_request() end |
#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. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.
11272 11273 11274 11275 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11272 def start_replication(params = {}, = {}) req = build_request(:start_replication, params) req.send_request() end |
#start_replication_task(params = {}) ⇒ Types::StartReplicationTaskResponse
Starts the replication task.
For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
11431 11432 11433 11434 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11431 def start_replication_task(params = {}, = {}) req = build_request(:start_replication_task, params) req.send_request() end |
#start_replication_task_assessment(params = {}) ⇒ Types::StartReplicationTaskAssessmentResponse
Starts the replication task assessment for unsupported data types in the source database.
You can only use this operation for a task if the following conditions are true:
The task must be in the
stopped
state.The task must have successful connections to the source and target.
If either of these conditions are not met, an
InvalidResourceStateFault
error will result.
For information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.
11505 11506 11507 11508 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11505 def start_replication_task_assessment(params = {}, = {}) req = build_request(:start_replication_task_assessment, params) req.send_request() end |
#start_replication_task_assessment_run(params = {}) ⇒ Types::StartReplicationTaskAssessmentRunResponse
Starts a new premigration assessment run for one or more individual assessments of a migration task.
The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
11626 11627 11628 11629 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11626 def start_replication_task_assessment_run(params = {}, = {}) req = build_request(:start_replication_task_assessment_run, params) req.send_request() end |
#stop_replication(params = {}) ⇒ Types::StopReplicationResponse
For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.
11690 11691 11692 11693 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11690 def stop_replication(params = {}, = {}) req = build_request(:stop_replication, params) req.send_request() end |
#stop_replication_task(params = {}) ⇒ Types::StopReplicationTaskResponse
Stops the replication task.
11771 11772 11773 11774 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11771 def stop_replication_task(params = {}, = {}) req = build_request(:stop_replication_task, params) req.send_request() end |
#test_connection(params = {}) ⇒ Types::TestConnectionResponse
Tests the connection between the replication instance and the endpoint.
11826 11827 11828 11829 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11826 def test_connection(params = {}, = {}) req = build_request(:test_connection, params) req.send_request() end |
#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. By default,
this operation migrates subscriptions only when all your replication
instance versions are 3.4.5 or higher. If any replication instances
are from versions earlier than 3.4.5, the operation raises an error
and tells you to upgrade these instances to version 3.4.5 or higher.
To enable migration regardless of version, set the Force
option to
true. However, if you don't upgrade instances earlier than version
3.4.5, some types of events might not be available when you use Amazon
EventBridge.
To call this operation, make sure that you have certain permissions added to your user account. For more information, see Migrating event subscriptions to Amazon EventBridge in the Amazon Web Services Database Migration Service User Guide.
11875 11876 11877 11878 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11875 def update_subscriptions_to_event_bridge(params = {}, = {}) req = build_request(:update_subscriptions_to_event_bridge, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
endpoint_deleted | #describe_endpoints | 5 | 60 |
replication_instance_available | #describe_replication_instances | 60 | 60 |
replication_instance_deleted | #describe_replication_instances | 15 | 60 |
replication_task_deleted | #describe_replication_tasks | 15 | 60 |
replication_task_ready | #describe_replication_tasks | 15 | 60 |
replication_task_running | #describe_replication_tasks | 15 | 60 |
replication_task_stopped | #describe_replication_tasks | 15 | 60 |
test_connection_succeeds | #describe_connections | 5 | 60 |
11992 11993 11994 11995 11996 |
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/client.rb', line 11992 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |