Class: Aws::Synthetics::Types::GetCanaryRunsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Synthetics::Types::GetCanaryRunsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-synthetics/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run_id ⇒ String

  The DryRunId associated with an existing canary’s dry run.

• #max_results ⇒ Integer

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

• #name ⇒ String

  The name of the canary that you want to see runs for.

• #next_token ⇒ String

  A token that indicates that there is more data available.

• #run_type ⇒ String

  • When you provide ‘RunType=CANARY_RUN` and `dryRunId`, you will get an exception.

Instance Attribute Details

#dry_run_id ⇒ String

The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.

Returns:

• (String)

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

class GetCanaryRunsRequest < Struct.new(
  :name,
  :next_token,
  :max_results,
  :dry_run_id,
  :run_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

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

class GetCanaryRunsRequest < Struct.new(
  :name,
  :next_token,
  :max_results,
  :dry_run_id,
  :run_type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the canary that you want to see runs for.

Returns:

• (String)

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

class GetCanaryRunsRequest < Struct.new(
  :name,
  :next_token,
  :max_results,
  :dry_run_id,
  :run_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 ‘GetCanaryRuns` operation to retrieve the next set of results.

<note markdown=“1”> When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.

</note>

Returns:

• (String)

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

class GetCanaryRunsRequest < Struct.new(
  :name,
  :next_token,
  :max_results,
  :dry_run_id,
  :run_type)
  SENSITIVE = []
  include Aws::Structure
end

#run_type ⇒ String

• When you provide ‘RunType=CANARY_RUN` and `dryRunId`, you will get an exception

• When a value is not provided for ‘RunType`, the default value is `CANARY_RUN`

• When ‘CANARY_RUN` is provided, all canary runs excluding dry runs are returned

• When ‘DRY_RUN` is provided, all dry runs excluding canary runs are returned

Returns:

• (String)

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

class GetCanaryRunsRequest < Struct.new(
  :name,
  :next_token,
  :max_results,
  :dry_run_id,
  :run_type)
  SENSITIVE = []
  include Aws::Structure
end