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.DescribeDBClusterBacktracks

Description

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora MySQL DB clusters.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBClusterBacktracks Source #

See: newDescribeDBClusterBacktracks smart constructor.

Constructors

DescribeDBClusterBacktracks' 

Fields

  • backtrackIdentifier :: Maybe Text

    If specified, this value is the backtrack identifier of the backtrack to be described.

    Constraints:

    Example: 123e4567-e89b-12d3-a456-426655440000

  • filters :: Maybe [Filter]

    A filter that specifies one or more DB clusters to describe. Supported filters include the following:

    • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

    • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

      • applying
      • completed
      • failed
      • pending

      The results list includes information about only the backtracks identified by these values.

  • marker :: Maybe Text

    An optional pagination token provided by a previous DescribeDBClusterBacktracks 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 you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • dbClusterIdentifier :: Text

    The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.
    • First character must be a letter.
    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

Instances

Instances details
Eq DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

(==) :: DescribeDBClusterBacktracks -> DescribeDBClusterBacktracks -> Bool #

(/=) :: DescribeDBClusterBacktracks -> DescribeDBClusterBacktracks -> Bool #

Read DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

readsPrec :: Int -> ReadS DescribeDBClusterBacktracks #

readList :: ReadS [DescribeDBClusterBacktracks] #

readPrec :: ReadPrec DescribeDBClusterBacktracks #

readListPrec :: ReadPrec [DescribeDBClusterBacktracks] #

Show DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

showsPrec :: Int -> DescribeDBClusterBacktracks -> ShowS #

show :: DescribeDBClusterBacktracks -> String #

showList :: [DescribeDBClusterBacktracks] -> ShowS #

Generic DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Associated Types

type Rep DescribeDBClusterBacktracks :: Type -> Type #

Methods

from :: DescribeDBClusterBacktracks -> Rep DescribeDBClusterBacktracks x #

to :: Rep DescribeDBClusterBacktracks x -> DescribeDBClusterBacktracks #

NFData DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

rnf :: DescribeDBClusterBacktracks -> () #

Hashable DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

hashWithSalt :: Int -> DescribeDBClusterBacktracks -> Int #

hash :: DescribeDBClusterBacktracks -> Int #

AWSPager DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

page :: DescribeDBClusterBacktracks -> AWSResponse DescribeDBClusterBacktracks -> Maybe DescribeDBClusterBacktracks #

AWSRequest DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Associated Types

type AWSResponse DescribeDBClusterBacktracks #

Methods

request :: DescribeDBClusterBacktracks -> Request DescribeDBClusterBacktracks #

response :: MonadResource m => Logger -> Service -> Proxy DescribeDBClusterBacktracks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBClusterBacktracks))) #

ToHeaders DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

toHeaders :: DescribeDBClusterBacktracks -> [Header] #

ToPath DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

toPath :: DescribeDBClusterBacktracks -> ByteString #

ToQuery DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

toQuery :: DescribeDBClusterBacktracks -> QueryString #

type Rep DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

type Rep DescribeDBClusterBacktracks = D1 ('MetaData "DescribeDBClusterBacktracks" "Amazonka.RDS.DescribeDBClusterBacktracks" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeDBClusterBacktracks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backtrackIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribeDBClusterBacktracks Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

type AWSResponse DescribeDBClusterBacktracks = DescribeDBClusterBacktracksResponse

newDescribeDBClusterBacktracks Source #

Arguments

:: Text

$sel:dbClusterIdentifier:DescribeDBClusterBacktracks'

-> DescribeDBClusterBacktracks 

Create a value of DescribeDBClusterBacktracks 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:backtrackIdentifier:DescribeDBClusterBacktracks', describeDBClusterBacktracks_backtrackIdentifier - If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

Example: 123e4567-e89b-12d3-a456-426655440000

$sel:filters:DescribeDBClusterBacktracks', describeDBClusterBacktracks_filters - A filter that specifies one or more DB clusters to describe. Supported filters include the following:

  • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

  • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    • applying
    • completed
    • failed
    • pending

    The results list includes information about only the backtracks identified by these values.

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

$sel:maxRecords:DescribeDBClusterBacktracks', describeDBClusterBacktracks_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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

$sel:dbClusterIdentifier:DescribeDBClusterBacktracks', describeDBClusterBacktracks_dbClusterIdentifier - The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • First character must be a letter.
  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Request Lenses

describeDBClusterBacktracks_backtrackIdentifier :: Lens' DescribeDBClusterBacktracks (Maybe Text) Source #

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

Example: 123e4567-e89b-12d3-a456-426655440000

describeDBClusterBacktracks_filters :: Lens' DescribeDBClusterBacktracks (Maybe [Filter]) Source #

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

  • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

  • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    • applying
    • completed
    • failed
    • pending

    The results list includes information about only the backtracks identified by these values.

describeDBClusterBacktracks_marker :: Lens' DescribeDBClusterBacktracks (Maybe Text) Source #

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

describeDBClusterBacktracks_maxRecords :: Lens' DescribeDBClusterBacktracks (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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBClusterBacktracks_dbClusterIdentifier :: Lens' DescribeDBClusterBacktracks Text Source #

The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • First character must be a letter.
  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Destructuring the Response

data DescribeDBClusterBacktracksResponse Source #

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

See: newDescribeDBClusterBacktracksResponse smart constructor.

Constructors

DescribeDBClusterBacktracksResponse' 

Fields

Instances

Instances details
Eq DescribeDBClusterBacktracksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

(==) :: DescribeDBClusterBacktracksResponse -> DescribeDBClusterBacktracksResponse -> Bool #

(/=) :: DescribeDBClusterBacktracksResponse -> DescribeDBClusterBacktracksResponse -> Bool #

Read DescribeDBClusterBacktracksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

readsPrec :: Int -> ReadS DescribeDBClusterBacktracksResponse #

readList :: ReadS [DescribeDBClusterBacktracksResponse] #

readPrec :: ReadPrec DescribeDBClusterBacktracksResponse #

readListPrec :: ReadPrec [DescribeDBClusterBacktracksResponse] #

Show DescribeDBClusterBacktracksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

showsPrec :: Int -> DescribeDBClusterBacktracksResponse -> ShowS #

show :: DescribeDBClusterBacktracksResponse -> String #

showList :: [DescribeDBClusterBacktracksResponse] -> ShowS #

Generic DescribeDBClusterBacktracksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Associated Types

type Rep DescribeDBClusterBacktracksResponse :: Type -> Type #

Methods

from :: DescribeDBClusterBacktracksResponse -> Rep DescribeDBClusterBacktracksResponse x #

to :: Rep DescribeDBClusterBacktracksResponse x -> DescribeDBClusterBacktracksResponse #

NFData DescribeDBClusterBacktracksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

Methods

rnf :: DescribeDBClusterBacktracksResponse -> () #

type Rep DescribeDBClusterBacktracksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterBacktracks

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

newDescribeDBClusterBacktracksResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeDBClusterBacktracksResponse'

-> DescribeDBClusterBacktracksResponse 

Create a value of DescribeDBClusterBacktracksResponse 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:marker:DescribeDBClusterBacktracks', describeDBClusterBacktracksResponse_marker - A pagination token that can be used in a later DescribeDBClusterBacktracks request.

$sel:dbClusterBacktracks:DescribeDBClusterBacktracksResponse', describeDBClusterBacktracksResponse_dbClusterBacktracks - Contains a list of backtracks for the user.

$sel:httpStatus:DescribeDBClusterBacktracksResponse', describeDBClusterBacktracksResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClusterBacktracksResponse_marker :: Lens' DescribeDBClusterBacktracksResponse (Maybe Text) Source #

A pagination token that can be used in a later DescribeDBClusterBacktracks request.

describeDBClusterBacktracksResponse_dbClusterBacktracks :: Lens' DescribeDBClusterBacktracksResponse (Maybe [DBClusterBacktrack]) Source #

Contains a list of backtracks for the user.

describeDBClusterBacktracksResponse_httpStatus :: Lens' DescribeDBClusterBacktracksResponse Int Source #

The response's http status code.