@aws-sdk/client-synthetics 3.296.0 → 3.297.0

package/dist-types/models/SyntheticsServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Synthetics service.
  */
 export declare class SyntheticsServiceException extends __ServiceException {

package/dist-types/models/models_0.d.ts

@@ -1,10 +1,14 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { SyntheticsServiceException as __BaseException } from "./SyntheticsServiceException";
+/**
+ * @public
+ */
 export declare enum EncryptionMode {
     SSE_KMS = "SSE_KMS",
     SSE_S3 = "SSE_S3"
 }
 /**
+ * @public
  * <p>A structure that contains the configuration of encryption-at-rest settings for canary artifacts that the canary
  *          uploads to Amazon S3. </p>
  *          <p>For more information, see
@@ -29,6 +33,7 @@ export interface S3EncryptionConfig {
     KmsKeyArn?: string;
 }
 /**
+ * @public
  * <p>A structure that contains the configuration for canary artifacts, including the
  *          encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>
  */
@@ -44,6 +49,7 @@ export interface ArtifactConfigInput {
     S3Encryption?: S3EncryptionConfig;
 }
 /**
+ * @public
  * <p>A structure that contains the configuration for canary artifacts, including
  *          the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.</p>
  */
@@ -53,6 +59,9 @@ export interface ArtifactConfigOutput {
      */
     S3Encryption?: S3EncryptionConfig;
 }
+/**
+ * @public
+ */
 export interface AssociateResourceRequest {
     /**
      * <p>Specifies the group. You can specify the group name, the ARN, or the
@@ -64,9 +73,13 @@ export interface AssociateResourceRequest {
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface AssociateResourceResponse {
 }
 /**
+ * @public
  * <p>A conflicting operation is already in progress.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -79,6 +92,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>An unknown internal error occurred.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -91,6 +105,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>One of the specified resources was not found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -103,6 +118,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request exceeded a service quota value.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -115,6 +131,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>A parameter could not be validated.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -127,6 +144,7 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was not valid.</p>
  */
 export declare class BadRequestException extends __BaseException {
@@ -139,6 +157,7 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.</p>
  */
 export interface BaseScreenshot {
@@ -158,6 +177,7 @@ export interface BaseScreenshot {
     IgnoreCoordinates?: string[];
 }
 /**
+ * @public
  * <p>This structure contains information about the canary's Lambda handler and
  *       where its code is stored by CloudWatch Synthetics.</p>
  */
@@ -172,6 +192,7 @@ export interface CanaryCodeOutput {
     Handler?: string;
 }
 /**
+ * @public
  * <p>A structure that contains information about a canary run.</p>
  */
 export interface CanaryRunConfigOutput {
@@ -190,6 +211,7 @@ export interface CanaryRunConfigOutput {
     ActiveTracing?: boolean;
 }
 /**
+ * @public
  * <p>How long, in seconds, for the canary to continue making regular runs according to the schedule in the
  *          <code>Expression</code> value.</p>
  */
@@ -218,6 +240,9 @@ export interface CanaryScheduleOutput {
      */
     DurationInSeconds?: number;
 }
+/**
+ * @public
+ */
 export declare enum CanaryState {
     CREATING = "CREATING",
     DELETING = "DELETING",
@@ -229,6 +254,9 @@ export declare enum CanaryState {
     STOPPING = "STOPPING",
     UPDATING = "UPDATING"
 }
+/**
+ * @public
+ */
 export declare enum CanaryStateReasonCode {
     CREATE_FAILED = "CREATE_FAILED",
     CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
@@ -244,6 +272,7 @@ export declare enum CanaryStateReasonCode {
     UPDATE_PENDING = "UPDATE_PENDING"
 }
 /**
+ * @public
  * <p>A structure that contains the current state of the canary.</p>
  */
 export interface CanaryStatus {
@@ -261,6 +290,7 @@ export interface CanaryStatus {
     StateReasonCode?: CanaryStateReasonCode | string;
 }
 /**
+ * @public
  * <p>This structure contains information about when the canary was created and modified.</p>
  */
 export interface CanaryTimeline {
@@ -282,6 +312,7 @@ export interface CanaryTimeline {
     LastStopped?: Date;
 }
 /**
+ * @public
  * <p>If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates
  *          of any parts of those screenshots that are ignored during visual monitoring comparison.</p>
  *          <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b> runtime or later.</p>
@@ -298,6 +329,7 @@ export interface VisualReferenceOutput {
     BaseCanaryRunId?: string;
 }
 /**
+ * @public
  * <p>If this canary is to test an endpoint in a VPC, this structure contains
  *          information about the subnets and security groups of the VPC endpoint.
  *          For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html">
@@ -318,6 +350,7 @@ export interface VpcConfigOutput {
     SecurityGroupIds?: string[];
 }
 /**
+ * @public
  * <p>This structure contains all information about one canary in your account.</p>
  */
 export interface Canary {
@@ -403,16 +436,23 @@ export interface Canary {
      */
     ArtifactConfig?: ArtifactConfigOutput;
 }
+/**
+ * @public
+ */
 export declare enum CanaryRunState {
     FAILED = "FAILED",
     PASSED = "PASSED",
     RUNNING = "RUNNING"
 }
+/**
+ * @public
+ */
 export declare enum CanaryRunStateReasonCode {
     CANARY_FAILURE = "CANARY_FAILURE",
     EXECUTION_FAILURE = "EXECUTION_FAILURE"
 }
 /**
+ * @public
  * <p>This structure contains the status information about a canary run.</p>
  */
 export interface CanaryRunStatus {
@@ -432,6 +472,7 @@ export interface CanaryRunStatus {
     StateReasonCode?: CanaryRunStateReasonCode | string;
 }
 /**
+ * @public
  * <p>This structure contains the start and end times of a single canary run.</p>
  */
 export interface CanaryRunTimeline {
@@ -445,6 +486,7 @@ export interface CanaryRunTimeline {
     Completed?: Date;
 }
 /**
+ * @public
  * <p>This structure contains the details about one run of one canary.</p>
  */
 export interface CanaryRun {
@@ -471,6 +513,7 @@ export interface CanaryRun {
     ArtifactS3Location?: string;
 }
 /**
+ * @public
  * <p>This structure contains information about the most recent run of a single canary.</p>
  */
 export interface CanaryLastRun {
@@ -484,6 +527,7 @@ export interface CanaryLastRun {
     LastRun?: CanaryRun;
 }
 /**
+ * @public
  * <p>Use this structure to input your script code for the canary. This structure contains the
  *          Lambda handler with the location where the canary should start running the script. If the
  *          script is stored in an S3 bucket, the bucket name, key, and version are also included. If
@@ -530,6 +574,7 @@ export interface CanaryCodeInput {
     Handler: string | undefined;
 }
 /**
+ * @public
  * <p>A structure that contains input information for a canary run.</p>
  */
 export interface CanaryRunConfigInput {
@@ -558,7 +603,7 @@ export interface CanaryRunConfigInput {
     /**
      * <p>Specifies the keys and values to use for any environment variables
      *       used in the canary script. Use the following format:</p>
-     *          <p>{ "key1" : "value1", "key2" : "value2", ...}</p>
+     *          <p>\{ "key1" : "value1", "key2" : "value2", ...\}</p>
      *          <p>Keys must start with a letter and be at least two characters. The total size
      *          of your environment variables cannot exceed 4 KB. You can't specify any Lambda
      *          reserved environment variables as the keys for your environment variables. For
@@ -572,6 +617,7 @@ export interface CanaryRunConfigInput {
     EnvironmentVariables?: Record<string, string>;
 }
 /**
+ * @public
  * <p>This structure specifies how often a canary is to make runs and the date and time
  *          when it should stop making runs.</p>
  */
@@ -601,6 +647,7 @@ export interface CanaryScheduleInput {
     DurationInSeconds?: number;
 }
 /**
+ * @public
  * <p>If this canary is to test an endpoint in a VPC, this structure contains
  *          information about the subnets and security groups of the VPC endpoint.
  *          For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html">
@@ -616,6 +663,9 @@ export interface VpcConfigInput {
      */
     SecurityGroupIds?: string[];
 }
+/**
+ * @public
+ */
 export interface CreateCanaryRequest {
     /**
      * <p>The name for this canary. Be sure to give it a descriptive name
@@ -735,6 +785,9 @@ export interface CreateCanaryRequest {
      */
     ArtifactConfig?: ArtifactConfigInput;
 }
+/**
+ * @public
+ */
 export interface CreateCanaryResponse {
     /**
      * <p>The full details about the canary you have created.</p>
@@ -742,6 +795,7 @@ export interface CreateCanaryResponse {
     Canary?: Canary;
 }
 /**
+ * @public
  * <p>One of the input resources is larger than is allowed.</p>
  */
 export declare class RequestEntityTooLargeException extends __BaseException {
@@ -753,6 +807,9 @@ export declare class RequestEntityTooLargeException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<RequestEntityTooLargeException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateGroupRequest {
     /**
      * <p>The name for the group. It can include any Unicode characters.</p>
@@ -770,6 +827,7 @@ export interface CreateGroupRequest {
     Tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>This structure contains information about one group.</p>
  */
 export interface Group {
@@ -798,12 +856,18 @@ export interface Group {
      */
     LastModifiedTime?: Date;
 }
+/**
+ * @public
+ */
 export interface CreateGroupResponse {
     /**
      * <p>A structure that contains information about the group that was just created.</p>
      */
     Group?: Group;
 }
+/**
+ * @public
+ */
 export interface DeleteCanaryRequest {
     /**
      * <p>The name of the canary that you want to delete. To find the names of your canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">DescribeCanaries</a>.</p>
@@ -816,8 +880,14 @@ export interface DeleteCanaryRequest {
      */
     DeleteLambda?: boolean;
 }
+/**
+ * @public
+ */
 export interface DeleteCanaryResponse {
 }
+/**
+ * @public
+ */
 export interface DeleteGroupRequest {
     /**
      * <p>Specifies which group to delete. You can specify the group name, the ARN, or the
@@ -825,8 +895,14 @@ export interface DeleteGroupRequest {
      */
     GroupIdentifier: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteGroupResponse {
 }
+/**
+ * @public
+ */
 export interface DescribeCanariesRequest {
     /**
      * <p>A token that indicates that there is more data
@@ -852,6 +928,9 @@ export interface DescribeCanariesRequest {
      */
     Names?: string[];
 }
+/**
+ * @public
+ */
 export interface DescribeCanariesResponse {
     /**
      * <p>Returns an array. Each item in the array contains the full information about
@@ -865,6 +944,9 @@ export interface DescribeCanariesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeCanariesLastRunRequest {
     /**
      * <p>A token that indicates that there is more data
@@ -890,6 +972,9 @@ export interface DescribeCanariesLastRunRequest {
      */
     Names?: string[];
 }
+/**
+ * @public
+ */
 export interface DescribeCanariesLastRunResponse {
     /**
      * <p>An array that contains the information from the most recent run of each
@@ -903,6 +988,9 @@ export interface DescribeCanariesLastRunResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeRuntimeVersionsRequest {
     /**
      * <p>A token that indicates that there is more data
@@ -917,6 +1005,7 @@ export interface DescribeRuntimeVersionsRequest {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>This structure contains information about one canary runtime version. For 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>
@@ -941,6 +1030,9 @@ export interface RuntimeVersion {
      */
     DeprecationDate?: Date;
 }
+/**
+ * @public
+ */
 export interface DescribeRuntimeVersionsResponse {
     /**
      * <p>An array of objects that display the details about each Synthetics canary runtime
@@ -954,6 +1046,9 @@ export interface DescribeRuntimeVersionsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DisassociateResourceRequest {
     /**
      * <p>Specifies the group. You can specify the group name, the ARN, or the
@@ -965,20 +1060,32 @@ export interface DisassociateResourceRequest {
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DisassociateResourceResponse {
 }
+/**
+ * @public
+ */
 export interface GetCanaryRequest {
     /**
      * <p>The name of the canary that you want details for.</p>
      */
     Name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetCanaryResponse {
     /**
      * <p>A structure that contains the full information about the canary.</p>
      */
     Canary?: Canary;
 }
+/**
+ * @public
+ */
 export interface GetCanaryRunsRequest {
     /**
      * <p>The name of the canary that you want to see runs for.</p>
@@ -996,6 +1103,9 @@ export interface GetCanaryRunsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface GetCanaryRunsResponse {
     /**
      * <p>An array of structures. Each structure contains the details of one of the
@@ -1010,6 +1120,9 @@ export interface GetCanaryRunsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface GetGroupRequest {
     /**
      * <p>Specifies the group to return information for. You can specify the group name, the ARN, or the
@@ -1017,6 +1130,9 @@ export interface GetGroupRequest {
      */
     GroupIdentifier: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetGroupResponse {
     /**
      * <p>A structure that contains information about the group.</p>
@@ -1024,6 +1140,7 @@ export interface GetGroupResponse {
     Group?: Group;
 }
 /**
+ * @public
  * <p>A structure containing some information about a group.</p>
  */
 export interface GroupSummary {
@@ -1041,6 +1158,7 @@ export interface GroupSummary {
     Arn?: string;
 }
 /**
+ * @public
  * <p>An internal failure occurred. Try the operation again.</p>
  */
 export declare class InternalFailureException extends __BaseException {
@@ -1052,6 +1170,9 @@ export declare class InternalFailureException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ListAssociatedGroupsRequest {
     /**
      * <p>A token that indicates that there is more data
@@ -1069,6 +1190,9 @@ export interface ListAssociatedGroupsRequest {
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListAssociatedGroupsResponse {
     /**
      * <p>An array of structures that contain information about the groups that this canary is associated with.</p>
@@ -1081,6 +1205,9 @@ export interface ListAssociatedGroupsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListGroupResourcesRequest {
     /**
      * <p>A token that indicates that there is more data
@@ -1099,6 +1226,9 @@ export interface ListGroupResourcesRequest {
      */
     GroupIdentifier: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListGroupResourcesResponse {
     /**
      * <p>An array of ARNs. These ARNs are for the canaries that are associated with the group.</p>
@@ -1111,6 +1241,9 @@ export interface ListGroupResourcesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListGroupsRequest {
     /**
      * <p>A token that indicates that there is more data
@@ -1124,6 +1257,9 @@ export interface ListGroupsRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListGroupsResponse {
     /**
      * <p>An array of structures that each contain information about one group.</p>
@@ -1136,6 +1272,9 @@ export interface ListGroupsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of the canary or group that you want to view tags for.</p>
@@ -1149,6 +1288,9 @@ export interface ListTagsForResourceRequest {
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The list of tag keys and values associated with the resource that you specified.</p>
@@ -1156,6 +1298,7 @@ export interface ListTagsForResourceResponse {
     Tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The specified resource was not found.</p>
  */
 export declare class NotFoundException extends __BaseException {
@@ -1168,6 +1311,7 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>There were too many simultaneous requests. Try the operation again.</p>
  */
 export declare class TooManyRequestsException extends __BaseException {
@@ -1179,6 +1323,9 @@ export declare class TooManyRequestsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface StartCanaryRequest {
     /**
      * <p>The name of the canary that you want to run. To find
@@ -1186,8 +1333,14 @@ export interface StartCanaryRequest {
      */
     Name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StartCanaryResponse {
 }
+/**
+ * @public
+ */
 export interface StopCanaryRequest {
     /**
      * <p>The name of the canary that you want to stop. To find the names of your
@@ -1195,8 +1348,14 @@ export interface StopCanaryRequest {
      */
     Name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopCanaryResponse {
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of the canary or group that you're adding tags to.</p>
@@ -1214,8 +1373,14 @@ export interface TagResourceRequest {
      */
     Tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of the canary or group that you're removing tags from.</p>
@@ -1233,9 +1398,13 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
 /**
+ * @public
  * <p>An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can
  *          optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.</p>
  *
@@ -1259,6 +1428,9 @@ export interface VisualReferenceInput {
      */
     BaseCanaryRunId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateCanaryRequest {
     /**
      * <p>The name of the canary that you want to update. To find the names of your
@@ -1375,6 +1547,9 @@ export interface UpdateCanaryRequest {
      */
     ArtifactConfig?: ArtifactConfigInput;
 }
+/**
+ * @public
+ */
 export interface UpdateCanaryResponse {
 }
 /**

package/dist-types/pagination/DescribeCanariesLastRunPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { DescribeCanariesLastRunCommandInput, DescribeCanariesLastRunCommandOutput } from "../commands/DescribeCanariesLastRunCommand";
 import { SyntheticsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateDescribeCanariesLastRun(config: SyntheticsPaginationConfiguration, input: DescribeCanariesLastRunCommandInput, ...additionalArguments: any): Paginator<DescribeCanariesLastRunCommandOutput>;

package/dist-types/pagination/DescribeCanariesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { DescribeCanariesCommandInput, DescribeCanariesCommandOutput } from "../commands/DescribeCanariesCommand";
 import { SyntheticsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateDescribeCanaries(config: SyntheticsPaginationConfiguration, input: DescribeCanariesCommandInput, ...additionalArguments: any): Paginator<DescribeCanariesCommandOutput>;