list_thing_principals `async` ¶

list_thing_principals(
    thing_name: ThingName,
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[RegistryMaxResults] = None,
) -> ListThingPrincipalsResponse

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Requires permission to access the ListThingPrincipals 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.
thing_name (ThingName) –

The name of the thing.

Raises:

InternalFailureException –

An unexpected error has occurred.
InvalidRequestException –

The request is not valid.
ResourceNotFoundException –

The specified resource does not exist.
ServiceUnavailableException –

The service is temporarily unavailable.
ThrottlingException –

The rate exceeds the limit.
UnauthorizedException –

You are not authorized to perform this operation.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iot/_services/async_io_t.py

async def list_thing_principals(
    self,
    thing_name: "capo_iot.types.thing_name.ThingName",
    *,
    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,
) -> "capo_iot.types.list_thing_principals_response.ListThingPrincipalsResponse":
    """<p>Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.</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">ListThingPrincipals</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>
        thing_name: <p>The name of the thing.</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.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_thing_principals_request.ListThingPrincipalsRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot.types.list_thing_principals_response.ListThingPrincipalsResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_thing_principals

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListThingPrincipals")
    )
    input_: capo_iot.types.list_thing_principals_request.ListThingPrincipalsRequest = {
        "thing_name": thing_name
    }
    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

list_thing_principals async ¶

list_thing_principals `async` ¶