libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.DescribeEvents

Description

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

By default, the past hour of events are returned.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEvents Source #

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents' 

Fields

  • startTime :: Maybe ISO8601

    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

  • sourceType :: Maybe SourceType

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

  • filters :: Maybe [Filter]

    This parameter isn't currently supported.

  • sourceIdentifier :: Maybe Text

    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.
    • Can't end with a hyphen or contain two consecutive hyphens.
  • eventCategories :: Maybe [Text]

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

  • marker :: Maybe Text

    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.

  • maxRecords :: Maybe Int

    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.

  • endTime :: Maybe ISO8601

    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

  • duration :: Maybe Int

    The number of minutes to retrieve events for.

    Default: 60

Instances

Instances details
Eq DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Read DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Show DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Generic DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type #

NFData DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Methods

rnf :: DescribeEvents -> () #

Hashable DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

AWSPager DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

AWSRequest DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Associated Types

type AWSResponse DescribeEvents #

ToHeaders DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

ToPath DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

ToQuery DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

type Rep DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

type AWSResponse DescribeEvents Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

newDescribeEvents :: DescribeEvents Source #

Create a value of DescribeEvents with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:startTime:DescribeEvents', describeEvents_startTime - 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

$sel:sourceType:DescribeEvents', describeEvents_sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

$sel:filters:DescribeEvents', describeEvents_filters - This parameter isn't currently supported.

$sel:sourceIdentifier:DescribeEvents', describeEvents_sourceIdentifier - 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.
  • Can't end with a hyphen or contain two consecutive hyphens.

$sel:eventCategories:DescribeEvents', describeEvents_eventCategories - A list of event categories that trigger notifications for a event notification subscription.

$sel:marker:DescribeEvents', describeEvents_marker - 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.

$sel:maxRecords:DescribeEvents', describeEvents_maxRecords - 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.

$sel:endTime:DescribeEvents', describeEvents_endTime - 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

$sel:duration:DescribeEvents', describeEvents_duration - The number of minutes to retrieve events for.

Default: 60

Request Lenses

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

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

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

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

describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source #

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.
  • Can't end with a hyphen or contain two consecutive hyphens.

describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text]) Source #

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

describeEvents_marker :: Lens' DescribeEvents (Maybe Text) Source #

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.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int) Source #

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.

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

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

describeEvents_duration :: Lens' DescribeEvents (Maybe Int) Source #

The number of minutes to retrieve events for.

Default: 60

Destructuring the Response

data DescribeEventsResponse Source #

Contains the result of a successful invocation of the DescribeEvents action.

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse' 

Fields

  • events :: Maybe [Event]

    A list of Event instances.

  • marker :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Read DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Show DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Generic DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type #

NFData DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> () #

type Rep DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeEvents

type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.RDS.DescribeEvents" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Event])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventsResponse Source #

Create a value of DescribeEventsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:events:DescribeEventsResponse', describeEventsResponse_events - A list of Event instances.

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

$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.

Response Lenses

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text) Source #

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