test_migration `async` ¶

test_migration(
    *,
    config_overrides: Optional[AsyncElastiCacheClientConfig] = None,
    replication_group_id: Optional[String] = None,
    customer_node_endpoint_list: Optional[CustomerNodeEndpointList] = None,
) -> TestMigrationResponse

Async API to test connection between source and target replication group.

Parameters:

replication_group_id (Optional[String], default: None ) –

The ID of the replication group to which data is to be migrated.
customer_node_endpoint_list (Optional[CustomerNodeEndpointList], default: None ) –

List of endpoints from which data should be migrated. List should have only one element.

Raises:

InvalidParameterValueException –

The value for a parameter is invalid.
InvalidReplicationGroupStateFault –

The requested replication group is not in the available state.
ReplicationGroupAlreadyUnderMigrationFault –

The targeted replication group is not available.
ReplicationGroupNotFoundFault –

The specified replication group does not exist.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_elasticache/_services/async_elasti_cache.py

async def test_migration(
    self,
    *,
    config_overrides: Optional[AsyncElastiCacheClientConfig] = None,
    replication_group_id: Optional["capo_elasticache.types.string.String"] = None,
    customer_node_endpoint_list: Optional[
        "capo_elasticache.types.customer_node_endpoint_list.CustomerNodeEndpointList"
    ] = None,
) -> "capo_elasticache.types.test_migration_response.TestMigrationResponse":
    """<p> Async API to test connection between source and target replication group. </p>

    Args:
        replication_group_id: <p> The ID of the replication group to which data is to be migrated. </p>
        customer_node_endpoint_list: <p> List of endpoints from which data should be migrated. List should have only one element. </p>

    Raises:
        capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_elasticache.errors.invalid_replication_group_state_fault.InvalidReplicationGroupStateFault: <p>The requested replication group is not in the <code>available</code> state.</p>
        capo_elasticache.errors.replication_group_already_under_migration_fault.ReplicationGroupAlreadyUnderMigrationFault: <p>The targeted replication group is not available. </p>
        capo_elasticache.errors.replication_group_not_found_fault.ReplicationGroupNotFoundFault: <p>The specified replication group does not exist.</p>
        capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_elasticache.types.test_migration_message.TestMigrationMessage]",
    ) -> AsyncOperationResponse[
        "capo_elasticache.types.test_migration_response.TestMigrationResponse"
    ]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.test_migration

        (
            output,
            http_response,
        ) = await capo_elasticache._operations.amazon_elasti_cache_v9.test_migration.async_test_migration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TestMigration")
    )
    input_: capo_elasticache.types.test_migration_message.TestMigrationMessage = {}
    if replication_group_id is not None:
        input_["replication_group_id"] = replication_group_id
    if customer_node_endpoint_list is not None:
        input_["customer_node_endpoint_list"] = customer_node_endpoint_list

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

test_migration async ¶

test_migration `async` ¶