Class: Aws::PrometheusService::Types::ListScrapersRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-prometheusservice/types.rb

Overview

Represents the input of a ‘ListScrapers` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Hash<String,Array<String>>

(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include ‘status`, `sourceArn`, `destinationArn`, and `alias`.

Filters on the same key are ‘OR`’d together, and filters on different keys are ‘AND`’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.

Returns:

  • (Hash<String,Array<String>>) 


944
945
946
947
948
949
950
 
# File 'lib/aws-sdk-prometheusservice/types.rb', line 944

class ListScrapersRequest < Struct.new(
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Optional) The maximum number of scrapers to return in one ‘ListScrapers` operation. The range is 1-1000.

If you omit this parameter, the default of 100 is used.

Returns:

  • (Integer) 


944
945
946
947
948
949
950
 
# File 'lib/aws-sdk-prometheusservice/types.rb', line 944

class ListScrapersRequest < Struct.new(
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (String) 


944
945
946
947
948
949
950
 
# File 'lib/aws-sdk-prometheusservice/types.rb', line 944

class ListScrapersRequest < Struct.new(
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end