Skip to content

update_subnet_group

update_subnet_group(
    subnet_group_name: String,
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
    description: Optional[String] = None,
    subnet_ids: Optional[SubnetIdentifierList] = None,
) -> UpdateSubnetGroupResponse

Updates a subnet group. For more information, see Updating a subnet group

Parameters:

  • subnet_group_name (String) –

    The name of the subnet group

  • description (Optional[String], default: None ) –

    A description of the subnet group

  • subnet_ids (Optional[SubnetIdentifierList], default: None ) –

    The EC2 subnet IDs for the subnet group.

Raises:

Source code in docs_src/capo_memorydb/_services/memory_db.py
def update_subnet_group(
    self,
    subnet_group_name: "capo_memorydb.types.string.String",
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
    description: Optional["capo_memorydb.types.string.String"] = None,
    subnet_ids: Optional[
        "capo_memorydb.types.subnet_identifier_list.SubnetIdentifierList"
    ] = None,
) -> "capo_memorydb.types.update_subnet_group_response.UpdateSubnetGroupResponse":
    """<p>Updates a subnet group. For more information, see <a href="https://docs.aws.amazon.com/MemoryDB/latest/devguide/ubnetGroups.Modifying.html">Updating a subnet group</a> </p>

    Args:
        subnet_group_name: <p>The name of the subnet group</p>
        description: <p>A description of the subnet group</p>
        subnet_ids: <p>The EC2 subnet IDs for the subnet group.</p>

    Raises:
        capo_memorydb.errors.invalid_subnet.InvalidSubnet: <p>The specified subnet is not valid.</p>
        capo_memorydb.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The required service-linked role was not found.</p>
        capo_memorydb.errors.subnet_group_not_found_fault.SubnetGroupNotFoundFault: <p>The specified subnet group does not exist.</p>
        capo_memorydb.errors.subnet_in_use.SubnetInUse: <p>The subnet is currently in use and cannot be deleted.</p>
        capo_memorydb.errors.subnet_not_allowed_fault.SubnetNotAllowedFault: <p>The specified subnet is not allowed for this operation.</p>
        capo_memorydb.errors.subnet_quota_exceeded_fault.SubnetQuotaExceededFault: <p>The request cannot be processed because it would exceed the maximum number of subnets allowed.</p>
        capo_memorydb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_memorydb.types.update_subnet_group_request.UpdateSubnetGroupRequest]",
    ) -> OperationResponse[
        "capo_memorydb.types.update_subnet_group_response.UpdateSubnetGroupResponse"
    ]:
        import capo_memorydb._operations.amazon_memory_db.update_subnet_group

        output, http_response = (
            capo_memorydb._operations.amazon_memory_db.update_subnet_group.update_subnet_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSubnetGroup")
    )
    input_: capo_memorydb.types.update_subnet_group_request.UpdateSubnetGroupRequest = {
        "subnet_group_name": subnet_group_name
    }
    if description is not None:
        input_["description"] = description
    if subnet_ids is not None:
        input_["subnet_ids"] = subnet_ids

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output