describe_source_regions¶
Operation¶
describe_source_regions
async
¶
describe_source_regions(request: DescribeSourceRegionsInput | DescribeSourceRegionsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeSourceRegionsOutput
describe_source_regions(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeSourceRegionsInputDict]) -> DescribeSourceRegionsOutput
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.
Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.
To return information about the Regions that are enabled for your
account, or all Regions, use the EC2 operation DescribeRegions. For
more information, see
DescribeRegions
in the Amazon EC2 API Reference.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeSourceRegionsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeSourceRegionsInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
filters
class-attribute
instance-attribute
¶
This parameter isn't currently supported.
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
max_records
class-attribute
instance-attribute
¶
max_records: int | None = ...
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.
Dictionaries¶
DescribeSourceRegionsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeSourceRegionsInput.
Attributes¶
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
This parameter isn't currently supported.
marker
instance-attribute
¶
marker: str | None
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.
max_records
instance-attribute
¶
max_records: int | None
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.
Output¶
DescribeSourceRegionsOutput
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
DescribeSourceRegions action.
Attributes¶
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
source_regions
class-attribute
instance-attribute
¶
source_regions: list[SourceRegion] | None = ...
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.