List Applications

opensearchservice_list_applications

R Documentation

Lists all OpenSearch applications under your account¶

Description¶

Lists all OpenSearch applications under your account.

Usage¶

opensearchservice_list_applications(nextToken, statuses, maxResults)

Arguments¶

nextToken

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

statuses

Filters the list of OpenSearch applications by status. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

maxResults

An optional parameter that specifies the maximum number of results to return for a given request.

Value¶

A list with the following syntax:

list(
  ApplicationSummaries = list(
    list(
      id = "string",
      arn = "string",
      name = "string",
      endpoint = "string",
      status = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_applications(
  nextToken = "string",
  statuses = list(
    "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED"
  ),
  maxResults = 123
)