Class: Aws::PrometheusService::Types::ListWorkspacesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::PrometheusService::Types::ListWorkspacesRequest
- Defined in:
- gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb
Overview
Represents the input of a ListWorkspaces
operation.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#alias ⇒ String
If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.
-
#max_results ⇒ Integer
The maximum number of workspaces to return per request.
-
#next_token ⇒ String
The token for the next set of items to return.
Instance Attribute Details
#alias ⇒ String
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.
1023 1024 1025 1026 1027 1028 1029 |
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 1023 class ListWorkspacesRequest < Struct.new( :alias, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of workspaces to return per request. The default is 100.
1023 1024 1025 1026 1027 1028 1029 |
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 1023 class ListWorkspacesRequest < Struct.new( :alias, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
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.
1023 1024 1025 1026 1027 1028 1029 |
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 1023 class ListWorkspacesRequest < Struct.new( :alias, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end |