aws_sdk_transfer/client/
start_directory_listing.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartDirectoryListing`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`connector_id(impl Into<String>)`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::connector_id) / [`set_connector_id(Option<String>)`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::set_connector_id):<br>required: **true**<br><p>The unique identifier for the connector.</p><br>
    ///   - [`remote_directory_path(impl Into<String>)`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::remote_directory_path) / [`set_remote_directory_path(Option<String>)`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::set_remote_directory_path):<br>required: **true**<br><p>Specifies the directory on the remote SFTP server for which you want to list its contents.</p><br>
    ///   - [`max_items(i32)`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::max_items) / [`set_max_items(Option<i32>)`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::set_max_items):<br>required: **false**<br><p>An optional parameter where you can specify the maximum number of file/directory names to retrieve. The default value is 1,000.</p><br>
    ///   - [`output_directory_path(impl Into<String>)`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::output_directory_path) / [`set_output_directory_path(Option<String>)`](crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::set_output_directory_path):<br>required: **true**<br><p>Specifies the path (bucket and prefix) in Amazon S3 storage to store the results of the directory listing.</p><br>
    /// - On success, responds with [`StartDirectoryListingOutput`](crate::operation::start_directory_listing::StartDirectoryListingOutput) with field(s):
    ///   - [`listing_id(String)`](crate::operation::start_directory_listing::StartDirectoryListingOutput::listing_id): <p>Returns a unique identifier for the directory listing call.</p>
    ///   - [`output_file_name(String)`](crate::operation::start_directory_listing::StartDirectoryListingOutput::output_file_name): <p>Returns the file name where the results are stored. This is a combination of the connector ID and the listing ID: <code>&lt;connector-id&gt;-&lt;listing-id&gt;.json</code>.</p>
    /// - On failure, responds with [`SdkError<StartDirectoryListingError>`](crate::operation::start_directory_listing::StartDirectoryListingError)
    pub fn start_directory_listing(&self) -> crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder {
        crate::operation::start_directory_listing::builders::StartDirectoryListingFluentBuilder::new(self.handle.clone())
    }
}