List Workspaces

prometheusservice_list_workspaces

R Documentation

Lists all of the Amazon Managed Service for Prometheus workspaces in your account

Description

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

Usage

prometheusservice_list_workspaces(alias, maxResults, nextToken)

Arguments

alias

If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

maxResults

The maximum number of workspaces to return per request. The default is 100.

nextToken

The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

Value

A list with the following syntax:

list(
  nextToken = "string",
  workspaces = list(
    list(
      alias = "string",
      arn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      kmsKeyArn = "string",
      status = list(
        statusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"
      ),
      tags = list(
        "string"
      ),
      workspaceId = "string"
    )
  )
)

Request syntax

svc$list_workspaces(
  alias = "string",
  maxResults = 123,
  nextToken = "string"
)