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

Inherits:

Struct

• Object
• Struct
• Aws::Synthetics::Types::DescribeCanariesRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-synthetics/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  Specify this parameter to limit how many canaries are returned each time you use the ‘DescribeCanaries` operation.

• #names ⇒ Array<String>

  Use this parameter to return only canaries that match the names that you specify here.

• #next_token ⇒ String

  A token that indicates that there is more data available.

Instance Attribute Details

#max_results ⇒ Integer

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 20 is used.

Returns:

• (Integer)

# File 'lib/aws-sdk-synthetics/types.rb', line 1021

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

#names ⇒ Array<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].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-synthetics/types.rb', line 1021

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

#next_token ⇒ String

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)

# File 'lib/aws-sdk-synthetics/types.rb', line 1021

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