Skip to content

delete_dimension

delete_dimension(
    name: DimensionName, *, config_overrides: Optional[IoTClientConfig] = None
) -> DeleteDimensionResponse

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.

Removes the specified dimension from your Amazon Web Services accounts.

Requires permission to access the DeleteDimension action.

Parameters:

  • name (DimensionName) –

    The unique identifier for the dimension that you want to delete.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def delete_dimension(
    self,
    name: "capo_iot.types.dimension_name.DimensionName",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.delete_dimension_response.DeleteDimensionResponse":
    """<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>Removes the specified dimension from your Amazon Web Services accounts.</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">DeleteDimension</a> action.</p>

    Args:
        name: <p>The unique identifier for the dimension that you want to delete.</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.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.delete_dimension_request.DeleteDimensionRequest]",
    ) -> OperationResponse[
        "capo_iot.types.delete_dimension_response.DeleteDimensionResponse"
    ]:
        import capo_iot._operations.aws_iot_service.delete_dimension

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDimension")
    )
    input_: capo_iot.types.delete_dimension_request.DeleteDimensionRequest = {
        "name": name
    }

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