@aws-sdk/client-ssm-contacts 3.296.0 → 3.298.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 (96) hide show
  1. package/dist-cjs/commands/AcceptPageCommand.js +2 -3
  2. package/dist-cjs/commands/ActivateContactChannelCommand.js +2 -3
  3. package/dist-cjs/commands/CreateContactChannelCommand.js +2 -3
  4. package/dist-cjs/commands/CreateContactCommand.js +2 -3
  5. package/dist-cjs/commands/DeactivateContactChannelCommand.js +2 -3
  6. package/dist-cjs/commands/DeleteContactChannelCommand.js +2 -3
  7. package/dist-cjs/commands/DeleteContactCommand.js +2 -3
  8. package/dist-cjs/commands/DescribeEngagementCommand.js +2 -3
  9. package/dist-cjs/commands/DescribePageCommand.js +2 -3
  10. package/dist-cjs/commands/GetContactChannelCommand.js +2 -3
  11. package/dist-cjs/commands/GetContactCommand.js +2 -3
  12. package/dist-cjs/commands/GetContactPolicyCommand.js +2 -3
  13. package/dist-cjs/commands/ListContactChannelsCommand.js +2 -3
  14. package/dist-cjs/commands/ListContactsCommand.js +2 -3
  15. package/dist-cjs/commands/ListEngagementsCommand.js +2 -3
  16. package/dist-cjs/commands/ListPageReceiptsCommand.js +2 -3
  17. package/dist-cjs/commands/ListPagesByContactCommand.js +2 -3
  18. package/dist-cjs/commands/ListPagesByEngagementCommand.js +2 -3
  19. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  20. package/dist-cjs/commands/PutContactPolicyCommand.js +2 -3
  21. package/dist-cjs/commands/SendActivationCodeCommand.js +2 -3
  22. package/dist-cjs/commands/StartEngagementCommand.js +2 -3
  23. package/dist-cjs/commands/StopEngagementCommand.js +2 -3
  24. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  25. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  26. package/dist-cjs/commands/UpdateContactChannelCommand.js +2 -3
  27. package/dist-cjs/commands/UpdateContactCommand.js +2 -3
  28. package/dist-cjs/models/models_0.js +1 -274
  29. package/dist-es/commands/AcceptPageCommand.js +2 -3
  30. package/dist-es/commands/ActivateContactChannelCommand.js +2 -3
  31. package/dist-es/commands/CreateContactChannelCommand.js +2 -3
  32. package/dist-es/commands/CreateContactCommand.js +2 -3
  33. package/dist-es/commands/DeactivateContactChannelCommand.js +2 -3
  34. package/dist-es/commands/DeleteContactChannelCommand.js +2 -3
  35. package/dist-es/commands/DeleteContactCommand.js +2 -3
  36. package/dist-es/commands/DescribeEngagementCommand.js +2 -3
  37. package/dist-es/commands/DescribePageCommand.js +2 -3
  38. package/dist-es/commands/GetContactChannelCommand.js +2 -3
  39. package/dist-es/commands/GetContactCommand.js +2 -3
  40. package/dist-es/commands/GetContactPolicyCommand.js +2 -3
  41. package/dist-es/commands/ListContactChannelsCommand.js +2 -3
  42. package/dist-es/commands/ListContactsCommand.js +2 -3
  43. package/dist-es/commands/ListEngagementsCommand.js +2 -3
  44. package/dist-es/commands/ListPageReceiptsCommand.js +2 -3
  45. package/dist-es/commands/ListPagesByContactCommand.js +2 -3
  46. package/dist-es/commands/ListPagesByEngagementCommand.js +2 -3
  47. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  48. package/dist-es/commands/PutContactPolicyCommand.js +2 -3
  49. package/dist-es/commands/SendActivationCodeCommand.js +2 -3
  50. package/dist-es/commands/StartEngagementCommand.js +2 -3
  51. package/dist-es/commands/StopEngagementCommand.js +2 -3
  52. package/dist-es/commands/TagResourceCommand.js +2 -3
  53. package/dist-es/commands/UntagResourceCommand.js +2 -3
  54. package/dist-es/commands/UpdateContactChannelCommand.js +2 -3
  55. package/dist-es/commands/UpdateContactCommand.js +2 -3
  56. package/dist-es/models/models_0.js +0 -204
  57. package/dist-types/SSMContacts.d.ts +28 -0
  58. package/dist-types/SSMContactsClient.d.ts +24 -4
  59. package/dist-types/commands/AcceptPageCommand.d.ts +16 -0
  60. package/dist-types/commands/ActivateContactChannelCommand.d.ts +16 -0
  61. package/dist-types/commands/CreateContactChannelCommand.d.ts +16 -0
  62. package/dist-types/commands/CreateContactCommand.d.ts +16 -0
  63. package/dist-types/commands/DeactivateContactChannelCommand.d.ts +16 -0
  64. package/dist-types/commands/DeleteContactChannelCommand.d.ts +16 -0
  65. package/dist-types/commands/DeleteContactCommand.d.ts +16 -0
  66. package/dist-types/commands/DescribeEngagementCommand.d.ts +16 -0
  67. package/dist-types/commands/DescribePageCommand.d.ts +16 -0
  68. package/dist-types/commands/GetContactChannelCommand.d.ts +16 -0
  69. package/dist-types/commands/GetContactCommand.d.ts +16 -0
  70. package/dist-types/commands/GetContactPolicyCommand.d.ts +16 -0
  71. package/dist-types/commands/ListContactChannelsCommand.d.ts +16 -0
  72. package/dist-types/commands/ListContactsCommand.d.ts +16 -0
  73. package/dist-types/commands/ListEngagementsCommand.d.ts +16 -0
  74. package/dist-types/commands/ListPageReceiptsCommand.d.ts +16 -0
  75. package/dist-types/commands/ListPagesByContactCommand.d.ts +16 -0
  76. package/dist-types/commands/ListPagesByEngagementCommand.d.ts +16 -0
  77. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  78. package/dist-types/commands/PutContactPolicyCommand.d.ts +16 -0
  79. package/dist-types/commands/SendActivationCodeCommand.d.ts +16 -0
  80. package/dist-types/commands/StartEngagementCommand.d.ts +16 -0
  81. package/dist-types/commands/StopEngagementCommand.d.ts +16 -0
  82. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  83. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  84. package/dist-types/commands/UpdateContactChannelCommand.d.ts +16 -0
  85. package/dist-types/commands/UpdateContactCommand.d.ts +16 -0
  86. package/dist-types/models/SSMContactsServiceException.d.ts +2 -0
  87. package/dist-types/models/models_0.d.ts +205 -272
  88. package/dist-types/pagination/Interfaces.d.ts +3 -0
  89. package/dist-types/pagination/ListContactChannelsPaginator.d.ts +3 -0
  90. package/dist-types/pagination/ListContactsPaginator.d.ts +3 -0
  91. package/dist-types/pagination/ListEngagementsPaginator.d.ts +3 -0
  92. package/dist-types/pagination/ListPageReceiptsPaginator.d.ts +3 -0
  93. package/dist-types/pagination/ListPagesByContactPaginator.d.ts +3 -0
  94. package/dist-types/pagination/ListPagesByEngagementPaginator.d.ts +3 -0
  95. package/dist-types/ts3.4/models/models_0.d.ts +0 -186
  96. package/package.json +4 -3
@@ -35,15 +35,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
35
35
  import { UpdateContactChannelCommandInput, UpdateContactChannelCommandOutput } from "./commands/UpdateContactChannelCommand";
36
36
  import { UpdateContactCommandInput, UpdateContactCommandOutput } from "./commands/UpdateContactCommand";
37
37
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
38
+ /**
39
+ * @public
40
+ */
38
41
  export type ServiceInputTypes = AcceptPageCommandInput | ActivateContactChannelCommandInput | CreateContactChannelCommandInput | CreateContactCommandInput | DeactivateContactChannelCommandInput | DeleteContactChannelCommandInput | DeleteContactCommandInput | DescribeEngagementCommandInput | DescribePageCommandInput | GetContactChannelCommandInput | GetContactCommandInput | GetContactPolicyCommandInput | ListContactChannelsCommandInput | ListContactsCommandInput | ListEngagementsCommandInput | ListPageReceiptsCommandInput | ListPagesByContactCommandInput | ListPagesByEngagementCommandInput | ListTagsForResourceCommandInput | PutContactPolicyCommandInput | SendActivationCodeCommandInput | StartEngagementCommandInput | StopEngagementCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateContactChannelCommandInput | UpdateContactCommandInput;
42
+ /**
43
+ * @public
44
+ */
39
45
  export type ServiceOutputTypes = AcceptPageCommandOutput | ActivateContactChannelCommandOutput | CreateContactChannelCommandOutput | CreateContactCommandOutput | DeactivateContactChannelCommandOutput | DeleteContactChannelCommandOutput | DeleteContactCommandOutput | DescribeEngagementCommandOutput | DescribePageCommandOutput | GetContactChannelCommandOutput | GetContactCommandOutput | GetContactPolicyCommandOutput | ListContactChannelsCommandOutput | ListContactsCommandOutput | ListEngagementsCommandOutput | ListPageReceiptsCommandOutput | ListPagesByContactCommandOutput | ListPagesByEngagementCommandOutput | ListTagsForResourceCommandOutput | PutContactPolicyCommandOutput | SendActivationCodeCommandOutput | StartEngagementCommandOutput | StopEngagementCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateContactChannelCommandOutput | UpdateContactCommandOutput;
46
+ /**
47
+ * @public
48
+ */
40
49
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
41
50
  /**
42
51
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
43
52
  */
44
53
  requestHandler?: __HttpHandler;
45
54
  /**
46
- * A constructor for a class implementing the {@link __Checksum} interface
55
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
47
56
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
48
57
  * @internal
49
58
  */
@@ -133,23 +142,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
133
142
  */
134
143
  logger?: __Logger;
135
144
  /**
136
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
145
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
137
146
  */
138
147
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
139
148
  }
149
+ /**
150
+ * @public
151
+ */
140
152
  type SSMContactsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
141
153
  /**
142
- * The configuration interface of SSMContactsClient class constructor that set the region, credentials and other options.
154
+ * @public
155
+ *
156
+ * The configuration interface of SSMContactsClient class constructor that set the region, credentials and other options.
143
157
  */
144
158
  export interface SSMContactsClientConfig extends SSMContactsClientConfigType {
145
159
  }
160
+ /**
161
+ * @public
162
+ */
146
163
  type SSMContactsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
147
164
  /**
148
- * The resolved configuration interface of SSMContactsClient class. This is resolved and normalized from the {@link SSMContactsClientConfig | constructor configuration interface}.
165
+ * @public
166
+ *
167
+ * The resolved configuration interface of SSMContactsClient class. This is resolved and normalized from the {@link SSMContactsClientConfig | constructor configuration interface}.
149
168
  */
150
169
  export interface SSMContactsClientResolvedConfig extends SSMContactsClientResolvedConfigType {
151
170
  }
152
171
  /**
172
+ * @public
153
173
  * <p>Systems Manager Incident Manager is an incident management console designed to help users
154
174
  * mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.
155
175
  * An incident is any unplanned interruption or reduction in quality of services. </p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AcceptPageRequest, AcceptPageResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AcceptPageCommand}.
8
10
  */
9
11
  export interface AcceptPageCommandInput extends AcceptPageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AcceptPageCommand}.
13
17
  */
14
18
  export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Used to acknowledge an engagement to a contact channel during an incident.</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 AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param AcceptPageCommandInput - {@link AcceptPageCommandInput}
34
+ * @returns {@link AcceptPageCommandOutput}
28
35
  * @see {@link AcceptPageCommandInput} for command's `input` shape.
29
36
  * @see {@link AcceptPageCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -64,11 +71,20 @@ export interface AcceptPageCommandOutput extends AcceptPageResult, __MetadataBea
64
71
  export declare class AcceptPageCommand extends $Command<AcceptPageCommandInput, AcceptPageCommandOutput, SSMContactsClientResolvedConfig> {
65
72
  readonly input: AcceptPageCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: AcceptPageCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AcceptPageCommandInput, AcceptPageCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ActivateContactChannelRequest, ActivateContactChannelResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ActivateContactChannelCommand}.
8
10
  */
9
11
  export interface ActivateContactChannelCommandInput extends ActivateContactChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ActivateContactChannelCommand}.
13
17
  */
14
18
  export interface ActivateContactChannelCommandOutput extends ActivateContactChannelResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Activates a contact's contact channel. Incident Manager can't engage a contact until the
18
23
  * contact channel has been activated.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ActivateContactChannelCommandInput - {@link ActivateContactChannelCommandInput}
35
+ * @returns {@link ActivateContactChannelCommandOutput}
29
36
  * @see {@link ActivateContactChannelCommandInput} for command's `input` shape.
30
37
  * @see {@link ActivateContactChannelCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -64,11 +71,20 @@ export interface ActivateContactChannelCommandOutput extends ActivateContactChan
64
71
  export declare class ActivateContactChannelCommand extends $Command<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
65
72
  readonly input: ActivateContactChannelCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: ActivateContactChannelCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ActivateContactChannelCommandInput, ActivateContactChannelCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateContactChannelRequest, CreateContactChannelResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateContactChannelCommand}.
8
10
  */
9
11
  export interface CreateContactChannelCommandInput extends CreateContactChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateContactChannelCommand}.
13
17
  */
14
18
  export interface CreateContactChannelCommandOutput extends CreateContactChannelResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A contact channel is the method that Incident Manager uses to engage your contact.</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 CreateContactChannelCommandOutput extends CreateContactChannelR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateContactChannelCommandInput - {@link CreateContactChannelCommandInput}
34
+ * @returns {@link CreateContactChannelCommandOutput}
28
35
  * @see {@link CreateContactChannelCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateContactChannelCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -75,11 +82,20 @@ export interface CreateContactChannelCommandOutput extends CreateContactChannelR
75
82
  export declare class CreateContactChannelCommand extends $Command<CreateContactChannelCommandInput, CreateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
76
83
  readonly input: CreateContactChannelCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: CreateContactChannelCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateContactChannelCommandInput, CreateContactChannelCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateContactRequest, CreateContactResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateContactCommand}.
8
10
  */
9
11
  export interface CreateContactCommandInput extends CreateContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateContactCommand}.
13
17
  */
14
18
  export interface CreateContactCommandOutput extends CreateContactResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Contacts are either the contacts that Incident Manager engages during an incident or the
18
23
  * escalation plans that Incident Manager uses to engage contacts in phases during an
19
24
  * incident. </p>
@@ -27,6 +32,8 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateContactCommandInput - {@link CreateContactCommandInput}
36
+ * @returns {@link CreateContactCommandOutput}
30
37
  * @see {@link CreateContactCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateContactCommandOutput} for command's `response` shape.
32
39
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -80,11 +87,20 @@ export interface CreateContactCommandOutput extends CreateContactResult, __Metad
80
87
  export declare class CreateContactCommand extends $Command<CreateContactCommandInput, CreateContactCommandOutput, SSMContactsClientResolvedConfig> {
81
88
  readonly input: CreateContactCommandInput;
82
89
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
83
93
  constructor(input: CreateContactCommandInput);
84
94
  /**
85
95
  * @internal
86
96
  */
87
97
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateContactCommandInput, CreateContactCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
88
101
  private serialize;
102
+ /**
103
+ * @internal
104
+ */
89
105
  private deserialize;
90
106
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeactivateContactChannelRequest, DeactivateContactChannelResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeactivateContactChannelCommand}.
8
10
  */
9
11
  export interface DeactivateContactChannelCommandInput extends DeactivateContactChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeactivateContactChannelCommand}.
13
17
  */
14
18
  export interface DeactivateContactChannelCommandOutput extends DeactivateContactChannelResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>To no longer receive Incident Manager engagements to a contact channel, you can deactivate
18
23
  * the channel.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeactivateContactChannelCommandInput - {@link DeactivateContactChannelCommandInput}
35
+ * @returns {@link DeactivateContactChannelCommandOutput}
29
36
  * @see {@link DeactivateContactChannelCommandInput} for command's `input` shape.
30
37
  * @see {@link DeactivateContactChannelCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -63,11 +70,20 @@ export interface DeactivateContactChannelCommandOutput extends DeactivateContact
63
70
  export declare class DeactivateContactChannelCommand extends $Command<DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
64
71
  readonly input: DeactivateContactChannelCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: DeactivateContactChannelCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeactivateContactChannelCommandInput, DeactivateContactChannelCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteContactChannelRequest, DeleteContactChannelResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteContactChannelCommand}.
8
10
  */
9
11
  export interface DeleteContactChannelCommandInput extends DeleteContactChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteContactChannelCommand}.
13
17
  */
14
18
  export interface DeleteContactChannelCommandOutput extends DeleteContactChannelResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>To no longer receive engagements on a contact channel, you can delete the channel from a
18
23
  * contact. Deleting the contact channel removes it from the contact's engagement plan. If you
19
24
  * delete the only contact channel for a contact, you won't be able to engage that contact
@@ -28,6 +33,8 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteContactChannelCommandInput - {@link DeleteContactChannelCommandInput}
37
+ * @returns {@link DeleteContactChannelCommandOutput}
31
38
  * @see {@link DeleteContactChannelCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteContactChannelCommandOutput} for command's `response` shape.
33
40
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -65,11 +72,20 @@ export interface DeleteContactChannelCommandOutput extends DeleteContactChannelR
65
72
  export declare class DeleteContactChannelCommand extends $Command<DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
66
73
  readonly input: DeleteContactChannelCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: DeleteContactChannelCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteContactChannelCommandInput, DeleteContactChannelCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteContactRequest, DeleteContactResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteContactCommand}.
8
10
  */
9
11
  export interface DeleteContactCommandInput extends DeleteContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteContactCommand}.
13
17
  */
14
18
  export interface DeleteContactCommandOutput extends DeleteContactResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>To remove a contact from Incident Manager, you can delete the contact. Deleting a contact
18
23
  * removes them from all escalation plans and related response plans. Deleting an escalation
19
24
  * plan removes it from all related response plans. You will have to recreate the contact and
@@ -28,6 +33,8 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteContactCommandInput - {@link DeleteContactCommandInput}
37
+ * @returns {@link DeleteContactCommandOutput}
31
38
  * @see {@link DeleteContactCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteContactCommandOutput} for command's `response` shape.
33
40
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -65,11 +72,20 @@ export interface DeleteContactCommandOutput extends DeleteContactResult, __Metad
65
72
  export declare class DeleteContactCommand extends $Command<DeleteContactCommandInput, DeleteContactCommandOutput, SSMContactsClientResolvedConfig> {
66
73
  readonly input: DeleteContactCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: DeleteContactCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteContactCommandInput, DeleteContactCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeEngagementRequest, DescribeEngagementResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEngagementCommand}.
8
10
  */
9
11
  export interface DescribeEngagementCommandInput extends DescribeEngagementRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEngagementCommand}.
13
17
  */
14
18
  export interface DescribeEngagementCommandOutput extends DescribeEngagementResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Incident Manager uses engagements to engage contacts and escalation plans during an incident.
18
23
  * Use this command to describe the engagement that occurred during an incident.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeEngagementCommandInput - {@link DescribeEngagementCommandInput}
35
+ * @returns {@link DescribeEngagementCommandOutput}
29
36
  * @see {@link DescribeEngagementCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeEngagementCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -78,11 +85,20 @@ export interface DescribeEngagementCommandOutput extends DescribeEngagementResul
78
85
  export declare class DescribeEngagementCommand extends $Command<DescribeEngagementCommandInput, DescribeEngagementCommandOutput, SSMContactsClientResolvedConfig> {
79
86
  readonly input: DescribeEngagementCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: DescribeEngagementCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEngagementCommandInput, DescribeEngagementCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribePageRequest, DescribePageResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribePageCommand}.
8
10
  */
9
11
  export interface DescribePageCommandInput extends DescribePageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribePageCommand}.
13
17
  */
14
18
  export interface DescribePageCommandOutput extends DescribePageResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists details of the engagement to a contact channel.</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 DescribePageCommandOutput extends DescribePageResult, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribePageCommandInput - {@link DescribePageCommandInput}
34
+ * @returns {@link DescribePageCommandOutput}
28
35
  * @see {@link DescribePageCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribePageCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -80,11 +87,20 @@ export interface DescribePageCommandOutput extends DescribePageResult, __Metadat
80
87
  export declare class DescribePageCommand extends $Command<DescribePageCommandInput, DescribePageCommandOutput, SSMContactsClientResolvedConfig> {
81
88
  readonly input: DescribePageCommandInput;
82
89
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
83
93
  constructor(input: DescribePageCommandInput);
84
94
  /**
85
95
  * @internal
86
96
  */
87
97
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePageCommandInput, DescribePageCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
88
101
  private serialize;
102
+ /**
103
+ * @internal
104
+ */
89
105
  private deserialize;
90
106
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetContactChannelRequest, GetContactChannelResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetContactChannelCommand}.
8
10
  */
9
11
  export interface GetContactChannelCommandInput extends GetContactChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetContactChannelCommand}.
13
17
  */
14
18
  export interface GetContactChannelCommandOutput extends GetContactChannelResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List details about a specific contact channel.</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 GetContactChannelCommandOutput extends GetContactChannelResult,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetContactChannelCommandInput - {@link GetContactChannelCommandInput}
34
+ * @returns {@link GetContactChannelCommandOutput}
28
35
  * @see {@link GetContactChannelCommandInput} for command's `input` shape.
29
36
  * @see {@link GetContactChannelCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -77,11 +84,20 @@ export interface GetContactChannelCommandOutput extends GetContactChannelResult,
77
84
  export declare class GetContactChannelCommand extends $Command<GetContactChannelCommandInput, GetContactChannelCommandOutput, SSMContactsClientResolvedConfig> {
78
85
  readonly input: GetContactChannelCommandInput;
79
86
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
87
+ /**
88
+ * @public
89
+ */
80
90
  constructor(input: GetContactChannelCommandInput);
81
91
  /**
82
92
  * @internal
83
93
  */
84
94
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetContactChannelCommandInput, GetContactChannelCommandOutput>;
95
+ /**
96
+ * @internal
97
+ */
85
98
  private serialize;
99
+ /**
100
+ * @internal
101
+ */
86
102
  private deserialize;
87
103
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetContactRequest, GetContactResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMContactsClientResolvedConfig } from "../SSMContactsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetContactCommand}.
8
10
  */
9
11
  export interface GetContactCommandInput extends GetContactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetContactCommand}.
13
17
  */
14
18
  export interface GetContactCommandOutput extends GetContactResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves information about the specified contact or escalation plan.</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 GetContactCommandOutput extends GetContactResult, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetContactCommandInput - {@link GetContactCommandInput}
34
+ * @returns {@link GetContactCommandOutput}
28
35
  * @see {@link GetContactCommandInput} for command's `input` shape.
29
36
  * @see {@link GetContactCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMContactsClientResolvedConfig | config} for SSMContactsClient's `config` shape.
@@ -166,11 +173,20 @@ export interface GetContactCommandOutput extends GetContactResult, __MetadataBea
166
173
  export declare class GetContactCommand extends $Command<GetContactCommandInput, GetContactCommandOutput, SSMContactsClientResolvedConfig> {
167
174
  readonly input: GetContactCommandInput;
168
175
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
176
+ /**
177
+ * @public
178
+ */
169
179
  constructor(input: GetContactCommandInput);
170
180
  /**
171
181
  * @internal
172
182
  */
173
183
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMContactsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetContactCommandInput, GetContactCommandOutput>;
184
+ /**
185
+ * @internal
186
+ */
174
187
  private serialize;
188
+ /**
189
+ * @internal
190
+ */
175
191
  private deserialize;
176
192
  }