aws_sdk_eventbridge/client/
describe_archive.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeArchive`](crate::operation::describe_archive::builders::DescribeArchiveFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`archive_name(impl Into<String>)`](crate::operation::describe_archive::builders::DescribeArchiveFluentBuilder::archive_name) / [`set_archive_name(Option<String>)`](crate::operation::describe_archive::builders::DescribeArchiveFluentBuilder::set_archive_name):<br>required: **true**<br><p>The name of the archive to retrieve.</p><br>
    /// - On success, responds with [`DescribeArchiveOutput`](crate::operation::describe_archive::DescribeArchiveOutput) with field(s):
    ///   - [`archive_arn(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::archive_arn): <p>The ARN of the archive.</p>
    ///   - [`archive_name(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::archive_name): <p>The name of the archive.</p>
    ///   - [`event_source_arn(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::event_source_arn): <p>The ARN of the event source associated with the archive.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::description): <p>The description of the archive.</p>
    ///   - [`event_pattern(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::event_pattern): <p>The event pattern used to filter events sent to the archive.</p>
    ///   - [`state(Option<ArchiveState>)`](crate::operation::describe_archive::DescribeArchiveOutput::state): <p>The state of the archive.</p>
    ///   - [`state_reason(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::state_reason): <p>The reason that the archive is in the state.</p>
    ///   - [`retention_days(Option<i32>)`](crate::operation::describe_archive::DescribeArchiveOutput::retention_days): <p>The number of days to retain events for in the archive.</p>
    ///   - [`size_bytes(i64)`](crate::operation::describe_archive::DescribeArchiveOutput::size_bytes): <p>The size of the archive in bytes.</p>
    ///   - [`event_count(i64)`](crate::operation::describe_archive::DescribeArchiveOutput::event_count): <p>The number of events in the archive.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_archive::DescribeArchiveOutput::creation_time): <p>The time at which the archive was created.</p>
    /// - On failure, responds with [`SdkError<DescribeArchiveError>`](crate::operation::describe_archive::DescribeArchiveError)
    pub fn describe_archive(&self) -> crate::operation::describe_archive::builders::DescribeArchiveFluentBuilder {
        crate::operation::describe_archive::builders::DescribeArchiveFluentBuilder::new(self.handle.clone())
    }
}