DAX / Client / update_subnet_group

update_subnet_group¶

DAX.Client.update_subnet_group(**kwargs)¶

Modifies an existing subnet group.

Request Syntax

response = client.update_subnet_group(
    SubnetGroupName='string',
    Description='string',
    SubnetIds=[
        'string',
    ]
)

Parameters:

SubnetGroupName (string) –
[REQUIRED]

The name of the subnet group.
Description (string) – A description of the subnet group.
SubnetIds (list) –
A list of subnet IDs in the subnet group.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'SubnetGroup': {
        'SubnetGroupName': 'string',
        'Description': 'string',
        'VpcId': 'string',
        'Subnets': [
            {
                'SubnetIdentifier': 'string',
                'SubnetAvailabilityZone': 'string',
                'SupportedNetworkTypes': [
                    'ipv4'|'ipv6'|'dual_stack',
                ]
            },
        ],
        'SupportedNetworkTypes': [
            'ipv4'|'ipv6'|'dual_stack',
        ]
    }
}

Response Structure

(dict) –
- SubnetGroup (dict) –
  
  The subnet group that has been modified.
  - SubnetGroupName (string) –
    
    The name of the subnet group.
  - Description (string) –
    
    The description of the subnet group.
  - VpcId (string) –
    
    The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
  - Subnets (list) –
    
    A list of subnets associated with the subnet group.
    - (dict) –
      
      Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.
      - SubnetIdentifier (string) –
        
        The system-assigned identifier for the subnet.
      - SubnetAvailabilityZone (string) –
        
        The Availability Zone (AZ) for the subnet.
      - SupportedNetworkTypes (list) –
        
        The network types supported by this subnet. Returns an array of strings that can include ipv4, ipv6, or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.
        
        (string) –
  - SupportedNetworkTypes (list) –
    
    The network types supported by this subnet. Returns an array of strings that can include ipv4, ipv6, or both, indicating whether the subnet group supports IPv4 only, IPv6 only, or dual-stack deployments.
    - (string) –

Exceptions

DAX.Client.exceptions.SubnetGroupNotFoundFault
DAX.Client.exceptions.SubnetQuotaExceededFault
DAX.Client.exceptions.SubnetInUse
DAX.Client.exceptions.InvalidSubnet
DAX.Client.exceptions.ServiceLinkedRoleNotFoundFault
DAX.Client.exceptions.SubnetNotAllowedFault