Get Deployments

apigateway_get_deployments

R Documentation

Gets information about a Deployments collection¶

Description¶

Gets information about a Deployments collection.

Usage¶

apigateway_get_deployments(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",
      description = "string",
      createdDate = as.POSIXct(
        "2015-01-01"
      ),
      apiSummary = list(
        list(
          list(
            authorizationType = "string",
            apiKeyRequired = TRUE|FALSE
          )
        )
      )
    )
  )
)

Request syntax¶

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