List Guardrails

bedrock_list_guardrails

R Documentation

Lists details about all the guardrails in an account¶

Description¶

Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field.

You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another list_guardrails request to see the next batch of results.

Usage¶

bedrock_list_guardrails(guardrailIdentifier, maxResults, nextToken)

Arguments¶

guardrailIdentifier: The unique identifier of the guardrail. This can be an ID or the ARN.
maxResults: The maximum number of results to return in the response.
nextToken: If there are more results than were returned in the response, the response returns a nextToken that you can send in another list_guardrails request to see the next batch of results.

Value¶

A list with the following syntax:

list(
  guardrails = list(
    list(
      id = "string",
      arn = "string",
      status = "CREATING"|"UPDATING"|"VERSIONING"|"READY"|"FAILED"|"DELETING",
      name = "string",
      description = "string",
      version = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_guardrails(
  guardrailIdentifier = "string",
  maxResults = 123,
  nextToken = "string"
)