list_servers ¶

list_servers(
    *,
    config_overrides: Optional[TransferClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListServersResponse

Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.

Parameters:

max_results (Optional[MaxResults], default: None ) –

Specifies the number of servers to return as a response to the ListServers query.
next_token (Optional[NextToken], default: None ) –

When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

Raises:

InternalServiceError –

This exception is thrown when an error occurs in the Transfer Family service.
InvalidNextTokenException –

The NextToken parameter that was passed is invalid.
InvalidRequestException –

This exception is thrown when the client submits a malformed request.
ServiceUnavailableException –

The request has failed because the Amazon Web ServicesTransfer Family service is not available.
UnknownServiceError –

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

Source code in docs_src/capo_transfer/_services/transfer.py

def list_servers(
    self,
    *,
    config_overrides: Optional[TransferClientConfig] = None,
    max_results: Optional["capo_transfer.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_transfer.types.next_token.NextToken"] = None,
) -> "capo_transfer.types.list_servers_response.ListServersResponse":
    """<p>Lists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.</p>

    Args:
        max_results: <p>Specifies the number of servers to return as a response to the <code>ListServers</code> query.</p>
        next_token: <p>When additional results are obtained from the <code>ListServers</code> command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional servers.</p>

    Raises:
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transfer.types.list_servers_request.ListServersRequest]",
    ) -> OperationResponse[
        "capo_transfer.types.list_servers_response.ListServersResponse"
    ]:
        import capo_transfer._operations.transfer_service.list_servers

        output, http_response = (
            capo_transfer._operations.transfer_service.list_servers.list_servers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListServers")
    )
    input_: capo_transfer.types.list_servers_request.ListServersRequest = {}
    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