list_file_transfer_results ¶

def list_file_transfer_results(
    self,
    connector_id: "capo_transfer.types.connector_id.ConnectorId",
    transfer_id: "capo_transfer.types.transfer_id.TransferId",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
    next_token: Optional["capo_transfer.types.next_token.NextToken"] = None,
    max_results: Optional["capo_transfer.types.max_results.MaxResults"] = None,
) -> "capo_transfer.types.list_file_transfer_results_response.ListFileTransferResultsResponse":
    """<p> Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its <code>ConnectorId</code> and its <code>TransferId</code>.</p> <note> <p>File transfer results are available up to 7 days after an operation has been requested.</p> </note>

    Args:
        connector_id: <p>A unique identifier for a connector. This value should match the value supplied to the corresponding <code>StartFileTransfer</code> call.</p>
        transfer_id: <p>A unique identifier for a file transfer. This value should match the value supplied to the corresponding <code>StartFileTransfer</code> call.</p>
        next_token: <p>If there are more file details than returned in this call, use this value for a subsequent call to <code>ListFileTransferResults</code> to retrieve them.</p>
        max_results: <p>The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single <a href="https://docs.aws.amazon.com/transfer/latest/APIReference/API_StartFileTransfer.html">StartFileTransfer</a> operation. Thus, the maximum number of file transfer results that can be returned in a single page is 10. </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_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</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_file_transfer_results_request.ListFileTransferResultsRequest]",
    ) -> OperationResponse[
        "capo_transfer.types.list_file_transfer_results_response.ListFileTransferResultsResponse"
    ]:
        import capo_transfer._operations.transfer_service.list_file_transfer_results

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFileTransferResults")
    )
    input_: capo_transfer.types.list_file_transfer_results_request.ListFileTransferResultsRequest = {
        "connector_id": connector_id,
        "transfer_id": transfer_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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