aws_sdk_eventbridge/client/
list_archives.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 [`ListArchives`](crate::operation::list_archives::builders::ListArchivesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name_prefix(impl Into<String>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::name_prefix) / [`set_name_prefix(Option<String>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::set_name_prefix):<br>required: **false**<br><p>A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.</p><br>
    ///   - [`event_source_arn(impl Into<String>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::event_source_arn) / [`set_event_source_arn(Option<String>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::set_event_source_arn):<br>required: **false**<br><p>The ARN of the event source associated with the archive.</p><br>
    ///   - [`state(ArchiveState)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::state) / [`set_state(Option<ArchiveState>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::set_state):<br>required: **false**<br><p>The state of the archive.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned by a previous call to retrieve the next set of results.</p><br>
    ///   - [`limit(i32)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_archives::builders::ListArchivesFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
    /// - On success, responds with [`ListArchivesOutput`](crate::operation::list_archives::ListArchivesOutput) with field(s):
    ///   - [`archives(Option<Vec::<Archive>>)`](crate::operation::list_archives::ListArchivesOutput::archives): <p>An array of <code>Archive</code> objects that include details about an archive.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_archives::ListArchivesOutput::next_token): <p>The token returned by a previous call to retrieve the next set of results.</p>
    /// - On failure, responds with [`SdkError<ListArchivesError>`](crate::operation::list_archives::ListArchivesError)
    pub fn list_archives(&self) -> crate::operation::list_archives::builders::ListArchivesFluentBuilder {
        crate::operation::list_archives::builders::ListArchivesFluentBuilder::new(self.handle.clone())
    }
}