Class: Aws::PrometheusService::Types::ListWorkspacesRequest

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

Overview

Note:

When making an API call, you may pass ListWorkspacesRequest data as a hash:

{
  alias: "WorkspaceAlias",
  max_results: 1,
  next_token: "PaginationToken",
}

Represents the input of a ListWorkspaces operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.

Returns:

  • (String)


652
653
654
655
656
657
658
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 652

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

#max_resultsInteger

Maximum results to return in response (default=100, maximum=1000).

Returns:

  • (Integer)


652
653
654
655
656
657
658
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 652

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

#next_tokenString

Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.

Returns:

  • (String)


652
653
654
655
656
657
658
# File 'gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb', line 652

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