Skip to content

Retrieves details about a policy store

Description

Retrieves details about a policy store.

Usage

verifiedpermissions_get_policy_store(policyStoreId, tags)

Arguments

  • policyStoreId

    [required] Specifies the policy store that you want information about.

    To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

    • ID: PSEXAMPLEabcdefg111111
    • Alias name: policy-store-alias/example-policy-store

    To view aliases, use list_policy_store_aliases.

  • tags

    Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.

    If this parameter is included in the API call but there are no tags attached to the policy store, the tags response parameter is omitted from the response.

Value

A list with the following syntax:

list(
  policyStoreId = "string",
  arn = "string",
  validationSettings = list(
    mode = "OFF"|"STRICT"
  ),
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedDate = as.POSIXct(
    "2015-01-01"
  ),
  description = "string",
  deletionProtection = "ENABLED"|"DISABLED",
  encryptionState = list(
    kmsEncryptionState = list(
      key = "string",
      encryptionContext = list(
        "string"
      )
    ),
    default = list()
  ),
  cedarVersion = "CEDAR_2"|"CEDAR_4",
  tags = list(
    "string"
  )
)

Request syntax

svc$get_policy_store(
  policyStoreId = "string",
  tags = TRUE|FALSE
)