aws_sdk_transfer/client/
list_file_transfer_results.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListFileTransferResults`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`connector_id(impl Into<String>)`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::connector_id) / [`set_connector_id(Option<String>)`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::set_connector_id):<br>required: **true**<br><p>A unique identifier for a connector. This value should match the value supplied to the corresponding <code>StartFileTransfer</code> call.</p><br>
    ///   - [`transfer_id(impl Into<String>)`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::transfer_id) / [`set_transfer_id(Option<String>)`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::set_transfer_id):<br>required: **true**<br><p>A unique identifier for a file transfer. This value should match the value supplied to the corresponding <code>StartFileTransfer</code> call.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
    ///   - [`max_results(i32)`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::set_max_results):<br>required: **false**<br><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><br>
    /// - On success, responds with [`ListFileTransferResultsOutput`](crate::operation::list_file_transfer_results::ListFileTransferResultsOutput) with field(s):
    ///   - [`file_transfer_results(Vec::<ConnectorFileTransferResult>)`](crate::operation::list_file_transfer_results::ListFileTransferResultsOutput::file_transfer_results): <p>Returns the details for the files transferred in the transfer identified by the <code>TransferId</code> and <code>ConnectorId</code> specified.</p> <ul>  <li>   <p><code>FilePath</code>: the filename and path to where the file was sent to or retrieved from.</p></li>  <li>   <p><code>StatusCode</code>: current status for the transfer. The status returned is one of the following values:<code>QUEUED</code>, <code>IN_PROGRESS</code>, <code>COMPLETED</code>, or <code>FAILED</code></p></li>  <li>   <p><code>FailureCode</code>: for transfers that fail, this parameter contains a code indicating the reason. For example, <code>RETRIEVE_FILE_NOT_FOUND</code></p></li>  <li>   <p><code>FailureMessage</code>: for transfers that fail, this parameter describes the reason for the failure.</p></li> </ul>
    ///   - [`next_token(Option<String>)`](crate::operation::list_file_transfer_results::ListFileTransferResultsOutput::next_token): <p>Returns a token that you can use to call <code>ListFileTransferResults</code> again and receive additional results, if there are any (against the same <code>TransferId</code>.</p>
    /// - On failure, responds with [`SdkError<ListFileTransferResultsError>`](crate::operation::list_file_transfer_results::ListFileTransferResultsError)
    pub fn list_file_transfer_results(&self) -> crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder {
        crate::operation::list_file_transfer_results::builders::ListFileTransferResultsFluentBuilder::new(self.handle.clone())
    }
}