Class: Aws::Synthetics::Types::DescribeCanariesRequest

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 DescribeCanariesRequest data as a hash:

{
  next_token: "Token",
  max_results: 1,
  names: ["CanaryName"],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation. If you omit this parameter, the default of 100 is used.

Returns:

  • (Integer)


1134
1135
1136
1137
1138
1139
1140
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1134

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

#namesArray<String>

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

Returns:

  • (Array<String>)


1134
1135
1136
1137
1138
1139
1140
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1134

class DescribeCanariesRequest < Struct.new(
  :next_token,
  :max_results,
  :names)
  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)


1134
1135
1136
1137
1138
1139
1140
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1134

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