Skip to content

update_wireless_gateway

update_wireless_gateway(
    id: WirelessGatewayId,
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    name: Optional[WirelessGatewayName] = None,
    description: Optional[Description] = None,
    join_eui_filters: Optional[JoinEuiFilters] = None,
    net_id_filters: Optional[NetIdFilters] = None,
    max_eirp: Optional[GatewayMaxEirp] = None,
) -> UpdateWirelessGatewayResponse

Updates properties of a wireless gateway.

Parameters:

Raises:

Source code in docs_src/capo_iot_wireless/_services/io_t_wireless.py
def update_wireless_gateway(
    self,
    id: "capo_iot_wireless.types.wireless_gateway_id.WirelessGatewayId",
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    name: Optional[
        "capo_iot_wireless.types.wireless_gateway_name.WirelessGatewayName"
    ] = None,
    description: Optional["capo_iot_wireless.types.description.Description"] = None,
    join_eui_filters: Optional[
        "capo_iot_wireless.types.join_eui_filters.JoinEuiFilters"
    ] = None,
    net_id_filters: Optional[
        "capo_iot_wireless.types.net_id_filters.NetIdFilters"
    ] = None,
    max_eirp: Optional[
        "capo_iot_wireless.types.gateway_max_eirp.GatewayMaxEirp"
    ] = None,
) -> "capo_iot_wireless.types.update_wireless_gateway_response.UpdateWirelessGatewayResponse":
    """<p>Updates properties of a wireless gateway.</p>

    Args:
        id: <p>The ID of the resource to update.</p>
        name: <p>The new name of the resource.</p> <note> <p>The following special characters aren't accepted: <code><>^#~$</code> </p> </note>
        description: <p>A new description of the resource.</p>
        max_eirp: <p>The MaxEIRP value.</p>

    Raises:
        capo_iot_wireless.errors.access_denied_exception.AccessDeniedException: <p>User does not have permission to perform this action.</p>
        capo_iot_wireless.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request.</p>
        capo_iot_wireless.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource does not exist.</p>
        capo_iot_wireless.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed API request rate.</p>
        capo_iot_wireless.errors.validation_exception.ValidationException: <p>The input did not meet the specified constraints.</p>
        capo_iot_wireless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_wireless.types.update_wireless_gateway_request.UpdateWirelessGatewayRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.update_wireless_gateway_response.UpdateWirelessGatewayResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.update_wireless_gateway

        output, http_response = (
            capo_iot_wireless._operations.iotwireless.update_wireless_gateway.update_wireless_gateway(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWirelessGateway")
    )
    input_: capo_iot_wireless.types.update_wireless_gateway_request.UpdateWirelessGatewayRequest = {
        "id": id
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if join_eui_filters is not None:
        input_["join_eui_filters"] = join_eui_filters
    if net_id_filters is not None:
        input_["net_id_filters"] = net_id_filters
    if max_eirp is not None:
        input_["max_eirp"] = max_eirp

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