Struct aws_sdk_docdb::client::fluent_builders::DescribeEvents

pub struct DescribeEvents<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeEvents.

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

Implementations

impl<C, M, R> DescribeEvents<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeEventsOutput, SdkError<DescribeEventsError>> where
    R::Policy: SmithyRetryPolicy<DescribeEventsInputOperationOutputAlias, DescribeEventsOutput, DescribeEventsError, DescribeEventsInputOperationRetryAlias>, 

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<C, M, R>

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 provided, SourceType must also be provided.

• If the source type is DBInstance, a DBInstanceIdentifier must be provided.

• If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

• If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

• If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

• Cannot 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 provided, SourceType must also be provided.

• If the source type is DBInstance, a DBInstanceIdentifier must be provided.

• If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

• If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

• If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

• Cannot 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.

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.

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.

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.

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 an event notification subscription.

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

A list of event categories that trigger notifications for an 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 is not currently supported.

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

This parameter is not 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 (marker) is included in the response so that the remaining results can be retrieved.

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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

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

An optional pagination token provided by a previous 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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DescribeEvents<C, M, R>

fn clone(&self) -> DescribeEvents<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeEvents<C, M, R>

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

Formats the value using the given formatter.