Skip to content

list_things_in_thing_group async

list_things_in_thing_group(
    thing_group_name: ThingGroupName,
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    recursive: Optional[Recursive] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[RegistryMaxResults] = None,
) -> ListThingsInThingGroupResponse

Lists the things in the specified group.

Requires permission to access the ListThingsInThingGroup action.

Parameters:

  • thing_group_name (ThingGroupName) –

    The thing group name.

  • recursive (Optional[Recursive], default: None ) –

    When true, list things in this thing group and in all child groups as well.

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

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

    The maximum number of results to return at one time.

Raises:

Source code in docs_src/capo_iot/_services/async_io_t.py
async def list_things_in_thing_group(
    self,
    thing_group_name: "capo_iot.types.thing_group_name.ThingGroupName",
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    recursive: Optional["capo_iot.types.recursive.Recursive"] = None,
    next_token: Optional["capo_iot.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_iot.types.registry_max_results.RegistryMaxResults"
    ] = None,
) -> "capo_iot.types.list_things_in_thing_group_response.ListThingsInThingGroupResponse":
    """<p>Lists the things in the specified group.</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">ListThingsInThingGroup</a> action.</p>

    Args:
        thing_group_name: <p>The thing group name.</p>
        recursive: <p>When true, list things in this thing group and in all child groups as well.</p>
        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>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot.types.list_things_in_thing_group_request.ListThingsInThingGroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot.types.list_things_in_thing_group_response.ListThingsInThingGroupResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_things_in_thing_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListThingsInThingGroup")
    )
    input_: capo_iot.types.list_things_in_thing_group_request.ListThingsInThingGroupRequest = {
        "thing_group_name": thing_group_name
    }
    if recursive is not None:
        input_["recursive"] = recursive
    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