Skip to content

Get Authorizers

apigateway_get_authorizers R Documentation

Describe an existing Authorizers resource

Description

Describe an existing Authorizers resource.

Usage

apigateway_get_authorizers(restApiId, position, limit)

Arguments

restApiId

[required] The string identifier of the associated RestApi.

position

The current pagination position in the paged result set.

limit

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Value

A list with the following syntax:

list(
  position = "string",
  items = list(
    list(
      id = "string",
      name = "string",
      type = "TOKEN"|"REQUEST"|"COGNITO_USER_POOLS",
      providerARNs = list(
        "string"
      ),
      authType = "string",
      authorizerUri = "string",
      authorizerCredentials = "string",
      identitySource = "string",
      identityValidationExpression = "string",
      authorizerResultTtlInSeconds = 123
    )
  )
)

Request syntax

svc$get_authorizers(
  restApiId = "string",
  position = "string",
  limit = 123
)