- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeReplicationSubnetGroupsCommand
Returns information about the replication subnet groups.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DatabaseMigrationServiceClient, DescribeReplicationSubnetGroupsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import
// const { DatabaseMigrationServiceClient, DescribeReplicationSubnetGroupsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import
const client = new DatabaseMigrationServiceClient(config);
const input = { // DescribeReplicationSubnetGroupsMessage
Filters: [ // FilterList
{ // Filter
Name: "STRING_VALUE", // required
Values: [ // FilterValueList // required
"STRING_VALUE",
],
},
],
MaxRecords: Number("int"),
Marker: "STRING_VALUE",
};
const command = new DescribeReplicationSubnetGroupsCommand(input);
const response = await client.send(command);
// { // DescribeReplicationSubnetGroupsResponse
// Marker: "STRING_VALUE",
// ReplicationSubnetGroups: [ // ReplicationSubnetGroups
// { // ReplicationSubnetGroup
// ReplicationSubnetGroupIdentifier: "STRING_VALUE",
// ReplicationSubnetGroupDescription: "STRING_VALUE",
// VpcId: "STRING_VALUE",
// SubnetGroupStatus: "STRING_VALUE",
// Subnets: [ // SubnetList
// { // Subnet
// SubnetIdentifier: "STRING_VALUE",
// SubnetAvailabilityZone: { // AvailabilityZone
// Name: "STRING_VALUE",
// },
// SubnetStatus: "STRING_VALUE",
// },
// ],
// SupportedNetworkTypes: [ // StringList
// "STRING_VALUE",
// ],
// },
// ],
// };
Example Usage
DescribeReplicationSubnetGroupsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Filters | Filter[] | undefined | Filters applied to replication subnet groups. Valid filter names: replication-subnet-group-id |
Marker | string | undefined | 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 | number | undefined | The maximum number of records to include in the response. If more records exist than the specified Default: 100 Constraints: Minimum 20, maximum 100. |
DescribeReplicationSubnetGroupsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Marker | string | undefined | 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 |
ReplicationSubnetGroups | ReplicationSubnetGroup[] | undefined | A description of the replication subnet groups. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ResourceNotFoundFault | client | The resource could not be found. |
DatabaseMigrationServiceServiceException | Base exception class for all service exceptions from DatabaseMigrationService service. |