Skip to content

list_principal_things_v2 async

list_principal_things_v2(
    principal: Principal,
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[RegistryMaxResults] = None,
    thing_principal_type: Optional[ThingPrincipalType] = None,
) -> ListPrincipalThingsV2Response

Lists the things associated with the specified principal. A principal can be an X.509 certificate or an Amazon Cognito ID.

Requires permission to access the ListPrincipalThings action.

Parameters:

  • 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 in this operation.

  • principal (Principal) –

    The principal. A principal can be an X.509 certificate or an Amazon Cognito ID.

  • thing_principal_type (Optional[ThingPrincipalType], default: None ) –

    The type of the relation you want to filter in the response. If no value is provided in this field, the response will list all things, including both the EXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment types.

    • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

    • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

Raises:

Source code in docs_src/capo_iot/_services/async_io_t.py
async def list_principal_things_v2(
    self,
    principal: "capo_iot.types.principal.Principal",
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    next_token: Optional["capo_iot.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_iot.types.registry_max_results.RegistryMaxResults"
    ] = None,
    thing_principal_type: Optional[
        "capo_iot.types.thing_principal_type.ThingPrincipalType"
    ] = None,
) -> (
    "capo_iot.types.list_principal_things_v2_response.ListPrincipalThingsV2Response"
):
    """<p>Lists the things associated with the specified principal. A principal can be an X.509 certificate or an Amazon Cognito ID.</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">ListPrincipalThings</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 in this operation.</p>
        principal: <p>The principal. A principal can be an X.509 certificate or an Amazon Cognito ID.</p>
        thing_principal_type: <p>The type of the relation you want to filter in the response. If no value is provided in this field, the response will list all things, including both the <code>EXCLUSIVE_THING</code> and <code>NON_EXCLUSIVE_THING</code> attachment types.</p> <ul> <li> <p> <code>EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.</p> </li> </ul> <ul> <li> <p> <code>NON_EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.</p> </li> </ul>

    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.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</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_principal_things_v2_request.ListPrincipalThingsV2Request]",
    ) -> AsyncOperationResponse[
        "capo_iot.types.list_principal_things_v2_response.ListPrincipalThingsV2Response"
    ]:
        import capo_iot._operations.aws_iot_service.list_principal_things_v2

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPrincipalThingsV2")
    )
    input_: capo_iot.types.list_principal_things_v2_request.ListPrincipalThingsV2Request = {
        "principal": principal
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if thing_principal_type is not None:
        input_["thing_principal_type"] = thing_principal_type

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