List Policies

verifiedpermissions_list_policies

R Documentation

Returns a paginated list of all policies stored in the specified policy store

Description

Returns a paginated list of all policies stored in the specified policy store.

Usage

verifiedpermissions_list_policies(policyStoreId, nextToken, maxResults,
  filter)

Arguments

policyStoreId

[required] Specifies the ID of the policy store you want to list policies from.

nextToken

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

maxResults

Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.

filter

Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.

Value

A list with the following syntax:

list(
  nextToken = "string",
  policies = list(
    list(
      policyStoreId = "string",
      policyId = "string",
      policyType = "STATIC"|"TEMPLATE_LINKED",
      principal = list(
        entityType = "string",
        entityId = "string"
      ),
      resource = list(
        entityType = "string",
        entityId = "string"
      ),
      actions = list(
        list(
          actionType = "string",
          actionId = "string"
        )
      ),
      definition = list(
        static = list(
          description = "string"
        ),
        templateLinked = list(
          policyTemplateId = "string",
          principal = list(
            entityType = "string",
            entityId = "string"
          ),
          resource = list(
            entityType = "string",
            entityId = "string"
          )
        )
      ),
      createdDate = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedDate = as.POSIXct(
        "2015-01-01"
      ),
      effect = "Permit"|"Forbid"
    )
  )
)

Request syntax

svc$list_policies(
  policyStoreId = "string",
  nextToken = "string",
  maxResults = 123,
  filter = list(
    principal = list(
      unspecified = TRUE|FALSE,
      identifier = list(
        entityType = "string",
        entityId = "string"
      )
    ),
    resource = list(
      unspecified = TRUE|FALSE,
      identifier = list(
        entityType = "string",
        entityId = "string"
      )
    ),
    policyType = "STATIC"|"TEMPLATE_LINKED",
    policyTemplateId = "string"
  )
)