Skip to content

start_virtual_machines_metadata_sync async

start_virtual_machines_metadata_sync(
    hypervisor_arn: ServerArn,
    *,
    config_overrides: Optional[AsyncBackupGatewayClientConfig] = None,
) -> StartVirtualMachinesMetadataSyncOutput

This action sends a request to sync metadata across the specified virtual machines.

Parameters:

  • hypervisor_arn (ServerArn) –

    The Amazon Resource Name (ARN) of the hypervisor.

Raises:

Source code in docs_src/capo_backup_gateway/_services/async_backup_gateway.py
async def start_virtual_machines_metadata_sync(
    self,
    hypervisor_arn: "capo_backup_gateway.types.server_arn.ServerArn",
    *,
    config_overrides: Optional[AsyncBackupGatewayClientConfig] = None,
) -> "capo_backup_gateway.types.start_virtual_machines_metadata_sync_output.StartVirtualMachinesMetadataSyncOutput":
    """<p>This action sends a request to sync metadata across the specified virtual machines.</p>

    Args:
        hypervisor_arn: <p>The Amazon Resource Name (ARN) of the hypervisor.</p>

    Raises:
        capo_backup_gateway.errors.internal_server_exception.InternalServerException: <p>The operation did not succeed because an internal error occurred. Try again later.</p>
        capo_backup_gateway.errors.throttling_exception.ThrottlingException: <p>TPS has been limited to protect against intentional or unintentional high request volumes.</p>
        capo_backup_gateway.errors.validation_exception.ValidationException: <p>The operation did not succeed because a validation error occurred.</p>
        capo_backup_gateway.errors.access_denied_exception.AccessDeniedException: <p>The operation cannot proceed because you have insufficient permissions.</p>
        capo_backup_gateway.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action wasn't found.</p>
        capo_backup_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_backup_gateway.types.start_virtual_machines_metadata_sync_input.StartVirtualMachinesMetadataSyncInput]",
    ) -> AsyncOperationResponse[
        "capo_backup_gateway.types.start_virtual_machines_metadata_sync_output.StartVirtualMachinesMetadataSyncOutput"
    ]:
        import capo_backup_gateway._operations.backup_on_premises_v20210101.start_virtual_machines_metadata_sync

        (
            output,
            http_response,
        ) = await capo_backup_gateway._operations.backup_on_premises_v20210101.start_virtual_machines_metadata_sync.async_start_virtual_machines_metadata_sync(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartVirtualMachinesMetadataSync")
    )
    input_: capo_backup_gateway.types.start_virtual_machines_metadata_sync_input.StartVirtualMachinesMetadataSyncInput = {
        "hypervisor_arn": hypervisor_arn
    }

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