Skip to content

list_dimensions async

list_dimensions(
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListDimensionsResponse

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.

List the set of dimensions that are defined for your Amazon Web Services accounts.

Requires permission to access the ListDimensions action.

Parameters:

  • next_token (Optional[NextToken], default: None ) –

    The token for the next set of results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to retrieve at one time.

Raises:

Source code in docs_src/capo_iot/_services/async_io_t.py
async def list_dimensions(
    self,
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    next_token: Optional["capo_iot.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iot.types.max_results.MaxResults"] = None,
) -> "capo_iot.types.list_dimensions_response.ListDimensionsResponse":
    """<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>List the set of dimensions that are defined for 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">ListDimensions</a> action.</p>

    Args:
        next_token: <p>The token for the next set of results.</p>
        max_results: <p>The maximum number of results to retrieve at one time.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot.types.list_dimensions_request.ListDimensionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot.types.list_dimensions_response.ListDimensionsResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_dimensions

        (
            output,
            http_response,
        ) = await capo_iot._operations.aws_iot_service.list_dimensions.async_list_dimensions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDimensions")
    )
    input_: capo_iot.types.list_dimensions_request.ListDimensionsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output