@aws-sdk/client-synthetics 3.295.0 → 3.297.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.
Files changed (34) hide show
  1. package/dist-types/Synthetics.d.ts +22 -0
  2. package/dist-types/SyntheticsClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateResourceCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateCanaryCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteCanaryCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeCanariesCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeCanariesLastRunCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeRuntimeVersionsCommand.d.ts +16 -0
  11. package/dist-types/commands/DisassociateResourceCommand.d.ts +16 -0
  12. package/dist-types/commands/GetCanaryCommand.d.ts +16 -0
  13. package/dist-types/commands/GetCanaryRunsCommand.d.ts +16 -0
  14. package/dist-types/commands/GetGroupCommand.d.ts +16 -0
  15. package/dist-types/commands/ListAssociatedGroupsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListGroupResourcesCommand.d.ts +16 -0
  17. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/StartCanaryCommand.d.ts +16 -0
  20. package/dist-types/commands/StopCanaryCommand.d.ts +16 -0
  21. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  22. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/UpdateCanaryCommand.d.ts +16 -0
  24. package/dist-types/models/SyntheticsServiceException.d.ts +2 -0
  25. package/dist-types/models/models_0.d.ts +176 -1
  26. package/dist-types/pagination/DescribeCanariesLastRunPaginator.d.ts +3 -0
  27. package/dist-types/pagination/DescribeCanariesPaginator.d.ts +3 -0
  28. package/dist-types/pagination/DescribeRuntimeVersionsPaginator.d.ts +3 -0
  29. package/dist-types/pagination/GetCanaryRunsPaginator.d.ts +3 -0
  30. package/dist-types/pagination/Interfaces.d.ts +3 -0
  31. package/dist-types/pagination/ListAssociatedGroupsPaginator.d.ts +3 -0
  32. package/dist-types/pagination/ListGroupResourcesPaginator.d.ts +3 -0
  33. package/dist-types/pagination/ListGroupsPaginator.d.ts +3 -0
  34. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DisassociateResourceRequest, DisassociateResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateResourceCommand}.
8
10
  */
9
11
  export interface DisassociateResourceCommandInput extends DisassociateResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateResourceCommand}.
13
17
  */
14
18
  export interface DisassociateResourceCommandOutput extends DisassociateResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a canary from a group. You must run this operation in the Region where the canary exists.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DisassociateResourceCommandOutput extends DisassociateResourceR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DisassociateResourceCommandInput - {@link DisassociateResourceCommandInput}
34
+ * @returns {@link DisassociateResourceCommandOutput}
28
35
  * @see {@link DisassociateResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link DisassociateResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DisassociateResourceCommandOutput extends DisassociateResourceR
46
53
  export declare class DisassociateResourceCommand extends $Command<DisassociateResourceCommandInput, DisassociateResourceCommandOutput, SyntheticsClientResolvedConfig> {
47
54
  readonly input: DisassociateResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DisassociateResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateResourceCommandInput, DisassociateResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetCanaryRequest, GetCanaryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCanaryCommand}.
8
10
  */
9
11
  export interface GetCanaryCommandInput extends GetCanaryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCanaryCommand}.
13
17
  */
14
18
  export interface GetCanaryCommandOutput extends GetCanaryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves complete information about one canary. You must specify
18
23
  * the name of the canary that you want. To get a list of canaries
19
24
  * and their names, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">DescribeCanaries</a>.</p>
@@ -27,6 +32,8 @@ export interface GetCanaryCommandOutput extends GetCanaryResponse, __MetadataBea
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetCanaryCommandInput - {@link GetCanaryCommandInput}
36
+ * @returns {@link GetCanaryCommandOutput}
30
37
  * @see {@link GetCanaryCommandInput} for command's `input` shape.
31
38
  * @see {@link GetCanaryCommandOutput} for command's `response` shape.
32
39
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -42,11 +49,20 @@ export interface GetCanaryCommandOutput extends GetCanaryResponse, __MetadataBea
42
49
  export declare class GetCanaryCommand extends $Command<GetCanaryCommandInput, GetCanaryCommandOutput, SyntheticsClientResolvedConfig> {
43
50
  readonly input: GetCanaryCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: GetCanaryCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCanaryCommandInput, GetCanaryCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetCanaryRunsRequest, GetCanaryRunsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCanaryRunsCommand}.
8
10
  */
9
11
  export interface GetCanaryRunsCommandInput extends GetCanaryRunsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCanaryRunsCommand}.
13
17
  */
14
18
  export interface GetCanaryRunsCommandOutput extends GetCanaryRunsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a list of runs for a specified canary.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetCanaryRunsCommandOutput extends GetCanaryRunsResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetCanaryRunsCommandInput - {@link GetCanaryRunsCommandInput}
34
+ * @returns {@link GetCanaryRunsCommandOutput}
28
35
  * @see {@link GetCanaryRunsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetCanaryRunsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetCanaryRunsCommandOutput extends GetCanaryRunsResponse, __Met
43
50
  export declare class GetCanaryRunsCommand extends $Command<GetCanaryRunsCommandInput, GetCanaryRunsCommandOutput, SyntheticsClientResolvedConfig> {
44
51
  readonly input: GetCanaryRunsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetCanaryRunsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCanaryRunsCommandInput, GetCanaryRunsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetGroupRequest, GetGroupResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetGroupCommand}.
8
10
  */
9
11
  export interface GetGroupCommandInput extends GetGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetGroupCommand}.
13
17
  */
14
18
  export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about one group. Groups are a global resource, so you can use this operation from
18
23
  * any Region.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetGroupCommandInput - {@link GetGroupCommandInput}
35
+ * @returns {@link GetGroupCommandOutput}
29
36
  * @see {@link GetGroupCommandInput} for command's `input` shape.
30
37
  * @see {@link GetGroupCommandOutput} for command's `response` shape.
31
38
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -47,11 +54,20 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
47
54
  export declare class GetGroupCommand extends $Command<GetGroupCommandInput, GetGroupCommandOutput, SyntheticsClientResolvedConfig> {
48
55
  readonly input: GetGroupCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetGroupCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetGroupCommandInput, GetGroupCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListAssociatedGroupsRequest, ListAssociatedGroupsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAssociatedGroupsCommand}.
8
10
  */
9
11
  export interface ListAssociatedGroupsCommandInput extends ListAssociatedGroupsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAssociatedGroupsCommand}.
13
17
  */
14
18
  export interface ListAssociatedGroupsCommandOutput extends ListAssociatedGroupsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of the groups that the specified canary is associated with. The canary
18
23
  * that you specify must be in the current Region.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListAssociatedGroupsCommandOutput extends ListAssociatedGroupsR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListAssociatedGroupsCommandInput - {@link ListAssociatedGroupsCommandInput}
35
+ * @returns {@link ListAssociatedGroupsCommandOutput}
29
36
  * @see {@link ListAssociatedGroupsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListAssociatedGroupsCommandOutput} for command's `response` shape.
31
38
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListAssociatedGroupsCommandOutput extends ListAssociatedGroupsR
44
51
  export declare class ListAssociatedGroupsCommand extends $Command<ListAssociatedGroupsCommandInput, ListAssociatedGroupsCommandOutput, SyntheticsClientResolvedConfig> {
45
52
  readonly input: ListAssociatedGroupsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListAssociatedGroupsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAssociatedGroupsCommandInput, ListAssociatedGroupsCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListGroupResourcesRequest, ListGroupResourcesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListGroupResourcesCommand}.
8
10
  */
9
11
  export interface ListGroupResourcesCommandInput extends ListGroupResourcesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListGroupResourcesCommand}.
13
17
  */
14
18
  export interface ListGroupResourcesCommandOutput extends ListGroupResourcesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>This operation returns a list of the ARNs of the canaries that are associated with the specified group.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListGroupResourcesCommandOutput extends ListGroupResourcesRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListGroupResourcesCommandInput - {@link ListGroupResourcesCommandInput}
34
+ * @returns {@link ListGroupResourcesCommandOutput}
28
35
  * @see {@link ListGroupResourcesCommandInput} for command's `input` shape.
29
36
  * @see {@link ListGroupResourcesCommandOutput} for command's `response` shape.
30
37
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListGroupResourcesCommandOutput extends ListGroupResourcesRespo
46
53
  export declare class ListGroupResourcesCommand extends $Command<ListGroupResourcesCommandInput, ListGroupResourcesCommandOutput, SyntheticsClientResolvedConfig> {
47
54
  readonly input: ListGroupResourcesCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListGroupResourcesCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGroupResourcesCommandInput, ListGroupResourcesCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListGroupsRequest, ListGroupsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListGroupsCommand}.
8
10
  */
9
11
  export interface ListGroupsCommandInput extends ListGroupsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListGroupsCommand}.
13
17
  */
14
18
  export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups
18
23
  * from all Regions are returned.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListGroupsCommandInput - {@link ListGroupsCommandInput}
35
+ * @returns {@link ListGroupsCommandOutput}
29
36
  * @see {@link ListGroupsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListGroupsCommandOutput} for command's `response` shape.
31
38
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -41,11 +48,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
41
48
  export declare class ListGroupsCommand extends $Command<ListGroupsCommandInput, ListGroupsCommandOutput, SyntheticsClientResolvedConfig> {
42
49
  readonly input: ListGroupsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: ListGroupsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGroupsCommandInput, ListGroupsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Displays the tags associated with a canary or group.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
49
56
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SyntheticsClientResolvedConfig> {
50
57
  readonly input: ListTagsForResourceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: ListTagsForResourceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartCanaryRequest, StartCanaryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartCanaryCommand}.
8
10
  */
9
11
  export interface StartCanaryCommandInput extends StartCanaryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartCanaryCommand}.
13
17
  */
14
18
  export interface StartCanaryCommandOutput extends StartCanaryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Use this operation to run a canary that has already been created.
18
23
  * The frequency of the canary runs is determined by the value of the canary's <code>Schedule</code>. To see a canary's schedule,
19
24
  * use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanary.html">GetCanary</a>.</p>
@@ -27,6 +32,8 @@ export interface StartCanaryCommandOutput extends StartCanaryResponse, __Metadat
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param StartCanaryCommandInput - {@link StartCanaryCommandInput}
36
+ * @returns {@link StartCanaryCommandOutput}
30
37
  * @see {@link StartCanaryCommandInput} for command's `input` shape.
31
38
  * @see {@link StartCanaryCommandOutput} for command's `response` shape.
32
39
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -48,11 +55,20 @@ export interface StartCanaryCommandOutput extends StartCanaryResponse, __Metadat
48
55
  export declare class StartCanaryCommand extends $Command<StartCanaryCommandInput, StartCanaryCommandOutput, SyntheticsClientResolvedConfig> {
49
56
  readonly input: StartCanaryCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: StartCanaryCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartCanaryCommandInput, StartCanaryCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StopCanaryRequest, StopCanaryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopCanaryCommand}.
8
10
  */
9
11
  export interface StopCanaryCommandInput extends StopCanaryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopCanaryCommand}.
13
17
  */
14
18
  export interface StopCanaryCommandOutput extends StopCanaryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Stops the canary to prevent all future runs. If the canary is currently running,the
18
23
  * run that is in progress completes on its own, publishes metrics, and uploads artifacts, but
19
24
  * it is not recorded in Synthetics as a completed run.</p>
@@ -29,6 +34,8 @@ export interface StopCanaryCommandOutput extends StopCanaryResponse, __MetadataB
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param StopCanaryCommandInput - {@link StopCanaryCommandInput}
38
+ * @returns {@link StopCanaryCommandOutput}
32
39
  * @see {@link StopCanaryCommandInput} for command's `input` shape.
33
40
  * @see {@link StopCanaryCommandOutput} for command's `response` shape.
34
41
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -50,11 +57,20 @@ export interface StopCanaryCommandOutput extends StopCanaryResponse, __MetadataB
50
57
  export declare class StopCanaryCommand extends $Command<StopCanaryCommandInput, StopCanaryCommandOutput, SyntheticsClientResolvedConfig> {
51
58
  readonly input: StopCanaryCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: StopCanaryCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopCanaryCommandInput, StopCanaryCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Assigns one or more tags (key-value pairs) to the specified canary or group. </p>
18
23
  * <p>Tags can help you organize and categorize your
19
24
  * resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with
@@ -36,6 +41,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
45
+ * @returns {@link TagResourceCommandOutput}
39
46
  * @see {@link TagResourceCommandInput} for command's `input` shape.
40
47
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
41
48
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -60,11 +67,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
60
67
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SyntheticsClientResolvedConfig> {
61
68
  readonly input: TagResourceCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: TagResourceCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes one or more tags from the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
49
56
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SyntheticsClientResolvedConfig> {
50
57
  readonly input: UntagResourceCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: UntagResourceCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateCanaryRequest, UpdateCanaryResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SyntheticsClientResolvedConfig } from "../SyntheticsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateCanaryCommand}.
8
10
  */
9
11
  export interface UpdateCanaryCommandInput extends UpdateCanaryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateCanaryCommand}.
13
17
  */
14
18
  export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the configuration of a canary that has
18
23
  * already been created.</p>
19
24
  * <p>You can't use this operation to update the tags of an existing canary. To
@@ -29,6 +34,8 @@ export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __Metad
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param UpdateCanaryCommandInput - {@link UpdateCanaryCommandInput}
38
+ * @returns {@link UpdateCanaryCommandOutput}
32
39
  * @see {@link UpdateCanaryCommandInput} for command's `input` shape.
33
40
  * @see {@link UpdateCanaryCommandOutput} for command's `response` shape.
34
41
  * @see {@link SyntheticsClientResolvedConfig | config} for SyntheticsClient's `config` shape.
@@ -53,11 +60,20 @@ export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __Metad
53
60
  export declare class UpdateCanaryCommand extends $Command<UpdateCanaryCommandInput, UpdateCanaryCommandOutput, SyntheticsClientResolvedConfig> {
54
61
  readonly input: UpdateCanaryCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: UpdateCanaryCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SyntheticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCanaryCommandInput, UpdateCanaryCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }