Class: Aws::Synthetics::Types::DescribeCanariesLastRunRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#browser_type ⇒ String

The type of browser to use for the canary run.

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1301

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

#max_results ⇒ Integer

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

Returns:

  • (Integer) 


1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1301

class DescribeCanariesLastRunRequest < Struct.new(
  :next_token,
  :max_results,
  :names,
  :browser_type)
  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 the Names 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>) 


1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1301

class DescribeCanariesLastRunRequest < Struct.new(
  :next_token,
  :max_results,
  :names,
  :browser_type)
  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 DescribeCanariesLastRun operation to retrieve the next set of results.

Returns:

  • (String) 


1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1301

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