Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDS.DescribeSourceRegions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

This operation returns paginated results.

Synopsis

data DescribeSourceRegions = DescribeSourceRegions' {
- regionName :: Maybe Text
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeSourceRegions :: DescribeSourceRegions
describeSourceRegions_regionName :: Lens' DescribeSourceRegions (Maybe Text)
describeSourceRegions_filters :: Lens' DescribeSourceRegions (Maybe [Filter])
describeSourceRegions_marker :: Lens' DescribeSourceRegions (Maybe Text)
describeSourceRegions_maxRecords :: Lens' DescribeSourceRegions (Maybe Int)
data DescribeSourceRegionsResponse = DescribeSourceRegionsResponse' {
- marker :: Maybe Text
- sourceRegions :: Maybe [SourceRegion]
- httpStatus :: Int
}
newDescribeSourceRegionsResponse :: Int -> DescribeSourceRegionsResponse
describeSourceRegionsResponse_marker :: Lens' DescribeSourceRegionsResponse (Maybe Text)
describeSourceRegionsResponse_sourceRegions :: Lens' DescribeSourceRegionsResponse (Maybe [SourceRegion])
describeSourceRegionsResponse_httpStatus :: Lens' DescribeSourceRegionsResponse Int

Creating a Request

data DescribeSourceRegions Source #

See: newDescribeSourceRegions smart constructor.

Constructors

DescribeSourceRegions'

Fields

regionName :: Maybe Text
The source Amazon Web Services Region name. For example, us-east-1.
Constraints:
- Must specify a valid Amazon Web Services Region name.
filters :: Maybe [Filter]
This parameter isn't currently supported.
marker :: 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.
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.

Instances

Instances details

Eq DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods (==) :: DescribeSourceRegions -> DescribeSourceRegions -> Bool # (/=) :: DescribeSourceRegions -> DescribeSourceRegions -> Bool #
Read DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods readsPrec :: Int -> ReadS DescribeSourceRegions # readList :: ReadS [DescribeSourceRegions] # readPrec :: ReadPrec DescribeSourceRegions # readListPrec :: ReadPrec [DescribeSourceRegions] #
Show DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods showsPrec :: Int -> DescribeSourceRegions -> ShowS # show :: DescribeSourceRegions -> String # showList :: [DescribeSourceRegions] -> ShowS #
Generic DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Associated Types type Rep DescribeSourceRegions :: Type -> Type # Methods from :: DescribeSourceRegions -> Rep DescribeSourceRegions x # to :: Rep DescribeSourceRegions x -> DescribeSourceRegions #
NFData DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods rnf :: DescribeSourceRegions -> () #
Hashable DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods hashWithSalt :: Int -> DescribeSourceRegions -> Int # hash :: DescribeSourceRegions -> Int #
AWSPager DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods page :: DescribeSourceRegions -> AWSResponse DescribeSourceRegions -> Maybe DescribeSourceRegions #
AWSRequest DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Associated Types type AWSResponse DescribeSourceRegions # Methods request :: DescribeSourceRegions -> Request DescribeSourceRegions # response :: MonadResource m => Logger -> Service -> Proxy DescribeSourceRegions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSourceRegions))) #
ToHeaders DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods toHeaders :: DescribeSourceRegions -> [Header] #
ToPath DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods toPath :: DescribeSourceRegions -> ByteString #
ToQuery DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods toQuery :: DescribeSourceRegions -> QueryString #
type Rep DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions type Rep DescribeSourceRegions = D1 ('MetaData "DescribeSourceRegions" "Amazonka.RDS.DescribeSourceRegions" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeSourceRegions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "regionName") '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)))))
type AWSResponse DescribeSourceRegions Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions type AWSResponse DescribeSourceRegions = DescribeSourceRegionsResponse

newDescribeSourceRegions :: DescribeSourceRegions Source #

Create a value of DescribeSourceRegions 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:regionName:DescribeSourceRegions', describeSourceRegions_regionName - The source Amazon Web Services Region name. For example, us-east-1.

Constraints:

Must specify a valid Amazon Web Services Region name.

$sel:filters:DescribeSourceRegions', describeSourceRegions_filters - This parameter isn't currently supported.

$sel:marker:DescribeSourceRegions', describeSourceRegions_marker - 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.

$sel:maxRecords:DescribeSourceRegions', describeSourceRegions_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.

Request Lenses

describeSourceRegions_regionName :: Lens' DescribeSourceRegions (Maybe Text) Source #

The source Amazon Web Services Region name. For example, us-east-1.

Constraints:

Must specify a valid Amazon Web Services Region name.

describeSourceRegions_filters :: Lens' DescribeSourceRegions (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeSourceRegions_marker :: Lens' DescribeSourceRegions (Maybe Text) Source #

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.

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

Destructuring the Response

data DescribeSourceRegionsResponse Source #

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

See: newDescribeSourceRegionsResponse smart constructor.

Constructors

DescribeSourceRegionsResponse'

Fields

marker :: 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.
sourceRegions :: Maybe [SourceRegion]
A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeSourceRegionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods (==) :: DescribeSourceRegionsResponse -> DescribeSourceRegionsResponse -> Bool # (/=) :: DescribeSourceRegionsResponse -> DescribeSourceRegionsResponse -> Bool #
Read DescribeSourceRegionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods readsPrec :: Int -> ReadS DescribeSourceRegionsResponse # readList :: ReadS [DescribeSourceRegionsResponse] # readPrec :: ReadPrec DescribeSourceRegionsResponse # readListPrec :: ReadPrec [DescribeSourceRegionsResponse] #
Show DescribeSourceRegionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods showsPrec :: Int -> DescribeSourceRegionsResponse -> ShowS # show :: DescribeSourceRegionsResponse -> String # showList :: [DescribeSourceRegionsResponse] -> ShowS #
Generic DescribeSourceRegionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Associated Types type Rep DescribeSourceRegionsResponse :: Type -> Type # Methods from :: DescribeSourceRegionsResponse -> Rep DescribeSourceRegionsResponse x # to :: Rep DescribeSourceRegionsResponse x -> DescribeSourceRegionsResponse #
NFData DescribeSourceRegionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions Methods rnf :: DescribeSourceRegionsResponse -> () #
type Rep DescribeSourceRegionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeSourceRegions type Rep DescribeSourceRegionsResponse = D1 ('MetaData "DescribeSourceRegionsResponse" "Amazonka.RDS.DescribeSourceRegions" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeSourceRegionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sourceRegions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SourceRegion])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSourceRegionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSourceRegionsResponse'`
-> DescribeSourceRegionsResponse

Create a value of DescribeSourceRegionsResponse 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:DescribeSourceRegions', describeSourceRegionsResponse_marker - 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.

$sel:sourceRegions:DescribeSourceRegionsResponse', describeSourceRegionsResponse_sourceRegions - A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.

$sel:httpStatus:DescribeSourceRegionsResponse', describeSourceRegionsResponse_httpStatus - The response's http status code.

Response Lenses

describeSourceRegionsResponse_marker :: Lens' DescribeSourceRegionsResponse (Maybe Text) Source #

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.

describeSourceRegionsResponse_sourceRegions :: Lens' DescribeSourceRegionsResponse (Maybe [SourceRegion]) Source #

A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.

describeSourceRegionsResponse_httpStatus :: Lens' DescribeSourceRegionsResponse Int Source #

The response's http status code.