DocDB / Client / modify_db_subnet_group



Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.modify_db_subnet_group(
  • DBSubnetGroupName (string) –


    The name for the subnet group. This value is stored as a lowercase string. You can’t modify the default subnet group.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

  • DBSubnetGroupDescription (string) – The description for the subnet group.

  • SubnetIds (list) –


    The Amazon EC2 subnet IDs for the subnet group.

    • (string) –

Return type:



Response Syntax

    'DBSubnetGroup': {
        'DBSubnetGroupName': 'string',
        'DBSubnetGroupDescription': 'string',
        'VpcId': 'string',
        'SubnetGroupStatus': 'string',
        'Subnets': [
                'SubnetIdentifier': 'string',
                'SubnetAvailabilityZone': {
                    'Name': 'string'
                'SubnetStatus': 'string'
        'DBSubnetGroupArn': 'string'

Response Structure

  • (dict) –

    • DBSubnetGroup (dict) –

      Detailed information about a subnet group.

      • DBSubnetGroupName (string) –

        The name of the subnet group.

      • DBSubnetGroupDescription (string) –

        Provides the description of the subnet group.

      • VpcId (string) –

        Provides the virtual private cloud (VPC) ID of the subnet group.

      • SubnetGroupStatus (string) –

        Provides the status of the subnet group.

      • Subnets (list) –

        Detailed information about one or more subnets within a subnet group.

        • (dict) –

          Detailed information about a subnet.

          • SubnetIdentifier (string) –

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone (dict) –

            Specifies the Availability Zone for the subnet.

            • Name (string) –

              The name of the Availability Zone.

          • SubnetStatus (string) –

            Specifies the status of the subnet.

      • DBSubnetGroupArn (string) –

        The Amazon Resource Name (ARN) for the DB subnet group.


  • DocDB.Client.exceptions.DBSubnetGroupNotFoundFault

  • DocDB.Client.exceptions.DBSubnetQuotaExceededFault

  • DocDB.Client.exceptions.SubnetAlreadyInUse

  • DocDB.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZs

  • DocDB.Client.exceptions.InvalidSubnet