Skip to content

list_access_policies

list_access_policies(
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    identity_type: Optional[IdentityType] = None,
    identity_id: Optional[IdentityId] = None,
    resource_type: Optional[ResourceType] = None,
    resource_id: Optional[ID] = None,
    iam_arn: Optional[IamArn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListAccessPoliciesResponse

Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

Parameters:

  • identity_type (Optional[IdentityType], default: None ) –

    The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify identityId.

  • identity_id (Optional[IdentityId], default: None ) –

    The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

  • resource_type (Optional[ResourceType], default: None ) –

    The type of resource (portal or project). This parameter is required if you specify resourceId.

  • resource_id (Optional[ID], default: None ) –

    The ID of the resource. This parameter is required if you specify resourceType.

  • iam_arn (Optional[IamArn], default: None ) –

    The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.

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

    The token to be used for the next set of paginated results.

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

    The maximum number of results to return for each paginated request.

    Default: 50

Raises:

  • InternalFailureException –

    IoT SiteWise can't process your request right now. Try again later.

  • InvalidRequestException –

    The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ThrottlingException –

    Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

    For more information, see Quotas in the IoT SiteWise User Guide.

  • UnknownServiceError –

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

Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py
def list_access_policies(
    self,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    identity_type: Optional[
        "capo_iotsitewise.types.identity_type.IdentityType"
    ] = None,
    identity_id: Optional["capo_iotsitewise.types.identity_id.IdentityId"] = None,
    resource_type: Optional[
        "capo_iotsitewise.types.resource_type.ResourceType"
    ] = None,
    resource_id: Optional["capo_iotsitewise.types.id.ID"] = None,
    iam_arn: Optional["capo_iotsitewise.types.iam_arn.IamArn"] = None,
    next_token: Optional["capo_iotsitewise.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iotsitewise.types.max_results.MaxResults"] = None,
) -> "capo_iotsitewise.types.list_access_policies_response.ListAccessPoliciesResponse":
    """<p>Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).</p>

    Args:
        identity_type: <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify <code>identityId</code>.</p>
        identity_id: <p>The ID of the identity. This parameter is required if you specify <code>USER</code> or <code>GROUP</code> for <code>identityType</code>.</p>
        resource_type: <p>The type of resource (portal or project). This parameter is required if you specify <code>resourceId</code>.</p>
        resource_id: <p>The ID of the resource. This parameter is required if you specify <code>resourceType</code>.</p>
        iam_arn: <p>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the <i>IAM User Guide</i>. This parameter is required if you specify <code>IAM</code> for <code>identityType</code>.</p>
        next_token: <p>The token to be used for the next set of paginated results.</p>
        max_results: <p>The maximum number of results to return for each paginated request.</p> <p>Default: 50</p>

    Raises:
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.list_access_policies_request.ListAccessPoliciesRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.list_access_policies_response.ListAccessPoliciesResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_access_policies

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.list_access_policies.list_access_policies(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAccessPolicies")
    )
    input_: capo_iotsitewise.types.list_access_policies_request.ListAccessPoliciesRequest = {}
    if identity_type is not None:
        input_["identity_type"] = identity_type
    if identity_id is not None:
        input_["identity_id"] = identity_id
    if resource_type is not None:
        input_["resource_type"] = resource_type
    if resource_id is not None:
        input_["resource_id"] = resource_id
    if iam_arn is not None:
        input_["iam_arn"] = iam_arn
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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