Class: Aws::Synthetics::Types::ListAssociatedGroupsRequest

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

Overview

Note:

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

{
  next_token: "PaginationToken",
  max_results: 1,
  resource_arn: "CanaryArn", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

Specify this parameter to limit how many groups are returned each time you use the ListAssociatedGroups operation. If you omit this parameter, the default of 20 is used.

Returns:

  • (Integer)


1476
1477
1478
1479
1480
1481
1482
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1476

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

#next_tokenString

A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

Returns:

  • (String)


1476
1477
1478
1479
1480
1481
1482
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1476

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

#resource_arnString

The ARN of the canary that you want to view groups for.

Returns:

  • (String)


1476
1477
1478
1479
1480
1481
1482
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1476

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