Skip to content

list_attached_policies

list_attached_policies(
    target: PolicyTarget,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    recursive: Optional[Recursive] = None,
    marker: Optional[Marker] = None,
    page_size: Optional[PageSize] = None,
) -> ListAttachedPoliciesResponse

Lists the policies attached to the specified thing group.

Requires permission to access the ListAttachedPolicies action.

Parameters:

  • target (PolicyTarget) –

    The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

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

    When true, recursively list attached policies.

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

    The token to retrieve the next set of results.

  • page_size (Optional[PageSize], default: None ) –

    The maximum number of results to be returned per request.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def list_attached_policies(
    self,
    target: "capo_iot.types.policy_target.PolicyTarget",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    recursive: Optional["capo_iot.types.recursive.Recursive"] = None,
    marker: Optional["capo_iot.types.marker.Marker"] = None,
    page_size: Optional["capo_iot.types.page_size.PageSize"] = None,
) -> "capo_iot.types.list_attached_policies_response.ListAttachedPoliciesResponse":
    """<p>Lists the policies attached to the specified thing 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">ListAttachedPolicies</a> action.</p>

    Args:
        target: <p>The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
        recursive: <p>When true, recursively list attached policies.</p>
        marker: <p>The token to retrieve the next set of results.</p>
        page_size: <p>The maximum number of results to be returned per request.</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.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.list_attached_policies_request.ListAttachedPoliciesRequest]",
    ) -> OperationResponse[
        "capo_iot.types.list_attached_policies_response.ListAttachedPoliciesResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_attached_policies

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAttachedPolicies")
    )
    input_: capo_iot.types.list_attached_policies_request.ListAttachedPoliciesRequest = {
        "target": target
    }
    if recursive is not None:
        input_["recursive"] = recursive
    if marker is not None:
        input_["marker"] = marker
    if page_size is not None:
        input_["page_size"] = page_size

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