Class: Aws::DatabaseMigrationService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DatabaseMigrationService::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#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.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 419 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
12023 12024 12025 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 12023 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
12026 12027 12028 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 12026 def errors_module Errors 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` ][1] data type description.
[1]: docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html
485 486 487 488 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 485 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).
543 544 545 546 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 543 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`.
[1]: docs.aws.amazon.com/dms/latest/APIReference/API_StartRecommendations.html
596 597 598 599 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 596 def batch_start_recommendations(params = {}, = {}) req = build_request(:batch_start_recommendations, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11874 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-databasemigrationservice' context[:gem_version] = '1.93.0' Seahorse::Client::Request.new(handlers, context) 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.
641 642 643 644 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 641 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.
848 849 850 851 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 848 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.
<note markdown=“1”> For a MySQL source or target endpoint, don’t explicitly specify the database using the ‘DatabaseName` request parameter on the `CreateEndpoint` API call. Specifying `DatabaseName` when you create a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
</note>
1842 1843 1844 1845 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 1842 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.*
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html
1952 1953 1954 1955 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 1952 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.
2003 2004 2005 2006 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 2003 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.
2100 2101 2102 2103 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 2100 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].
[1]: docs.aws.amazon.com/dms/latest/APIReference/API_CreateInstanceProfile.html [2]: docs.aws.amazon.com/dms/latest/APIReference/API_CreateDataProvider.html
2281 2282 2283 2284 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 2281 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.
2433 2434 2435 2436 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 2433 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].
<note markdown=“1”> If you don’t specify a version when creating a replication instance, DMS will create the instance using the default engine version. For information about the default engine version, see [Release Notes].
</note>
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.APIRole [2]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.IAMPermissions [3]: docs.aws.amazon.com/dms/latest/userguide/CHAP_ReleaseNotes.html
2745 2746 2747 2748 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 2745 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][1
-
action. Optionally, choose Subnet
groups in the DMS console, then choose your subnet group. Next, choose Delete from Actions.
[1]: docs.aws.amazon.com/en_us/dms/latest/APIReference/API_DeleteReplicationSubnetGroup.html
2849 2850 2851 2852 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 2849 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.
3072 3073 3074 3075 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3072 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.
3124 3125 3126 3127 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3124 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.
3178 3179 3180 3181 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3178 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.
<note markdown=“1”> All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.
</note>
3286 3287 3288 3289 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3286 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.
<note markdown=“1”> All tasks associated with the endpoint must be deleted before you can delete the endpoint.
</note>
3654 3655 3656 3657 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3654 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.
3692 3693 3694 3695 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3692 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.
3714 3715 3716 3717 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3714 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.
3743 3744 3745 3746 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3743 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.
<note markdown=“1”> All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.
</note>
3786 3787 3788 3789 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3786 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.
<note markdown=“1”> The migration project must be closed before you can delete it.
</note>
3877 3878 3879 3880 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3877 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.
3928 3929 3930 3931 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 3928 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.
<note markdown=“1”> You must delete any migration tasks that are associated with the replication instance before you can delete it.
</note>
4068 4069 4070 4071 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4068 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.
4103 4104 4105 4106 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4103 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.
4184 4185 4186 4187 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4184 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.
4230 4231 4232 4233 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4230 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.
4294 4295 4296 4297 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4294 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.
4382 4383 4384 4385 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4382 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.
4471 4472 4473 4474 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4471 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
4574 4575 4576 4577 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4574 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.
4620 4621 4622 4623 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4620 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.
4766 4767 4768 4769 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4766 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.
4822 4823 4824 4825 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4822 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.
4909 4910 4911 4912 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 4909 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
5308 5309 5310 5311 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5308 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.
5359 5360 5361 5362 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5359 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.*
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html
5408 5409 5410 5411 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5408 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.
5485 5486 5487 5488 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5485 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.*
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5579 5580 5581 5582 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5579 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.
5680 5681 5682 5683 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5680 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.
5754 5755 5756 5757 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5754 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.
5836 5837 5838 5839 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5836 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.
5878 5879 5880 5881 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5878 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.
5942 5943 5944 5945 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 5942 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.
6033 6034 6035 6036 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6033 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.
6102 6103 6104 6105 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6102 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.
6201 6202 6203 6204 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6201 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.
6300 6301 6302 6303 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6300 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.
6398 6399 6400 6401 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6398 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.
6496 6497 6498 6499 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6496 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.
6591 6592 6593 6594 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6591 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.
6720 6721 6722 6723 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6720 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.
6793 6794 6795 6796 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6793 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.
6858 6859 6860 6861 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6858 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.
6922 6923 6924 6925 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 6922 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.
7003 7004 7005 7006 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7003 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.
7051 7052 7053 7054 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7051 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.
7122 7123 7124 7125 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7122 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.
7176 7177 7178 7179 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7176 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
7310 7311 7312 7313 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7310 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.
7402 7403 7404 7405 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7402 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.
7483 7484 7485 7486 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7483 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*.
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7553 7554 7555 7556 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7553 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.
<note markdown=“1”> This operation doesn’t return information about individual assessments. For this information, see the ‘DescribeReplicationTaskIndividualAssessments` operation.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7631 7632 7633 7634 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7631 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.
7694 7695 7696 7697 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7694 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
7821 7822 7823 7824 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7821 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.
7907 7908 7909 7910 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7907 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.
7976 7977 7978 7979 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 7976 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.
8089 8090 8091 8092 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 8089 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.
8162 8163 8164 8165 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 8162 def (params = {}, = {}) req = build_request(:export_metadata_model_assessment, params) req.send_request() end |
#import_certificate(params = {}) ⇒ Types::ImportCertificateResponse
Uploads the specified certificate.
8240 8241 8242 8243 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 8240 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` ][1] data type description.
[1]: docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html
8302 8303 8304 8305 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 8302 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.
8350 8351 8352 8353 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 8350 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.
<note markdown=“1”> You must remove the data provider from all migration projects before you can modify it.
</note>
8565 8566 8567 8568 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 8565 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.
<note markdown=“1”> For a MySQL source or target endpoint, don’t explicitly specify the database using the ‘DatabaseName` request parameter on the `ModifyEndpoint` API call. Specifying `DatabaseName` when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.
</note>
9538 9539 9540 9541 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 9538 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.
9599 9600 9601 9602 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 9599 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.
<note markdown=“1”> All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.
</note>
9694 9695 9696 9697 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 9694 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.
<note markdown=“1”> The migration project must be closed before you can modify it.
</note>
9858 9859 9860 9861 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 9858 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.
9960 9961 9962 9963 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 9960 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.
10208 10209 10210 10211 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10208 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.
10271 10272 10273 10274 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10271 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*.
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html
10425 10426 10427 10428 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10425 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.
10489 10490 10491 10492 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10489 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.
10575 10576 10577 10578 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10575 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.
10632 10633 10634 10635 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10632 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.
10682 10683 10684 10685 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10682 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.
10734 10735 10736 10737 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10734 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` ][1] data type description.
[1]: docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html
10782 10783 10784 10785 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10782 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.
10804 10805 10806 10807 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10804 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.
10849 10850 10851 10852 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10849 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.
10901 10902 10903 10904 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10901 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.
10949 10950 10951 10952 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 10949 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.
11007 11008 11009 11010 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11007 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.
11062 11063 11064 11065 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11062 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.
11124 11125 11126 11127 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11124 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].
[1]: docs.aws.amazon.com/dms/latest/APIReference/API_BatchStartRecommendations.html
11169 11170 11171 11172 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11169 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.
11262 11263 11264 11265 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11262 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 ][1] in the *Database Migration Service User Guide.*
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html
11421 11422 11423 11424 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11421 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*.
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html
11495 11496 11497 11498 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11495 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.
11616 11617 11618 11619 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11616 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.
11680 11681 11682 11683 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11680 def stop_replication(params = {}, = {}) req = build_request(:stop_replication, params) req.send_request() end |
#stop_replication_task(params = {}) ⇒ Types::StopReplicationTaskResponse
Stops the replication task.
11761 11762 11763 11764 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11761 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.
11816 11817 11818 11819 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11816 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*.
[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html#CHAP_Events-migrate-to-eventbridge
11865 11866 11867 11868 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11865 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 |
11982 11983 11984 11985 11986 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11982 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
11990 11991 11992 |
# File 'lib/aws-sdk-databasemigrationservice/client.rb', line 11990 def waiter_names waiters.keys end |