aws_sdk_eventbridge/client/
describe_archive.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeArchive`](crate::operation::describe_archive::builders::DescribeArchiveFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`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>
7    /// - On success, responds with [`DescribeArchiveOutput`](crate::operation::describe_archive::DescribeArchiveOutput) with field(s):
8    ///   - [`archive_arn(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::archive_arn): <p>The ARN of the archive.</p>
9    ///   - [`archive_name(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::archive_name): <p>The name of the archive.</p>
10    ///   - [`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>
11    ///   - [`description(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::description): <p>The description of the archive.</p>
12    ///   - [`event_pattern(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::event_pattern): <p>The event pattern used to filter events sent to the archive.</p>
13    ///   - [`state(Option<ArchiveState>)`](crate::operation::describe_archive::DescribeArchiveOutput::state): <p>The state of the archive.</p>
14    ///   - [`state_reason(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::state_reason): <p>The reason that the archive is in the state.</p>
15    ///   - [`kms_key_identifier(Option<String>)`](crate::operation::describe_archive::DescribeArchiveOutput::kms_key_identifier): <p>The identifier of the KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p>
16    ///   - [`retention_days(Option<i32>)`](crate::operation::describe_archive::DescribeArchiveOutput::retention_days): <p>The number of days to retain events for in the archive.</p>
17    ///   - [`size_bytes(i64)`](crate::operation::describe_archive::DescribeArchiveOutput::size_bytes): <p>The size of the archive in bytes.</p>
18    ///   - [`event_count(i64)`](crate::operation::describe_archive::DescribeArchiveOutput::event_count): <p>The number of events in the archive.</p>
19    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_archive::DescribeArchiveOutput::creation_time): <p>The time at which the archive was created.</p>
20    /// - On failure, responds with [`SdkError<DescribeArchiveError>`](crate::operation::describe_archive::DescribeArchiveError)
21    pub fn describe_archive(&self) -> crate::operation::describe_archive::builders::DescribeArchiveFluentBuilder {
22        crate::operation::describe_archive::builders::DescribeArchiveFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_eventbridge/client/describe_archive.rs

aws_sdk_eventbridge/client/
describe_archive.rs
