Skip to content

list_targets_for_policy async

list_targets_for_policy(
    policy_name: PolicyName,
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    marker: Optional[Marker] = None,
    page_size: Optional[PageSize] = None,
) -> ListTargetsForPolicyResponse

List targets for the specified policy.

Requires permission to access the ListTargetsForPolicy action.

Parameters:

  • policy_name (PolicyName) –

    The policy name.

  • marker (Optional[Marker], default: None ) –

    A marker used to get the next set of results.

  • page_size (Optional[PageSize], 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_targets_for_policy(
    self,
    policy_name: "capo_iot.types.policy_name.PolicyName",
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    marker: Optional["capo_iot.types.marker.Marker"] = None,
    page_size: Optional["capo_iot.types.page_size.PageSize"] = None,
) -> "capo_iot.types.list_targets_for_policy_response.ListTargetsForPolicyResponse":
    """<p>List targets for the specified policy.</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">ListTargetsForPolicy</a> action.</p>

    Args:
        policy_name: <p>The policy name.</p>
        marker: <p>A marker used to get the next set of results.</p>
        page_size: <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.limit_exceeded_exception.LimitExceededException: <p>A limit has been exceeded.</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_targets_for_policy_request.ListTargetsForPolicyRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot.types.list_targets_for_policy_response.ListTargetsForPolicyResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_targets_for_policy

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTargetsForPolicy")
    )
    input_: capo_iot.types.list_targets_for_policy_request.ListTargetsForPolicyRequest = {
        "policy_name": policy_name
    }
    if marker is not None:
        input_["marker"] = marker
    if page_size is not None:
        input_["page_size"] = page_size

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