DatabaseMigrationService / Client / modify_replication_subnet_group

modify_replication_subnet_group

DatabaseMigrationService.Client.modify_replication_subnet_group(**kwargs)

Modifies the settings for the specified replication subnet group.

See also: AWS API Documentation

Request Syntax

response = client.modify_replication_subnet_group(
    ReplicationSubnetGroupIdentifier='string',
    ReplicationSubnetGroupDescription='string',
    SubnetIds=[
        'string',
    ]
)
Parameters:

  • ReplicationSubnetGroupIdentifier (string) –

    [REQUIRED]

    The name of the replication instance subnet group.

  • ReplicationSubnetGroupDescription (string) – A description for the replication instance subnet group.

  • SubnetIds (list) –

    [REQUIRED]

    A list of subnet IDs.

    • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • ReplicationSubnetGroup (dict) –

      The modified replication subnet group.

      • 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.AccessDeniedFault

  • DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault

  • DatabaseMigrationService.Client.exceptions.ResourceQuotaExceededFault

  • DatabaseMigrationService.Client.exceptions.SubnetAlreadyInUse

  • DatabaseMigrationService.Client.exceptions.ReplicationSubnetGroupDoesNotCoverEnoughAZs

  • DatabaseMigrationService.Client.exceptions.InvalidSubnet

Examples

Modifies the settings for the specified replication subnet group.

response = client.modify_replication_subnet_group(
    ReplicationSubnetGroupDescription='',
    ReplicationSubnetGroupIdentifier='',
    SubnetIds=[
    ],
)

print(response)

Expected Output:

{
    'ReplicationSubnetGroup': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}