Struct aws_sdk_rds::client::fluent_builders::DescribeEvents

pub struct DescribeEvents { /* private fields */ }

Fluent builder constructing a request to DescribeEvents.

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.

By default, RDS returns events that were generated in the past hour.

Implementations

impl DescribeEvents

pub async fn send(
    self
) -> Result<DescribeEventsOutput, SdkError<DescribeEventsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeEventsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn source_identifier(self, input: impl Into<String>) -> Self

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

• If SourceIdentifier is supplied, SourceType must also be provided.

• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

• If the source type is an RDS Proxy, a DBProxyName value must be supplied.

• Can't end with a hyphen or contain two consecutive hyphens.

pub fn set_source_identifier(self, input: Option<String>) -> Self

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

• If SourceIdentifier is supplied, SourceType must also be provided.

• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.

• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

• If the source type is an RDS Proxy, a DBProxyName value must be supplied.

• Can't end with a hyphen or contain two consecutive hyphens.

pub fn source_type(self, input: SourceType) -> Self

The event source to retrieve events for. If no value is specified, all events are returned.

pub fn set_source_type(self, input: Option<SourceType>) -> Self

The event source to retrieve events for. If no value is specified, all events are returned.

pub fn start_time(self, input: DateTime) -> Self

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

pub fn end_time(self, input: DateTime) -> Self

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

pub fn duration(self, input: i32) -> Self

The number of minutes to retrieve events for.

Default: 60

pub fn set_duration(self, input: Option<i32>) -> Self

The number of minutes to retrieve events for.

Default: 60

pub fn event_categories(self, input: impl Into<String>) -> Self

Appends an item to EventCategories.

To override the contents of this collection use set_event_categories.

A list of event categories that trigger notifications for a event notification subscription.

pub fn set_event_categories(self, input: Option<Vec<String>>) -> Self

A list of event categories that trigger notifications for a event notification subscription.

pub fn filters(self, input: Filter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

This parameter isn't currently supported.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

This parameter isn't currently supported.

pub fn max_records(self, input: i32) -> Self

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

pub fn set_max_records(self, input: Option<i32>) -> Self

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

pub fn marker(self, input: impl Into<String>) -> Self

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

pub fn set_marker(self, input: Option<String>) -> Self

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Trait Implementations

impl Clone for DescribeEvents

fn clone(&self) -> DescribeEvents

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeEvents

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.