list_thing_groups ¶

def list_thing_groups(
    self,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    next_token: Optional["capo_iot.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_iot.types.registry_max_results.RegistryMaxResults"
    ] = None,
    parent_group: Optional["capo_iot.types.thing_group_name.ThingGroupName"] = None,
    name_prefix_filter: Optional[
        "capo_iot.types.thing_group_name.ThingGroupName"
    ] = None,
    recursive: Optional[
        "capo_iot.types.recursive_without_default.RecursiveWithoutDefault"
    ] = None,
) -> "capo_iot.types.list_thing_groups_response.ListThingGroupsResponse":
    """<p>List the thing groups in your account.</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">ListThingGroups</a> action.</p>

    Args:
        next_token: <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
        max_results: <p>The maximum number of results to return at one time.</p>
        parent_group: <p>A filter that limits the results to those with the specified parent group.</p>
        name_prefix_filter: <p>A filter that limits the results to those with the specified name prefix.</p>
        recursive: <p>If true, return child groups as well.</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.list_thing_groups_request.ListThingGroupsRequest]",
    ) -> OperationResponse[
        "capo_iot.types.list_thing_groups_response.ListThingGroupsResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_thing_groups

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListThingGroups")
    )
    input_: capo_iot.types.list_thing_groups_request.ListThingGroupsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if parent_group is not None:
        input_["parent_group"] = parent_group
    if name_prefix_filter is not None:
        input_["name_prefix_filter"] = name_prefix_filter
    if recursive is not None:
        input_["recursive"] = recursive

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