DatabaseMigrationService / Client / describe_replication_subnet_groups

describe_replication_subnet_groups

DatabaseMigrationService.Client.describe_replication_subnet_groups(**kwargs)

Returns information about the replication subnet groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_subnet_groups(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

• Filters (list) –

  Filters applied to replication subnet groups.

  Valid filter names: replication-subnet-group-id

  • (dict) –

    Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

    • Name (string) – [REQUIRED]

      The name of the filter as specified for a Describe* or similar operation.

    • Values (list) – [REQUIRED]

      The filter value, which can specify one or more values used to narrow the returned results.

      • (string) –

• MaxRecords (integer) –

  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.

• Marker (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'ReplicationSubnetGroups': [
        {
            'ReplicationSubnetGroupIdentifier': 'string',
            'ReplicationSubnetGroupDescription': 'string',
            'VpcId': 'string',
            'SubnetGroupStatus': 'string',
            'Subnets': [
                {
                    'SubnetIdentifier': 'string',
                    'SubnetAvailabilityZone': {
                        'Name': 'string'
                    },
                    'SubnetStatus': 'string'
                },
            ],
            'SupportedNetworkTypes': [
                'string',
            ]
        },
    ]
}

Response Structure

• (dict) –

  • Marker (string) –

    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.

  • ReplicationSubnetGroups (list) –

    A description of the replication subnet groups.

    • (dict) –

      Describes a subnet group in response to a request by the DescribeReplicationSubnetGroups operation.

      • ReplicationSubnetGroupIdentifier (string) –

        The identifier of the replication instance subnet group.

      • ReplicationSubnetGroupDescription (string) –

        A description for the replication subnet group.

      • VpcId (string) –

        The ID of the VPC.

      • SubnetGroupStatus (string) –

        The status of the subnet group.

      • Subnets (list) –

        The subnets that are in the subnet group.

        • (dict) –

          In response to a request by the DescribeReplicationSubnetGroups operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.

          • SubnetIdentifier (string) –

            The subnet identifier.

          • SubnetAvailabilityZone (dict) –

            The Availability Zone of the subnet.

            • Name (string) –

              The name of the Availability Zone.

          • SubnetStatus (string) –

            The status of the subnet.

      • SupportedNetworkTypes (list) –

        The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

        • (string) –

Exceptions

• DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault

Examples

Returns information about the replication subnet groups.

response = client.describe_replication_subnet_groups(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
                'string',
            ],
        },
    ],
    Marker='',
    MaxRecords=123,
)

print(response)

Expected Output:

{
    'Marker': '',
    'ReplicationSubnetGroups': [
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}