@aws-sdk/client-synthetics 3.325.0 → 3.327.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -35,6 +35,8 @@ export interface AssociateResourceCommandOutput extends AssociateResourceRespons
35
35
  * };
36
36
  * const command = new AssociateResourceCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param AssociateResourceCommandInput - {@link AssociateResourceCommandInput}
@@ -58,6 +60,8 @@ export interface AssociateResourceCommandOutput extends AssociateResourceRespons
58
60
  * @throws {@link ValidationException} (client fault)
59
61
  * <p>A parameter could not be validated.</p>
60
62
  *
63
+ * @throws {@link SyntheticsServiceException}
64
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
61
65
  *
62
66
  */
63
67
  export declare class AssociateResourceCommand extends $Command<AssociateResourceCommandInput, AssociateResourceCommandOutput, SyntheticsClientResolvedConfig> {
@@ -85,6 +85,72 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
85
85
  * };
86
86
  * const command = new CreateCanaryCommand(input);
87
87
  * const response = await client.send(command);
88
+ * // { // CreateCanaryResponse
89
+ * // Canary: { // Canary
90
+ * // Id: "STRING_VALUE",
91
+ * // Name: "STRING_VALUE",
92
+ * // Code: { // CanaryCodeOutput
93
+ * // SourceLocationArn: "STRING_VALUE",
94
+ * // Handler: "STRING_VALUE",
95
+ * // },
96
+ * // ExecutionRoleArn: "STRING_VALUE",
97
+ * // Schedule: { // CanaryScheduleOutput
98
+ * // Expression: "STRING_VALUE",
99
+ * // DurationInSeconds: Number("long"),
100
+ * // },
101
+ * // RunConfig: { // CanaryRunConfigOutput
102
+ * // TimeoutInSeconds: Number("int"),
103
+ * // MemoryInMB: Number("int"),
104
+ * // ActiveTracing: true || false,
105
+ * // },
106
+ * // SuccessRetentionPeriodInDays: Number("int"),
107
+ * // FailureRetentionPeriodInDays: Number("int"),
108
+ * // Status: { // CanaryStatus
109
+ * // State: "STRING_VALUE",
110
+ * // StateReason: "STRING_VALUE",
111
+ * // StateReasonCode: "STRING_VALUE",
112
+ * // },
113
+ * // Timeline: { // CanaryTimeline
114
+ * // Created: new Date("TIMESTAMP"),
115
+ * // LastModified: new Date("TIMESTAMP"),
116
+ * // LastStarted: new Date("TIMESTAMP"),
117
+ * // LastStopped: new Date("TIMESTAMP"),
118
+ * // },
119
+ * // ArtifactS3Location: "STRING_VALUE",
120
+ * // EngineArn: "STRING_VALUE",
121
+ * // RuntimeVersion: "STRING_VALUE",
122
+ * // VpcConfig: { // VpcConfigOutput
123
+ * // VpcId: "STRING_VALUE",
124
+ * // SubnetIds: [ // SubnetIds
125
+ * // "STRING_VALUE",
126
+ * // ],
127
+ * // SecurityGroupIds: [ // SecurityGroupIds
128
+ * // "STRING_VALUE",
129
+ * // ],
130
+ * // },
131
+ * // VisualReference: { // VisualReferenceOutput
132
+ * // BaseScreenshots: [ // BaseScreenshots
133
+ * // { // BaseScreenshot
134
+ * // ScreenshotName: "STRING_VALUE", // required
135
+ * // IgnoreCoordinates: [ // BaseScreenshotIgnoreCoordinates
136
+ * // "STRING_VALUE",
137
+ * // ],
138
+ * // },
139
+ * // ],
140
+ * // BaseCanaryRunId: "STRING_VALUE",
141
+ * // },
142
+ * // Tags: { // TagMap
143
+ * // "<keys>": "STRING_VALUE",
144
+ * // },
145
+ * // ArtifactConfig: { // ArtifactConfigOutput
146
+ * // S3Encryption: { // S3EncryptionConfig
147
+ * // EncryptionMode: "STRING_VALUE",
148
+ * // KmsKeyArn: "STRING_VALUE",
149
+ * // },
150
+ * // },
151
+ * // },
152
+ * // };
153
+ *
88
154
  * ```
89
155
  *
90
156
  * @param CreateCanaryCommandInput - {@link CreateCanaryCommandInput}
@@ -102,6 +168,8 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
102
168
  * @throws {@link ValidationException} (client fault)
103
169
  * <p>A parameter could not be validated.</p>
104
170
  *
171
+ * @throws {@link SyntheticsServiceException}
172
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
105
173
  *
106
174
  */
107
175
  export declare class CreateCanaryCommand extends $Command<CreateCanaryCommandInput, CreateCanaryCommandOutput, SyntheticsClientResolvedConfig> {
@@ -46,6 +46,19 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
46
46
  * };
47
47
  * const command = new CreateGroupCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // CreateGroupResponse
50
+ * // Group: { // Group
51
+ * // Id: "STRING_VALUE",
52
+ * // Name: "STRING_VALUE",
53
+ * // Arn: "STRING_VALUE",
54
+ * // Tags: { // TagMap
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // CreatedTime: new Date("TIMESTAMP"),
58
+ * // LastModifiedTime: new Date("TIMESTAMP"),
59
+ * // },
60
+ * // };
61
+ *
49
62
  * ```
50
63
  *
51
64
  * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
@@ -66,6 +79,8 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
66
79
  * @throws {@link ValidationException} (client fault)
67
80
  * <p>A parameter could not be validated.</p>
68
81
  *
82
+ * @throws {@link SyntheticsServiceException}
83
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
69
84
  *
70
85
  */
71
86
  export declare class CreateGroupCommand extends $Command<CreateGroupCommandInput, CreateGroupCommandOutput, SyntheticsClientResolvedConfig> {
@@ -64,6 +64,8 @@ export interface DeleteCanaryCommandOutput extends DeleteCanaryResponse, __Metad
64
64
  * };
65
65
  * const command = new DeleteCanaryCommand(input);
66
66
  * const response = await client.send(command);
67
+ * // {};
68
+ *
67
69
  * ```
68
70
  *
69
71
  * @param DeleteCanaryCommandInput - {@link DeleteCanaryCommandInput}
@@ -84,6 +86,8 @@ export interface DeleteCanaryCommandOutput extends DeleteCanaryResponse, __Metad
84
86
  * @throws {@link ValidationException} (client fault)
85
87
  * <p>A parameter could not be validated.</p>
86
88
  *
89
+ * @throws {@link SyntheticsServiceException}
90
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
87
91
  *
88
92
  */
89
93
  export declare class DeleteCanaryCommand extends $Command<DeleteCanaryCommandInput, DeleteCanaryCommandOutput, SyntheticsClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
35
35
  * };
36
36
  * const command = new DeleteGroupCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
55
57
  * @throws {@link ValidationException} (client fault)
56
58
  * <p>A parameter could not be validated.</p>
57
59
  *
60
+ * @throws {@link SyntheticsServiceException}
61
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteGroupCommand extends $Command<DeleteGroupCommandInput, DeleteGroupCommandOutput, SyntheticsClientResolvedConfig> {
@@ -44,6 +44,75 @@ export interface DescribeCanariesCommandOutput extends DescribeCanariesResponse,
44
44
  * };
45
45
  * const command = new DescribeCanariesCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // DescribeCanariesResponse
48
+ * // Canaries: [ // Canaries
49
+ * // { // Canary
50
+ * // Id: "STRING_VALUE",
51
+ * // Name: "STRING_VALUE",
52
+ * // Code: { // CanaryCodeOutput
53
+ * // SourceLocationArn: "STRING_VALUE",
54
+ * // Handler: "STRING_VALUE",
55
+ * // },
56
+ * // ExecutionRoleArn: "STRING_VALUE",
57
+ * // Schedule: { // CanaryScheduleOutput
58
+ * // Expression: "STRING_VALUE",
59
+ * // DurationInSeconds: Number("long"),
60
+ * // },
61
+ * // RunConfig: { // CanaryRunConfigOutput
62
+ * // TimeoutInSeconds: Number("int"),
63
+ * // MemoryInMB: Number("int"),
64
+ * // ActiveTracing: true || false,
65
+ * // },
66
+ * // SuccessRetentionPeriodInDays: Number("int"),
67
+ * // FailureRetentionPeriodInDays: Number("int"),
68
+ * // Status: { // CanaryStatus
69
+ * // State: "STRING_VALUE",
70
+ * // StateReason: "STRING_VALUE",
71
+ * // StateReasonCode: "STRING_VALUE",
72
+ * // },
73
+ * // Timeline: { // CanaryTimeline
74
+ * // Created: new Date("TIMESTAMP"),
75
+ * // LastModified: new Date("TIMESTAMP"),
76
+ * // LastStarted: new Date("TIMESTAMP"),
77
+ * // LastStopped: new Date("TIMESTAMP"),
78
+ * // },
79
+ * // ArtifactS3Location: "STRING_VALUE",
80
+ * // EngineArn: "STRING_VALUE",
81
+ * // RuntimeVersion: "STRING_VALUE",
82
+ * // VpcConfig: { // VpcConfigOutput
83
+ * // VpcId: "STRING_VALUE",
84
+ * // SubnetIds: [ // SubnetIds
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // SecurityGroupIds: [ // SecurityGroupIds
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // },
91
+ * // VisualReference: { // VisualReferenceOutput
92
+ * // BaseScreenshots: [ // BaseScreenshots
93
+ * // { // BaseScreenshot
94
+ * // ScreenshotName: "STRING_VALUE", // required
95
+ * // IgnoreCoordinates: [ // BaseScreenshotIgnoreCoordinates
96
+ * // "STRING_VALUE",
97
+ * // ],
98
+ * // },
99
+ * // ],
100
+ * // BaseCanaryRunId: "STRING_VALUE",
101
+ * // },
102
+ * // Tags: { // TagMap
103
+ * // "<keys>": "STRING_VALUE",
104
+ * // },
105
+ * // ArtifactConfig: { // ArtifactConfigOutput
106
+ * // S3Encryption: { // S3EncryptionConfig
107
+ * // EncryptionMode: "STRING_VALUE",
108
+ * // KmsKeyArn: "STRING_VALUE",
109
+ * // },
110
+ * // },
111
+ * // },
112
+ * // ],
113
+ * // NextToken: "STRING_VALUE",
114
+ * // };
115
+ *
47
116
  * ```
48
117
  *
49
118
  * @param DescribeCanariesCommandInput - {@link DescribeCanariesCommandInput}
@@ -58,6 +127,8 @@ export interface DescribeCanariesCommandOutput extends DescribeCanariesResponse,
58
127
  * @throws {@link ValidationException} (client fault)
59
128
  * <p>A parameter could not be validated.</p>
60
129
  *
130
+ * @throws {@link SyntheticsServiceException}
131
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
61
132
  *
62
133
  */
63
134
  export declare class DescribeCanariesCommand extends $Command<DescribeCanariesCommandInput, DescribeCanariesCommandOutput, SyntheticsClientResolvedConfig> {
@@ -44,6 +44,29 @@ export interface DescribeCanariesLastRunCommandOutput extends DescribeCanariesLa
44
44
  * };
45
45
  * const command = new DescribeCanariesLastRunCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // DescribeCanariesLastRunResponse
48
+ * // CanariesLastRun: [ // CanariesLastRun
49
+ * // { // CanaryLastRun
50
+ * // CanaryName: "STRING_VALUE",
51
+ * // LastRun: { // CanaryRun
52
+ * // Id: "STRING_VALUE",
53
+ * // Name: "STRING_VALUE",
54
+ * // Status: { // CanaryRunStatus
55
+ * // State: "STRING_VALUE",
56
+ * // StateReason: "STRING_VALUE",
57
+ * // StateReasonCode: "STRING_VALUE",
58
+ * // },
59
+ * // Timeline: { // CanaryRunTimeline
60
+ * // Started: new Date("TIMESTAMP"),
61
+ * // Completed: new Date("TIMESTAMP"),
62
+ * // },
63
+ * // ArtifactS3Location: "STRING_VALUE",
64
+ * // },
65
+ * // },
66
+ * // ],
67
+ * // NextToken: "STRING_VALUE",
68
+ * // };
69
+ *
47
70
  * ```
48
71
  *
49
72
  * @param DescribeCanariesLastRunCommandInput - {@link DescribeCanariesLastRunCommandInput}
@@ -58,6 +81,8 @@ export interface DescribeCanariesLastRunCommandOutput extends DescribeCanariesLa
58
81
  * @throws {@link ValidationException} (client fault)
59
82
  * <p>A parameter could not be validated.</p>
60
83
  *
84
+ * @throws {@link SyntheticsServiceException}
85
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
61
86
  *
62
87
  */
63
88
  export declare class DescribeCanariesLastRunCommand extends $Command<DescribeCanariesLastRunCommandInput, DescribeCanariesLastRunCommandOutput, SyntheticsClientResolvedConfig> {
@@ -34,6 +34,18 @@ export interface DescribeRuntimeVersionsCommandOutput extends DescribeRuntimeVer
34
34
  * };
35
35
  * const command = new DescribeRuntimeVersionsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DescribeRuntimeVersionsResponse
38
+ * // RuntimeVersions: [ // RuntimeVersionList
39
+ * // { // RuntimeVersion
40
+ * // VersionName: "STRING_VALUE",
41
+ * // Description: "STRING_VALUE",
42
+ * // ReleaseDate: new Date("TIMESTAMP"),
43
+ * // DeprecationDate: new Date("TIMESTAMP"),
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param DescribeRuntimeVersionsCommandInput - {@link DescribeRuntimeVersionsCommandInput}
@@ -48,6 +60,8 @@ export interface DescribeRuntimeVersionsCommandOutput extends DescribeRuntimeVer
48
60
  * @throws {@link ValidationException} (client fault)
49
61
  * <p>A parameter could not be validated.</p>
50
62
  *
63
+ * @throws {@link SyntheticsServiceException}
64
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
51
65
  *
52
66
  */
53
67
  export declare class DescribeRuntimeVersionsCommand extends $Command<DescribeRuntimeVersionsCommandInput, DescribeRuntimeVersionsCommandOutput, SyntheticsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DisassociateResourceCommandOutput extends DisassociateResourceR
32
32
  * };
33
33
  * const command = new DisassociateResourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DisassociateResourceCommandInput - {@link DisassociateResourceCommandInput}
@@ -52,6 +54,8 @@ export interface DisassociateResourceCommandOutput extends DisassociateResourceR
52
54
  * @throws {@link ValidationException} (client fault)
53
55
  * <p>A parameter could not be validated.</p>
54
56
  *
57
+ * @throws {@link SyntheticsServiceException}
58
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DisassociateResourceCommand extends $Command<DisassociateResourceCommandInput, DisassociateResourceCommandOutput, SyntheticsClientResolvedConfig> {
@@ -33,6 +33,72 @@ export interface GetCanaryCommandOutput extends GetCanaryResponse, __MetadataBea
33
33
  * };
34
34
  * const command = new GetCanaryCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetCanaryResponse
37
+ * // Canary: { // Canary
38
+ * // Id: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // Code: { // CanaryCodeOutput
41
+ * // SourceLocationArn: "STRING_VALUE",
42
+ * // Handler: "STRING_VALUE",
43
+ * // },
44
+ * // ExecutionRoleArn: "STRING_VALUE",
45
+ * // Schedule: { // CanaryScheduleOutput
46
+ * // Expression: "STRING_VALUE",
47
+ * // DurationInSeconds: Number("long"),
48
+ * // },
49
+ * // RunConfig: { // CanaryRunConfigOutput
50
+ * // TimeoutInSeconds: Number("int"),
51
+ * // MemoryInMB: Number("int"),
52
+ * // ActiveTracing: true || false,
53
+ * // },
54
+ * // SuccessRetentionPeriodInDays: Number("int"),
55
+ * // FailureRetentionPeriodInDays: Number("int"),
56
+ * // Status: { // CanaryStatus
57
+ * // State: "STRING_VALUE",
58
+ * // StateReason: "STRING_VALUE",
59
+ * // StateReasonCode: "STRING_VALUE",
60
+ * // },
61
+ * // Timeline: { // CanaryTimeline
62
+ * // Created: new Date("TIMESTAMP"),
63
+ * // LastModified: new Date("TIMESTAMP"),
64
+ * // LastStarted: new Date("TIMESTAMP"),
65
+ * // LastStopped: new Date("TIMESTAMP"),
66
+ * // },
67
+ * // ArtifactS3Location: "STRING_VALUE",
68
+ * // EngineArn: "STRING_VALUE",
69
+ * // RuntimeVersion: "STRING_VALUE",
70
+ * // VpcConfig: { // VpcConfigOutput
71
+ * // VpcId: "STRING_VALUE",
72
+ * // SubnetIds: [ // SubnetIds
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // SecurityGroupIds: [ // SecurityGroupIds
76
+ * // "STRING_VALUE",
77
+ * // ],
78
+ * // },
79
+ * // VisualReference: { // VisualReferenceOutput
80
+ * // BaseScreenshots: [ // BaseScreenshots
81
+ * // { // BaseScreenshot
82
+ * // ScreenshotName: "STRING_VALUE", // required
83
+ * // IgnoreCoordinates: [ // BaseScreenshotIgnoreCoordinates
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // },
87
+ * // ],
88
+ * // BaseCanaryRunId: "STRING_VALUE",
89
+ * // },
90
+ * // Tags: { // TagMap
91
+ * // "<keys>": "STRING_VALUE",
92
+ * // },
93
+ * // ArtifactConfig: { // ArtifactConfigOutput
94
+ * // S3Encryption: { // S3EncryptionConfig
95
+ * // EncryptionMode: "STRING_VALUE",
96
+ * // KmsKeyArn: "STRING_VALUE",
97
+ * // },
98
+ * // },
99
+ * // },
100
+ * // };
101
+ *
36
102
  * ```
37
103
  *
38
104
  * @param GetCanaryCommandInput - {@link GetCanaryCommandInput}
@@ -47,6 +113,8 @@ export interface GetCanaryCommandOutput extends GetCanaryResponse, __MetadataBea
47
113
  * @throws {@link ValidationException} (client fault)
48
114
  * <p>A parameter could not be validated.</p>
49
115
  *
116
+ * @throws {@link SyntheticsServiceException}
117
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
50
118
  *
51
119
  */
52
120
  export declare class GetCanaryCommand extends $Command<GetCanaryCommandInput, GetCanaryCommandOutput, SyntheticsClientResolvedConfig> {
@@ -33,6 +33,26 @@ export interface GetCanaryRunsCommandOutput extends GetCanaryRunsResponse, __Met
33
33
  * };
34
34
  * const command = new GetCanaryRunsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetCanaryRunsResponse
37
+ * // CanaryRuns: [ // CanaryRuns
38
+ * // { // CanaryRun
39
+ * // Id: "STRING_VALUE",
40
+ * // Name: "STRING_VALUE",
41
+ * // Status: { // CanaryRunStatus
42
+ * // State: "STRING_VALUE",
43
+ * // StateReason: "STRING_VALUE",
44
+ * // StateReasonCode: "STRING_VALUE",
45
+ * // },
46
+ * // Timeline: { // CanaryRunTimeline
47
+ * // Started: new Date("TIMESTAMP"),
48
+ * // Completed: new Date("TIMESTAMP"),
49
+ * // },
50
+ * // ArtifactS3Location: "STRING_VALUE",
51
+ * // },
52
+ * // ],
53
+ * // NextToken: "STRING_VALUE",
54
+ * // };
55
+ *
36
56
  * ```
37
57
  *
38
58
  * @param GetCanaryRunsCommandInput - {@link GetCanaryRunsCommandInput}
@@ -50,6 +70,8 @@ export interface GetCanaryRunsCommandOutput extends GetCanaryRunsResponse, __Met
50
70
  * @throws {@link ValidationException} (client fault)
51
71
  * <p>A parameter could not be validated.</p>
52
72
  *
73
+ * @throws {@link SyntheticsServiceException}
74
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
53
75
  *
54
76
  */
55
77
  export declare class GetCanaryRunsCommand extends $Command<GetCanaryRunsCommandInput, GetCanaryRunsCommandOutput, SyntheticsClientResolvedConfig> {
@@ -32,6 +32,19 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
32
32
  * };
33
33
  * const command = new GetGroupCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetGroupResponse
36
+ * // Group: { // Group
37
+ * // Id: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // Arn: "STRING_VALUE",
40
+ * // Tags: { // TagMap
41
+ * // "<keys>": "STRING_VALUE",
42
+ * // },
43
+ * // CreatedTime: new Date("TIMESTAMP"),
44
+ * // LastModifiedTime: new Date("TIMESTAMP"),
45
+ * // },
46
+ * // };
47
+ *
35
48
  * ```
36
49
  *
37
50
  * @param GetGroupCommandInput - {@link GetGroupCommandInput}
@@ -52,6 +65,8 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
52
65
  * @throws {@link ValidationException} (client fault)
53
66
  * <p>A parameter could not be validated.</p>
54
67
  *
68
+ * @throws {@link SyntheticsServiceException}
69
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
55
70
  *
56
71
  */
57
72
  export declare class GetGroupCommand extends $Command<GetGroupCommandInput, GetGroupCommandOutput, SyntheticsClientResolvedConfig> {
@@ -34,6 +34,17 @@ export interface ListAssociatedGroupsCommandOutput extends ListAssociatedGroupsR
34
34
  * };
35
35
  * const command = new ListAssociatedGroupsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListAssociatedGroupsResponse
38
+ * // Groups: [ // GroupSummaryList
39
+ * // { // GroupSummary
40
+ * // Id: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Arn: "STRING_VALUE",
43
+ * // },
44
+ * // ],
45
+ * // NextToken: "STRING_VALUE",
46
+ * // };
47
+ *
37
48
  * ```
38
49
  *
39
50
  * @param ListAssociatedGroupsCommandInput - {@link ListAssociatedGroupsCommandInput}
@@ -51,6 +62,8 @@ export interface ListAssociatedGroupsCommandOutput extends ListAssociatedGroupsR
51
62
  * @throws {@link ValidationException} (client fault)
52
63
  * <p>A parameter could not be validated.</p>
53
64
  *
65
+ * @throws {@link SyntheticsServiceException}
66
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
54
67
  *
55
68
  */
56
69
  export declare class ListAssociatedGroupsCommand extends $Command<ListAssociatedGroupsCommandInput, ListAssociatedGroupsCommandOutput, SyntheticsClientResolvedConfig> {
@@ -33,6 +33,13 @@ export interface ListGroupResourcesCommandOutput extends ListGroupResourcesRespo
33
33
  * };
34
34
  * const command = new ListGroupResourcesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListGroupResourcesResponse
37
+ * // Resources: [ // StringList
38
+ * // "STRING_VALUE",
39
+ * // ],
40
+ * // NextToken: "STRING_VALUE",
41
+ * // };
42
+ *
36
43
  * ```
37
44
  *
38
45
  * @param ListGroupResourcesCommandInput - {@link ListGroupResourcesCommandInput}
@@ -53,6 +60,8 @@ export interface ListGroupResourcesCommandOutput extends ListGroupResourcesRespo
53
60
  * @throws {@link ValidationException} (client fault)
54
61
  * <p>A parameter could not be validated.</p>
55
62
  *
63
+ * @throws {@link SyntheticsServiceException}
64
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
56
65
  *
57
66
  */
58
67
  export declare class ListGroupResourcesCommand extends $Command<ListGroupResourcesCommandInput, ListGroupResourcesCommandOutput, SyntheticsClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
33
33
  * };
34
34
  * const command = new ListGroupsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListGroupsResponse
37
+ * // Groups: [ // GroupSummaryList
38
+ * // { // GroupSummary
39
+ * // Id: "STRING_VALUE",
40
+ * // Name: "STRING_VALUE",
41
+ * // Arn: "STRING_VALUE",
42
+ * // },
43
+ * // ],
44
+ * // NextToken: "STRING_VALUE",
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param ListGroupsCommandInput - {@link ListGroupsCommandInput}
@@ -47,6 +58,8 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
47
58
  * @throws {@link ValidationException} (client fault)
48
59
  * <p>A parameter could not be validated.</p>
49
60
  *
61
+ * @throws {@link SyntheticsServiceException}
62
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
50
63
  *
51
64
  */
52
65
  export declare class ListGroupsCommand extends $Command<ListGroupsCommandInput, ListGroupsCommandOutput, SyntheticsClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // Tags: { // TagMap
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -54,6 +60,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
54
60
  * @throws {@link TooManyRequestsException} (client fault)
55
61
  * <p>There were too many simultaneous requests. Try the operation again.</p>
56
62
  *
63
+ * @throws {@link SyntheticsServiceException}
64
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
57
65
  *
58
66
  */
59
67
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SyntheticsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface StartCanaryCommandOutput extends StartCanaryResponse, __Metadat
33
33
  * };
34
34
  * const command = new StartCanaryCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param StartCanaryCommandInput - {@link StartCanaryCommandInput}
@@ -53,6 +55,8 @@ export interface StartCanaryCommandOutput extends StartCanaryResponse, __Metadat
53
55
  * @throws {@link ValidationException} (client fault)
54
56
  * <p>A parameter could not be validated.</p>
55
57
  *
58
+ * @throws {@link SyntheticsServiceException}
59
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
56
60
  *
57
61
  */
58
62
  export declare class StartCanaryCommand extends $Command<StartCanaryCommandInput, StartCanaryCommandOutput, SyntheticsClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface StopCanaryCommandOutput extends StopCanaryResponse, __MetadataB
35
35
  * };
36
36
  * const command = new StopCanaryCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param StopCanaryCommandInput - {@link StopCanaryCommandInput}
@@ -55,6 +57,8 @@ export interface StopCanaryCommandOutput extends StopCanaryResponse, __MetadataB
55
57
  * @throws {@link ValidationException} (client fault)
56
58
  * <p>A parameter could not be validated.</p>
57
59
  *
60
+ * @throws {@link SyntheticsServiceException}
61
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
58
62
  *
59
63
  */
60
64
  export declare class StopCanaryCommand extends $Command<StopCanaryCommandInput, StopCanaryCommandOutput, SyntheticsClientResolvedConfig> {
@@ -45,6 +45,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
45
45
  * };
46
46
  * const command = new TagResourceCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -68,6 +70,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
68
70
  * @throws {@link TooManyRequestsException} (client fault)
69
71
  * <p>There were too many simultaneous requests. Try the operation again.</p>
70
72
  *
73
+ * @throws {@link SyntheticsServiceException}
74
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
71
75
  *
72
76
  */
73
77
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SyntheticsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -57,6 +59,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
57
59
  * @throws {@link TooManyRequestsException} (client fault)
58
60
  * <p>There were too many simultaneous requests. Try the operation again.</p>
59
61
  *
62
+ * @throws {@link SyntheticsServiceException}
63
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
60
64
  *
61
65
  */
62
66
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SyntheticsClientResolvedConfig> {
@@ -84,6 +84,8 @@ export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __Metad
84
84
  * };
85
85
  * const command = new UpdateCanaryCommand(input);
86
86
  * const response = await client.send(command);
87
+ * // {};
88
+ *
87
89
  * ```
88
90
  *
89
91
  * @param UpdateCanaryCommandInput - {@link UpdateCanaryCommandInput}
@@ -107,6 +109,8 @@ export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __Metad
107
109
  * @throws {@link ValidationException} (client fault)
108
110
  * <p>A parameter could not be validated.</p>
109
111
  *
112
+ * @throws {@link SyntheticsServiceException}
113
+ * <p>Base exception class for all service exceptions from Synthetics service.</p>
110
114
  *
111
115
  */
112
116
  export declare class UpdateCanaryCommand extends $Command<UpdateCanaryCommandInput, UpdateCanaryCommandOutput, SyntheticsClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-synthetics",
3
3
  "description": "AWS SDK for JavaScript Synthetics Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.327.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",