Skip to content

update_dimension

update_dimension(
    name: DimensionName,
    string_values: DimensionStringValues,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> UpdateDimensionResponse

The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

Requires permission to access the UpdateDimension action.

Parameters:

  • name (DimensionName) –

    A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

  • string_values (DimensionStringValues) –

    Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def update_dimension(
    self,
    name: "capo_iot.types.dimension_name.DimensionName",
    string_values: "capo_iot.types.dimension_string_values.DimensionStringValues",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.update_dimension_response.UpdateDimensionResponse":
    """<note> <p>The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.</p> </note> <p>Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateDimension</a> action.</p>

    Args:
        name: <p>A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.</p>
        string_values: <p>Specifies the value or list of values for the dimension. For <code>TOPIC_FILTER</code> dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.update_dimension_request.UpdateDimensionRequest]",
    ) -> OperationResponse[
        "capo_iot.types.update_dimension_response.UpdateDimensionResponse"
    ]:
        import capo_iot._operations.aws_iot_service.update_dimension

        output, http_response = (
            capo_iot._operations.aws_iot_service.update_dimension.update_dimension(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDimension")
    )
    input_: capo_iot.types.update_dimension_request.UpdateDimensionRequest = {
        "name": name,
        "string_values": string_values,
    }

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