list_virtual_machines ¶

list_virtual_machines(
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
    hypervisor_arn: Optional[ServerArn] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListVirtualMachinesOutput

Lists your virtual machines.

Parameters:

hypervisor_arn (Optional[ServerArn], default: None ) –

The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
max_results (Optional[MaxResults], default: None ) –

The maximum number of virtual machines to list.
next_token (Optional[NextToken], default: None ) –

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Raises:

InternalServerException –

The operation did not succeed because an internal error occurred. Try again later.
ThrottlingException –

TPS has been limited to protect against intentional or unintentional high request volumes.
ValidationException –

The operation did not succeed because a validation error occurred.
UnknownServiceError –

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

Source code in docs_src/capo_backup_gateway/_services/backup_gateway.py

def list_virtual_machines(
    self,
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
    hypervisor_arn: Optional[
        "capo_backup_gateway.types.server_arn.ServerArn"
    ] = None,
    max_results: Optional[
        "capo_backup_gateway.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_backup_gateway.types.next_token.NextToken"] = None,
) -> "capo_backup_gateway.types.list_virtual_machines_output.ListVirtualMachinesOutput":
    """<p>Lists your virtual machines.</p>

    Args:
        hypervisor_arn: <p>The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.</p>
        max_results: <p>The maximum number of virtual machines to list.</p>
        next_token: <p>The next item following a partial list of returned resources. For example, if a request is made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup_gateway.types.list_virtual_machines_input.ListVirtualMachinesInput]",
    ) -> OperationResponse[
        "capo_backup_gateway.types.list_virtual_machines_output.ListVirtualMachinesOutput"
    ]:
        import capo_backup_gateway._operations.backup_on_premises_v20210101.list_virtual_machines

        output, http_response = (
            capo_backup_gateway._operations.backup_on_premises_v20210101.list_virtual_machines.list_virtual_machines(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVirtualMachines")
    )
    input_: capo_backup_gateway.types.list_virtual_machines_input.ListVirtualMachinesInput = {}
    if hypervisor_arn is not None:
        input_["hypervisor_arn"] = hypervisor_arn
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output