List Policies

bedrockagentcorecontrol_list_policies

R Documentation

Retrieves a list of policies within the AgentCore Policy engine¶

Description¶

Retrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.

Usage¶

bedrockagentcorecontrol_list_policies(nextToken, maxResults,
  policyEngineId, targetResourceScope)

Arguments¶

nextToken

A pagination token returned from a previous list_policies call. Use this token to retrieve the next page of results when the response is paginated.

maxResults

The maximum number of policies to return in a single response. If not specified, the default is 10 policies per page, with a maximum of 100 per page.

policyEngineId

[required] The identifier of the policy engine whose policies to retrieve.

targetResourceScope

Optional filter to list policies that apply to a specific resource scope or resource type. This helps narrow down policy results to those relevant for particular Amazon Web Services resources, agent tools, or operational contexts within the policy engine ecosystem.

Value¶

A list with the following syntax:

list(
  policies = list(
    list(
      policyId = "string",
      name = "string",
      policyEngineId = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      policyArn = "string",
      status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED",
      definition = list(
        cedar = list(
          statement = "string"
        ),
        policyGeneration = list(
          policyGenerationId = "string",
          policyGenerationAssetId = "string"
        )
      ),
      description = "string",
      statusReasons = list(
        "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_policies(
  nextToken = "string",
  maxResults = 123,
  policyEngineId = "string",
  targetResourceScope = "string"
)