Network.AWS.RDS.DescribeSourceRegions

Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.

Creating a Request

describeSourceRegions :: DescribeSourceRegions

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

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

• dsrRegionName - The source AWS Region name. For example, us-east-1 . Constraints: * Must specify a valid AWS Region name.
• dsrFilters - This parameter is not currently supported.
• dsrMarker - An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
• dsrMaxRecords - 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.

data DescribeSourceRegions

See: describeSourceRegions smart constructor.

Instances

Eq DescribeSourceRegions

Methods

(==) :: DescribeSourceRegions -> DescribeSourceRegions -> Bool

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

Data DescribeSourceRegions

Methods

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

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

toConstr :: DescribeSourceRegions -> Constr

dataTypeOf :: DescribeSourceRegions -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeSourceRegions

Methods

readsPrec :: Int -> ReadS DescribeSourceRegions

readList :: ReadS [DescribeSourceRegions]

readPrec :: ReadPrec DescribeSourceRegions

readListPrec :: ReadPrec [DescribeSourceRegions]

Show DescribeSourceRegions

Methods

showsPrec :: Int -> DescribeSourceRegions -> ShowS

show :: DescribeSourceRegions -> String

showList :: [DescribeSourceRegions] -> ShowS

Generic DescribeSourceRegions

Associated Types

type Rep DescribeSourceRegions :: * -> *

Methods

from :: DescribeSourceRegions -> Rep DescribeSourceRegions x

to :: Rep DescribeSourceRegions x -> DescribeSourceRegions

Hashable DescribeSourceRegions

Methods

hashWithSalt :: Int -> DescribeSourceRegions -> Int

hash :: DescribeSourceRegions -> Int

NFData DescribeSourceRegions

Methods

rnf :: DescribeSourceRegions -> ()

AWSRequest DescribeSourceRegions

Associated Types

type Rs DescribeSourceRegions :: *

Methods

request :: DescribeSourceRegions -> Request DescribeSourceRegions

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

ToHeaders DescribeSourceRegions

Methods

toHeaders :: DescribeSourceRegions -> [Header]

ToPath DescribeSourceRegions

Methods

toPath :: DescribeSourceRegions -> ByteString

ToQuery DescribeSourceRegions

Methods

toQuery :: DescribeSourceRegions -> QueryString

type Rep DescribeSourceRegions

type Rep DescribeSourceRegions = D1 * (MetaData "DescribeSourceRegions" "Network.AWS.RDS.DescribeSourceRegions" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeSourceRegions'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dsrRegionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dsrFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsrMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dsrMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))

type Rs DescribeSourceRegions

type Rs DescribeSourceRegions = DescribeSourceRegionsResponse

Request Lenses

dsrRegionName :: Lens' DescribeSourceRegions (Maybe Text)

The source AWS Region name. For example, us-east-1 . Constraints: * Must specify a valid AWS Region name.

dsrFilters :: Lens' DescribeSourceRegions [Filter]

This parameter is not currently supported.

dsrMarker :: Lens' DescribeSourceRegions (Maybe Text)

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

dsrMaxRecords :: Lens' DescribeSourceRegions (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.

Destructuring the Response

describeSourceRegionsResponse

Arguments

:: Int

dsrrsResponseStatus

-> DescribeSourceRegionsResponse

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

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

• dsrrsMarker - 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 .
• dsrrsSourceRegions - A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.
• dsrrsResponseStatus - -- | The response status code.

data DescribeSourceRegionsResponse

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

See: describeSourceRegionsResponse smart constructor.

Instances

Eq DescribeSourceRegionsResponse

Methods

(==) :: DescribeSourceRegionsResponse -> DescribeSourceRegionsResponse -> Bool

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

Data DescribeSourceRegionsResponse

Methods

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

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

toConstr :: DescribeSourceRegionsResponse -> Constr

dataTypeOf :: DescribeSourceRegionsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeSourceRegionsResponse

Methods

readsPrec :: Int -> ReadS DescribeSourceRegionsResponse

readList :: ReadS [DescribeSourceRegionsResponse]

readPrec :: ReadPrec DescribeSourceRegionsResponse

readListPrec :: ReadPrec [DescribeSourceRegionsResponse]

Show DescribeSourceRegionsResponse

Methods

showsPrec :: Int -> DescribeSourceRegionsResponse -> ShowS

show :: DescribeSourceRegionsResponse -> String

showList :: [DescribeSourceRegionsResponse] -> ShowS

Generic DescribeSourceRegionsResponse

Associated Types

type Rep DescribeSourceRegionsResponse :: * -> *

Methods

from :: DescribeSourceRegionsResponse -> Rep DescribeSourceRegionsResponse x

to :: Rep DescribeSourceRegionsResponse x -> DescribeSourceRegionsResponse

NFData DescribeSourceRegionsResponse

Methods

rnf :: DescribeSourceRegionsResponse -> ()

type Rep DescribeSourceRegionsResponse

type Rep DescribeSourceRegionsResponse = D1 * (MetaData "DescribeSourceRegionsResponse" "Network.AWS.RDS.DescribeSourceRegions" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeSourceRegionsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsrrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsrrsSourceRegions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [SourceRegion]))) (S1 * (MetaSel (Just Symbol "_dsrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dsrrsMarker :: Lens' DescribeSourceRegionsResponse (Maybe Text)

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 .

dsrrsSourceRegions :: Lens' DescribeSourceRegionsResponse [SourceRegion]

A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.

dsrrsResponseStatus :: Lens' DescribeSourceRegionsResponse Int

• - | The response status code.