Get Resources

apigateway_get_resources

R Documentation

Lists information about a collection of Resource resources

Description

Lists information about a collection of Resource resources.

Usage

apigateway_get_resources(restApiId, position, limit, embed)

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.

embed

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Value

A list with the following syntax:

list(
  position = "string",
  items = list(
    list(
      id = "string",
      parentId = "string",
      pathPart = "string",
      path = "string",
      resourceMethods = list(
        list(
          httpMethod = "string",
          authorizationType = "string",
          authorizerId = "string",
          apiKeyRequired = TRUE|FALSE,
          requestValidatorId = "string",
          operationName = "string",
          requestParameters = list(
            TRUE|FALSE
          ),
          requestModels = list(
            "string"
          ),
          methodResponses = list(
            list(
              statusCode = "string",
              responseParameters = list(
                TRUE|FALSE
              ),
              responseModels = list(
                "string"
              )
            )
          ),
          methodIntegration = list(
            type = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY",
            httpMethod = "string",
            uri = "string",
            connectionType = "INTERNET"|"VPC_LINK",
            connectionId = "string",
            credentials = "string",
            requestParameters = list(
              "string"
            ),
            requestTemplates = list(
              "string"
            ),
            passthroughBehavior = "string",
            contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT",
            timeoutInMillis = 123,
            cacheNamespace = "string",
            cacheKeyParameters = list(
              "string"
            ),
            integrationResponses = list(
              list(
                statusCode = "string",
                selectionPattern = "string",
                responseParameters = list(
                  "string"
                ),
                responseTemplates = list(
                  "string"
                ),
                contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"
              )
            ),
            tlsConfig = list(
              insecureSkipVerification = TRUE|FALSE
            )
          ),
          authorizationScopes = list(
            "string"
          )
        )
      )
    )
  )
)

Request syntax

svc$get_resources(
  restApiId = "string",
  position = "string",
  limit = 123,
  embed = list(
    "string"
  )
)