|
232 | 232 | "CanaryStateReasonCode": { |
233 | 233 | "base": null, |
234 | 234 | "refs": { |
235 | | - "CanaryStatus$StateReasonCode": "<p>If the canary cannot run or has failed, this field displays the reason.</p>" |
| 235 | + "CanaryStatus$StateReasonCode": "<p>If the canary creation or update failed, this field displays the reason code.</p>" |
236 | 236 | } |
237 | 237 | }, |
238 | 238 | "CanaryStatus": { |
|
529 | 529 | "CanaryScheduleOutput$DurationInSeconds": "<p>How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the <code>Expression</code> value.</p>" |
530 | 530 | } |
531 | 531 | }, |
| 532 | + "MaxRetries": { |
| 533 | + "base": null, |
| 534 | + "refs": { |
| 535 | + "RetryConfigInput$MaxRetries": "<p>The maximum number of retries. The value must be less than or equal to 2.</p>", |
| 536 | + "RetryConfigOutput$MaxRetries": "<p>The maximum number of retries. The value must be less than or equal to 2.</p>" |
| 537 | + } |
| 538 | + }, |
532 | 539 | "MaxSize100": { |
533 | 540 | "base": null, |
534 | 541 | "refs": { |
|
617 | 624 | "ResourceList$member": null |
618 | 625 | } |
619 | 626 | }, |
| 627 | + "RetryAttempt": { |
| 628 | + "base": null, |
| 629 | + "refs": { |
| 630 | + "CanaryRun$RetryAttempt": "<p>The count in number of the retry attempt.</p>" |
| 631 | + } |
| 632 | + }, |
| 633 | + "RetryConfigInput": { |
| 634 | + "base": "<p>This structure contains information about the canary's retry configuration.</p> <note> <p>The default account level concurrent execution limit from Lambda is 1000. When you have more than 1000 canaries, it's possible there are more than 1000 Lambda invocations due to retries and the console might hang. For more information on the Lambda execution limit, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/lambda-concurrency.html#:~:text=As%20your%20functions%20receive%20more,functions%20in%20an%20AWS%20Region\">Understanding Lambda function scaling</a>.</p> </note> <note> <p>For canary with <code>MaxRetries = 2</code>, you need to set the <code>CanaryRunConfigInput.TimeoutInSeconds</code> to less than 600 seconds to avoid validation errors.</p> </note>", |
| 635 | + "refs": { |
| 636 | + "CanaryScheduleInput$RetryConfig": "<p>A structure that contains the retry configuration for a canary</p>" |
| 637 | + } |
| 638 | + }, |
| 639 | + "RetryConfigOutput": { |
| 640 | + "base": "<p>This structure contains information about the canary's retry configuration.</p>", |
| 641 | + "refs": { |
| 642 | + "CanaryScheduleOutput$RetryConfig": "<p>A structure that contains the retry configuration for a canary</p>" |
| 643 | + } |
| 644 | + }, |
620 | 645 | "RoleArn": { |
621 | 646 | "base": null, |
622 | 647 | "refs": { |
|
707 | 732 | "CanaryRunStatus$StateReason": "<p>If run of the canary failed, this field contains the reason for the error.</p>", |
708 | 733 | "CanaryScheduleInput$Expression": "<p>A <code>rate</code> expression or a <code>cron</code> expression that defines how often the canary is to run.</p> <p>For a rate expression, The syntax is <code>rate(<i>number unit</i>)</code>. <i>unit</i> can be <code>minute</code>, <code>minutes</code>, or <code>hour</code>. </p> <p>For example, <code>rate(1 minute)</code> runs the canary once a minute, <code>rate(10 minutes)</code> runs it once every 10 minutes, and <code>rate(1 hour)</code> runs it once every hour. You can specify a frequency between <code>rate(1 minute)</code> and <code>rate(1 hour)</code>.</p> <p>Specifying <code>rate(0 minute)</code> or <code>rate(0 hour)</code> is a special value that causes the canary to run only once when it is started.</p> <p>Use <code>cron(<i>expression</i>)</code> to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html\"> Scheduling canary runs using cron</a>.</p>", |
709 | 734 | "CanaryScheduleOutput$Expression": "<p>A <code>rate</code> expression or a <code>cron</code> expression that defines how often the canary is to run.</p> <p>For a rate expression, The syntax is <code>rate(<i>number unit</i>)</code>. <i>unit</i> can be <code>minute</code>, <code>minutes</code>, or <code>hour</code>. </p> <p>For example, <code>rate(1 minute)</code> runs the canary once a minute, <code>rate(10 minutes)</code> runs it once every 10 minutes, and <code>rate(1 hour)</code> runs it once every hour. You can specify a frequency between <code>rate(1 minute)</code> and <code>rate(1 hour)</code>.</p> <p>Specifying <code>rate(0 minute)</code> or <code>rate(0 hour)</code> is a special value that causes the canary to run only once when it is started.</p> <p>Use <code>cron(<i>expression</i>)</code> to specify a cron expression. For information about the syntax for cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html\"> Scheduling canary runs using cron</a>.</p>", |
710 | | - "CanaryStatus$StateReason": "<p>If the canary has insufficient permissions to run, this field provides more details.</p>", |
| 735 | + "CanaryStatus$StateReason": "<p>If the canary creation or update failed, this field provides details on the failure.</p>", |
711 | 736 | "CreateCanaryRequest$ArtifactS3Location": "<p>The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).</p>", |
712 | 737 | "CreateCanaryRequest$RuntimeVersion": "<p>Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html\"> Canary Runtime Versions</a>.</p>", |
713 | 738 | "DryRunConfigOutput$LastDryRunExecutionStatus": "<p>Returns the last execution status for a canary's dry run.</p>", |
|
786 | 811 | "refs": { |
787 | 812 | "CanaryRunTimeline$Started": "<p>The start time of the run.</p>", |
788 | 813 | "CanaryRunTimeline$Completed": "<p>The end time of the run.</p>", |
| 814 | + "CanaryRunTimeline$MetricTimestampForRunAndRetries": "<p>The time at which the metrics will be generated for this run or retries.</p>", |
789 | 815 | "CanaryTimeline$Created": "<p>The date and time the canary was created.</p>", |
790 | 816 | "CanaryTimeline$LastModified": "<p>The date and time the canary was most recently modified.</p>", |
791 | 817 | "CanaryTimeline$LastStarted": "<p>The date and time that the canary's most recent run started.</p>", |
|
805 | 831 | "DescribeCanariesResponse$NextToken": "<p>A token that indicates that there is more data available. You can use this token in a subsequent <code>DescribeCanaries</code> operation to retrieve the next set of results.</p>", |
806 | 832 | "DescribeRuntimeVersionsRequest$NextToken": "<p>A token that indicates that there is more data available. You can use this token in a subsequent <code>DescribeRuntimeVersions</code> operation to retrieve the next set of results.</p>", |
807 | 833 | "DescribeRuntimeVersionsResponse$NextToken": "<p>A token that indicates that there is more data available. You can use this token in a subsequent <code>DescribeRuntimeVersions</code> operation to retrieve the next set of results.</p>", |
808 | | - "GetCanaryRunsRequest$NextToken": "<p>A token that indicates that there is more data available. You can use this token in a subsequent <code>GetCanaryRuns</code> operation to retrieve the next set of results.</p>", |
| 834 | + "GetCanaryRunsRequest$NextToken": "<p>A token that indicates that there is more data available. You can use this token in a subsequent <code>GetCanaryRuns</code> operation to retrieve the next set of results.</p> <note> <p>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.</p> </note>", |
809 | 835 | "GetCanaryRunsResponse$NextToken": "<p>A token that indicates that there is more data available. You can use this token in a subsequent <code>GetCanaryRuns</code> operation to retrieve the next set of results.</p>", |
810 | 836 | "ListGroupsResponse$NextToken": "<p>A token that indicates that there is more data available. You can use this token in a subsequent <code>ListGroups</code> operation to retrieve the next set of results.</p>" |
811 | 837 | } |
|
820 | 846 | "Canary$Id": "<p>The unique ID of this canary.</p>", |
821 | 847 | "CanaryDryRunConfigOutput$DryRunId": "<p>The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.</p>", |
822 | 848 | "CanaryRun$Id": "<p>A unique ID that identifies this canary run.</p>", |
| 849 | + "CanaryRun$ScheduledRunId": "<p>The ID of the scheduled canary run.</p>", |
823 | 850 | "DryRunConfigOutput$DryRunId": "<p>The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.</p>", |
824 | 851 | "GetCanaryRequest$DryRunId": "<p>The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.</p>", |
825 | 852 | "GetCanaryRunsRequest$DryRunId": "<p>The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.</p>", |
|
0 commit comments