List Scrapers
prometheusservice_list_scrapers | R Documentation |
The ListScrapers operation lists all of the scrapers in your account¶
Description¶
The list_scrapers
operation lists all of the scrapers in your account.
This includes scrapers being created or deleted. You can optionally
filter the returned list.
Usage¶
Arguments¶
filters
(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include
status
,sourceArn
,destinationArn
, andalias
.Filters on the same key are
OR
'd together, and filters on different keys areAND
'd together. For example,status=ACTIVE&status=CREATING&alias=Test
, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:
status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012
If this is included, it filters the results to only the scrapers that match the filter.
maxResults
Optional) The maximum number of scrapers to return in one
list_scrapers
operation. The range is 1-1000.If you omit this parameter, the default of 100 is used.
nextToken
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
Value¶
A list with the following syntax:
list(
nextToken = "string",
scrapers = list(
list(
alias = "string",
arn = "string",
createdAt = as.POSIXct(
"2015-01-01"
),
destination = list(
ampConfiguration = list(
workspaceArn = "string"
)
),
lastModifiedAt = as.POSIXct(
"2015-01-01"
),
roleArn = "string",
scraperId = "string",
source = list(
eksConfiguration = list(
clusterArn = "string",
securityGroupIds = list(
"string"
),
subnetIds = list(
"string"
)
)
),
status = list(
statusCode = "CREATING"|"ACTIVE"|"DELETING"|"CREATION_FAILED"|"DELETION_FAILED"
),
statusReason = "string",
tags = list(
"string"
)
)
)
)