Network.AWS.RDS.DescribeDBClusterBacktracks

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Creating a Request

describeDBClusterBacktracks

Arguments

:: Text

ddcbDBClusterIdentifier

-> DescribeDBClusterBacktracks

Creates a value of DescribeDBClusterBacktracks with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddcbBacktrackIdentifier - If specified, this value is the backtrack identifier of the backtrack to be described. Constraints: * Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace . Example: 123e4567-e89b-12d3-a456-426655440000
• ddcbFilters - 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. For more information about backtrack status values, see DBClusterBacktrack .
• ddcbMarker - 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 .
• ddcbMaxRecords - 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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
• ddcbDBClusterIdentifier - 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. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1

data DescribeDBClusterBacktracks

See: describeDBClusterBacktracks smart constructor.

Instances

Eq DescribeDBClusterBacktracks

Methods

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

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

Data DescribeDBClusterBacktracks

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDBClusterBacktracks -> c DescribeDBClusterBacktracks

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDBClusterBacktracks

toConstr :: DescribeDBClusterBacktracks -> Constr

dataTypeOf :: DescribeDBClusterBacktracks -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDBClusterBacktracks)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDBClusterBacktracks)

gmapT :: (forall b. Data b => b -> b) -> DescribeDBClusterBacktracks -> DescribeDBClusterBacktracks

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusterBacktracks -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusterBacktracks -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeDBClusterBacktracks -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDBClusterBacktracks -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDBClusterBacktracks -> m DescribeDBClusterBacktracks

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusterBacktracks -> m DescribeDBClusterBacktracks

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusterBacktracks -> m DescribeDBClusterBacktracks

Read DescribeDBClusterBacktracks

Methods

readsPrec :: Int -> ReadS DescribeDBClusterBacktracks

readList :: ReadS [DescribeDBClusterBacktracks]

readPrec :: ReadPrec DescribeDBClusterBacktracks

readListPrec :: ReadPrec [DescribeDBClusterBacktracks]

Show DescribeDBClusterBacktracks

Methods

showsPrec :: Int -> DescribeDBClusterBacktracks -> ShowS

show :: DescribeDBClusterBacktracks -> String

showList :: [DescribeDBClusterBacktracks] -> ShowS

Generic DescribeDBClusterBacktracks

Associated Types

type Rep DescribeDBClusterBacktracks :: * -> *

Methods

from :: DescribeDBClusterBacktracks -> Rep DescribeDBClusterBacktracks x

to :: Rep DescribeDBClusterBacktracks x -> DescribeDBClusterBacktracks

Hashable DescribeDBClusterBacktracks

Methods

hashWithSalt :: Int -> DescribeDBClusterBacktracks -> Int

hash :: DescribeDBClusterBacktracks -> Int

NFData DescribeDBClusterBacktracks

Methods

rnf :: DescribeDBClusterBacktracks -> ()

AWSRequest DescribeDBClusterBacktracks

Associated Types

type Rs DescribeDBClusterBacktracks :: *

Methods

request :: DescribeDBClusterBacktracks -> Request DescribeDBClusterBacktracks

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeDBClusterBacktracks -> ClientResponse -> m (Response DescribeDBClusterBacktracks)

ToHeaders DescribeDBClusterBacktracks

Methods

toHeaders :: DescribeDBClusterBacktracks -> [Header]

ToPath DescribeDBClusterBacktracks

Methods

toPath :: DescribeDBClusterBacktracks -> ByteString

ToQuery DescribeDBClusterBacktracks

Methods

toQuery :: DescribeDBClusterBacktracks -> QueryString

type Rep DescribeDBClusterBacktracks

type Rep DescribeDBClusterBacktracks = D1 * (MetaData "DescribeDBClusterBacktracks" "Network.AWS.RDS.DescribeDBClusterBacktracks" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeDBClusterBacktracks'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ddcbBacktrackIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ddcbFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ddcbMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ddcbMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_ddcbDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs DescribeDBClusterBacktracks

type Rs DescribeDBClusterBacktracks = DescribeDBClusterBacktracksResponse

Request Lenses

ddcbBacktrackIdentifier :: Lens' DescribeDBClusterBacktracks (Maybe Text)

If specified, this value is the backtrack identifier of the backtrack to be described. Constraints: * Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace . Example: 123e4567-e89b-12d3-a456-426655440000

ddcbFilters :: Lens' DescribeDBClusterBacktracks [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. For more information about backtrack status values, see DBClusterBacktrack .

ddcbMarker :: Lens' DescribeDBClusterBacktracks (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 .

ddcbMaxRecords :: Lens' DescribeDBClusterBacktracks (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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.

ddcbDBClusterIdentifier :: Lens' DescribeDBClusterBacktracks 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. * Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster1

Destructuring the Response

describeDBClusterBacktracksResponse

Arguments

:: Int

ddcbrsResponseStatus

-> DescribeDBClusterBacktracksResponse

Creates a value of DescribeDBClusterBacktracksResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddcbrsMarker - A pagination token that can be used in a subsequent DescribeDBClusterBacktracks request.
• ddcbrsDBClusterBacktracks - Contains a list of backtracks for the user.
• ddcbrsResponseStatus - -- | The response status code.

data DescribeDBClusterBacktracksResponse

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

See: describeDBClusterBacktracksResponse smart constructor.

Instances

Eq DescribeDBClusterBacktracksResponse

Methods

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

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

Data DescribeDBClusterBacktracksResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDBClusterBacktracksResponse -> c DescribeDBClusterBacktracksResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDBClusterBacktracksResponse

toConstr :: DescribeDBClusterBacktracksResponse -> Constr

dataTypeOf :: DescribeDBClusterBacktracksResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDBClusterBacktracksResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDBClusterBacktracksResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeDBClusterBacktracksResponse -> DescribeDBClusterBacktracksResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusterBacktracksResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBClusterBacktracksResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeDBClusterBacktracksResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDBClusterBacktracksResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDBClusterBacktracksResponse -> m DescribeDBClusterBacktracksResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusterBacktracksResponse -> m DescribeDBClusterBacktracksResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBClusterBacktracksResponse -> m DescribeDBClusterBacktracksResponse

Read DescribeDBClusterBacktracksResponse

Methods

readsPrec :: Int -> ReadS DescribeDBClusterBacktracksResponse

readList :: ReadS [DescribeDBClusterBacktracksResponse]

readPrec :: ReadPrec DescribeDBClusterBacktracksResponse

readListPrec :: ReadPrec [DescribeDBClusterBacktracksResponse]

Show DescribeDBClusterBacktracksResponse

Methods

showsPrec :: Int -> DescribeDBClusterBacktracksResponse -> ShowS

show :: DescribeDBClusterBacktracksResponse -> String

showList :: [DescribeDBClusterBacktracksResponse] -> ShowS

Generic DescribeDBClusterBacktracksResponse

Associated Types

type Rep DescribeDBClusterBacktracksResponse :: * -> *

Methods

from :: DescribeDBClusterBacktracksResponse -> Rep DescribeDBClusterBacktracksResponse x

to :: Rep DescribeDBClusterBacktracksResponse x -> DescribeDBClusterBacktracksResponse

NFData DescribeDBClusterBacktracksResponse

Methods

rnf :: DescribeDBClusterBacktracksResponse -> ()

type Rep DescribeDBClusterBacktracksResponse

type Rep DescribeDBClusterBacktracksResponse = D1 * (MetaData "DescribeDBClusterBacktracksResponse" "Network.AWS.RDS.DescribeDBClusterBacktracks" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeDBClusterBacktracksResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ddcbrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ddcbrsDBClusterBacktracks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [DBClusterBacktrack]))) (S1 * (MetaSel (Just Symbol "_ddcbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

ddcbrsMarker :: Lens' DescribeDBClusterBacktracksResponse (Maybe Text)

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

ddcbrsDBClusterBacktracks :: Lens' DescribeDBClusterBacktracksResponse [DBClusterBacktrack]

Contains a list of backtracks for the user.

ddcbrsResponseStatus :: Lens' DescribeDBClusterBacktracksResponse Int

• - | The response status code.