@aws-sdk/client-connectcampaigns 3.296.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 (29) hide show
  1. package/dist-types/ConnectCampaigns.d.ts +23 -0
  2. package/dist-types/ConnectCampaignsClient.d.ts +24 -4
  3. package/dist-types/commands/CreateCampaignCommand.d.ts +16 -0
  4. package/dist-types/commands/DeleteCampaignCommand.d.ts +16 -0
  5. package/dist-types/commands/DeleteConnectInstanceConfigCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteInstanceOnboardingJobCommand.d.ts +16 -0
  7. package/dist-types/commands/DescribeCampaignCommand.d.ts +16 -0
  8. package/dist-types/commands/GetCampaignStateBatchCommand.d.ts +16 -0
  9. package/dist-types/commands/GetCampaignStateCommand.d.ts +16 -0
  10. package/dist-types/commands/GetConnectInstanceConfigCommand.d.ts +16 -0
  11. package/dist-types/commands/GetInstanceOnboardingJobStatusCommand.d.ts +16 -0
  12. package/dist-types/commands/ListCampaignsCommand.d.ts +16 -0
  13. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  14. package/dist-types/commands/PauseCampaignCommand.d.ts +16 -0
  15. package/dist-types/commands/PutDialRequestBatchCommand.d.ts +16 -0
  16. package/dist-types/commands/ResumeCampaignCommand.d.ts +16 -0
  17. package/dist-types/commands/StartCampaignCommand.d.ts +16 -0
  18. package/dist-types/commands/StartInstanceOnboardingJobCommand.d.ts +16 -0
  19. package/dist-types/commands/StopCampaignCommand.d.ts +16 -0
  20. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  21. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  22. package/dist-types/commands/UpdateCampaignDialerConfigCommand.d.ts +16 -0
  23. package/dist-types/commands/UpdateCampaignNameCommand.d.ts +16 -0
  24. package/dist-types/commands/UpdateCampaignOutboundCallConfigCommand.d.ts +16 -0
  25. package/dist-types/models/ConnectCampaignsServiceException.d.ts +2 -0
  26. package/dist-types/models/models_0.d.ts +82 -0
  27. package/dist-types/pagination/Interfaces.d.ts +3 -0
  28. package/dist-types/pagination/ListCampaignsPaginator.d.ts +3 -0
  29. package/package.json +3 -3
@@ -23,136 +23,159 @@ import { UpdateCampaignNameCommandInput, UpdateCampaignNameCommandOutput } from
23
23
  import { UpdateCampaignOutboundCallConfigCommandInput, UpdateCampaignOutboundCallConfigCommandOutput } from "./commands/UpdateCampaignOutboundCallConfigCommand";
24
24
  import { ConnectCampaignsClient } from "./ConnectCampaignsClient";
25
25
  /**
26
+ * @public
26
27
  * Provide APIs to create and manage Amazon Connect Campaigns.
27
28
  */
28
29
  export declare class ConnectCampaigns extends ConnectCampaignsClient {
29
30
  /**
31
+ * @public
30
32
  * Creates a campaign for the specified Amazon Connect account. This API is idempotent.
31
33
  */
32
34
  createCampaign(args: CreateCampaignCommandInput, options?: __HttpHandlerOptions): Promise<CreateCampaignCommandOutput>;
33
35
  createCampaign(args: CreateCampaignCommandInput, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
34
36
  createCampaign(args: CreateCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCampaignCommandOutput) => void): void;
35
37
  /**
38
+ * @public
36
39
  * Deletes a campaign from the specified Amazon Connect account.
37
40
  */
38
41
  deleteCampaign(args: DeleteCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCampaignCommandOutput>;
39
42
  deleteCampaign(args: DeleteCampaignCommandInput, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
40
43
  deleteCampaign(args: DeleteCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCampaignCommandOutput) => void): void;
41
44
  /**
45
+ * @public
42
46
  * Deletes a connect instance config from the specified AWS account.
43
47
  */
44
48
  deleteConnectInstanceConfig(args: DeleteConnectInstanceConfigCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectInstanceConfigCommandOutput>;
45
49
  deleteConnectInstanceConfig(args: DeleteConnectInstanceConfigCommandInput, cb: (err: any, data?: DeleteConnectInstanceConfigCommandOutput) => void): void;
46
50
  deleteConnectInstanceConfig(args: DeleteConnectInstanceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectInstanceConfigCommandOutput) => void): void;
47
51
  /**
52
+ * @public
48
53
  * Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
49
54
  */
50
55
  deleteInstanceOnboardingJob(args: DeleteInstanceOnboardingJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteInstanceOnboardingJobCommandOutput>;
51
56
  deleteInstanceOnboardingJob(args: DeleteInstanceOnboardingJobCommandInput, cb: (err: any, data?: DeleteInstanceOnboardingJobCommandOutput) => void): void;
52
57
  deleteInstanceOnboardingJob(args: DeleteInstanceOnboardingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteInstanceOnboardingJobCommandOutput) => void): void;
53
58
  /**
59
+ * @public
54
60
  * Describes the specific campaign.
55
61
  */
56
62
  describeCampaign(args: DescribeCampaignCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCampaignCommandOutput>;
57
63
  describeCampaign(args: DescribeCampaignCommandInput, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
58
64
  describeCampaign(args: DescribeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCampaignCommandOutput) => void): void;
59
65
  /**
66
+ * @public
60
67
  * Get state of a campaign for the specified Amazon Connect account.
61
68
  */
62
69
  getCampaignState(args: GetCampaignStateCommandInput, options?: __HttpHandlerOptions): Promise<GetCampaignStateCommandOutput>;
63
70
  getCampaignState(args: GetCampaignStateCommandInput, cb: (err: any, data?: GetCampaignStateCommandOutput) => void): void;
64
71
  getCampaignState(args: GetCampaignStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignStateCommandOutput) => void): void;
65
72
  /**
73
+ * @public
66
74
  * Get state of campaigns for the specified Amazon Connect account.
67
75
  */
68
76
  getCampaignStateBatch(args: GetCampaignStateBatchCommandInput, options?: __HttpHandlerOptions): Promise<GetCampaignStateBatchCommandOutput>;
69
77
  getCampaignStateBatch(args: GetCampaignStateBatchCommandInput, cb: (err: any, data?: GetCampaignStateBatchCommandOutput) => void): void;
70
78
  getCampaignStateBatch(args: GetCampaignStateBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCampaignStateBatchCommandOutput) => void): void;
71
79
  /**
80
+ * @public
72
81
  * Get the specific Connect instance config.
73
82
  */
74
83
  getConnectInstanceConfig(args: GetConnectInstanceConfigCommandInput, options?: __HttpHandlerOptions): Promise<GetConnectInstanceConfigCommandOutput>;
75
84
  getConnectInstanceConfig(args: GetConnectInstanceConfigCommandInput, cb: (err: any, data?: GetConnectInstanceConfigCommandOutput) => void): void;
76
85
  getConnectInstanceConfig(args: GetConnectInstanceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConnectInstanceConfigCommandOutput) => void): void;
77
86
  /**
87
+ * @public
78
88
  * Get the specific instance onboarding job status.
79
89
  */
80
90
  getInstanceOnboardingJobStatus(args: GetInstanceOnboardingJobStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetInstanceOnboardingJobStatusCommandOutput>;
81
91
  getInstanceOnboardingJobStatus(args: GetInstanceOnboardingJobStatusCommandInput, cb: (err: any, data?: GetInstanceOnboardingJobStatusCommandOutput) => void): void;
82
92
  getInstanceOnboardingJobStatus(args: GetInstanceOnboardingJobStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceOnboardingJobStatusCommandOutput) => void): void;
83
93
  /**
94
+ * @public
84
95
  * Provides summary information about the campaigns under the specified Amazon Connect account.
85
96
  */
86
97
  listCampaigns(args: ListCampaignsCommandInput, options?: __HttpHandlerOptions): Promise<ListCampaignsCommandOutput>;
87
98
  listCampaigns(args: ListCampaignsCommandInput, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
88
99
  listCampaigns(args: ListCampaignsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCampaignsCommandOutput) => void): void;
89
100
  /**
101
+ * @public
90
102
  * List tags for a resource.
91
103
  */
92
104
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
93
105
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
94
106
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
95
107
  /**
108
+ * @public
96
109
  * Pauses a campaign for the specified Amazon Connect account.
97
110
  */
98
111
  pauseCampaign(args: PauseCampaignCommandInput, options?: __HttpHandlerOptions): Promise<PauseCampaignCommandOutput>;
99
112
  pauseCampaign(args: PauseCampaignCommandInput, cb: (err: any, data?: PauseCampaignCommandOutput) => void): void;
100
113
  pauseCampaign(args: PauseCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PauseCampaignCommandOutput) => void): void;
101
114
  /**
115
+ * @public
102
116
  * Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
103
117
  */
104
118
  putDialRequestBatch(args: PutDialRequestBatchCommandInput, options?: __HttpHandlerOptions): Promise<PutDialRequestBatchCommandOutput>;
105
119
  putDialRequestBatch(args: PutDialRequestBatchCommandInput, cb: (err: any, data?: PutDialRequestBatchCommandOutput) => void): void;
106
120
  putDialRequestBatch(args: PutDialRequestBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDialRequestBatchCommandOutput) => void): void;
107
121
  /**
122
+ * @public
108
123
  * Stops a campaign for the specified Amazon Connect account.
109
124
  */
110
125
  resumeCampaign(args: ResumeCampaignCommandInput, options?: __HttpHandlerOptions): Promise<ResumeCampaignCommandOutput>;
111
126
  resumeCampaign(args: ResumeCampaignCommandInput, cb: (err: any, data?: ResumeCampaignCommandOutput) => void): void;
112
127
  resumeCampaign(args: ResumeCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeCampaignCommandOutput) => void): void;
113
128
  /**
129
+ * @public
114
130
  * Starts a campaign for the specified Amazon Connect account.
115
131
  */
116
132
  startCampaign(args: StartCampaignCommandInput, options?: __HttpHandlerOptions): Promise<StartCampaignCommandOutput>;
117
133
  startCampaign(args: StartCampaignCommandInput, cb: (err: any, data?: StartCampaignCommandOutput) => void): void;
118
134
  startCampaign(args: StartCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCampaignCommandOutput) => void): void;
119
135
  /**
136
+ * @public
120
137
  * Onboard the specific Amazon Connect instance to Connect Campaigns.
121
138
  */
122
139
  startInstanceOnboardingJob(args: StartInstanceOnboardingJobCommandInput, options?: __HttpHandlerOptions): Promise<StartInstanceOnboardingJobCommandOutput>;
123
140
  startInstanceOnboardingJob(args: StartInstanceOnboardingJobCommandInput, cb: (err: any, data?: StartInstanceOnboardingJobCommandOutput) => void): void;
124
141
  startInstanceOnboardingJob(args: StartInstanceOnboardingJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartInstanceOnboardingJobCommandOutput) => void): void;
125
142
  /**
143
+ * @public
126
144
  * Stops a campaign for the specified Amazon Connect account.
127
145
  */
128
146
  stopCampaign(args: StopCampaignCommandInput, options?: __HttpHandlerOptions): Promise<StopCampaignCommandOutput>;
129
147
  stopCampaign(args: StopCampaignCommandInput, cb: (err: any, data?: StopCampaignCommandOutput) => void): void;
130
148
  stopCampaign(args: StopCampaignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopCampaignCommandOutput) => void): void;
131
149
  /**
150
+ * @public
132
151
  * Tag a resource.
133
152
  */
134
153
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
135
154
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
136
155
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
137
156
  /**
157
+ * @public
138
158
  * Untag a resource.
139
159
  */
140
160
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
141
161
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
142
162
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
143
163
  /**
164
+ * @public
144
165
  * Updates the dialer config of a campaign. This API is idempotent.
145
166
  */
146
167
  updateCampaignDialerConfig(args: UpdateCampaignDialerConfigCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCampaignDialerConfigCommandOutput>;
147
168
  updateCampaignDialerConfig(args: UpdateCampaignDialerConfigCommandInput, cb: (err: any, data?: UpdateCampaignDialerConfigCommandOutput) => void): void;
148
169
  updateCampaignDialerConfig(args: UpdateCampaignDialerConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignDialerConfigCommandOutput) => void): void;
149
170
  /**
171
+ * @public
150
172
  * Updates the name of a campaign. This API is idempotent.
151
173
  */
152
174
  updateCampaignName(args: UpdateCampaignNameCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCampaignNameCommandOutput>;
153
175
  updateCampaignName(args: UpdateCampaignNameCommandInput, cb: (err: any, data?: UpdateCampaignNameCommandOutput) => void): void;
154
176
  updateCampaignName(args: UpdateCampaignNameCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCampaignNameCommandOutput) => void): void;
155
177
  /**
178
+ * @public
156
179
  * Updates the outbound call config of a campaign. This API is idempotent.
157
180
  */
158
181
  updateCampaignOutboundCallConfig(args: UpdateCampaignOutboundCallConfigCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCampaignOutboundCallConfigCommandOutput>;
@@ -30,15 +30,24 @@ import { UpdateCampaignDialerConfigCommandInput, UpdateCampaignDialerConfigComma
30
30
  import { UpdateCampaignNameCommandInput, UpdateCampaignNameCommandOutput } from "./commands/UpdateCampaignNameCommand";
31
31
  import { UpdateCampaignOutboundCallConfigCommandInput, UpdateCampaignOutboundCallConfigCommandOutput } from "./commands/UpdateCampaignOutboundCallConfigCommand";
32
32
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
33
+ /**
34
+ * @public
35
+ */
33
36
  export type ServiceInputTypes = CreateCampaignCommandInput | DeleteCampaignCommandInput | DeleteConnectInstanceConfigCommandInput | DeleteInstanceOnboardingJobCommandInput | DescribeCampaignCommandInput | GetCampaignStateBatchCommandInput | GetCampaignStateCommandInput | GetConnectInstanceConfigCommandInput | GetInstanceOnboardingJobStatusCommandInput | ListCampaignsCommandInput | ListTagsForResourceCommandInput | PauseCampaignCommandInput | PutDialRequestBatchCommandInput | ResumeCampaignCommandInput | StartCampaignCommandInput | StartInstanceOnboardingJobCommandInput | StopCampaignCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCampaignDialerConfigCommandInput | UpdateCampaignNameCommandInput | UpdateCampaignOutboundCallConfigCommandInput;
37
+ /**
38
+ * @public
39
+ */
34
40
  export type ServiceOutputTypes = CreateCampaignCommandOutput | DeleteCampaignCommandOutput | DeleteConnectInstanceConfigCommandOutput | DeleteInstanceOnboardingJobCommandOutput | DescribeCampaignCommandOutput | GetCampaignStateBatchCommandOutput | GetCampaignStateCommandOutput | GetConnectInstanceConfigCommandOutput | GetInstanceOnboardingJobStatusCommandOutput | ListCampaignsCommandOutput | ListTagsForResourceCommandOutput | PauseCampaignCommandOutput | PutDialRequestBatchCommandOutput | ResumeCampaignCommandOutput | StartCampaignCommandOutput | StartInstanceOnboardingJobCommandOutput | StopCampaignCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCampaignDialerConfigCommandOutput | UpdateCampaignNameCommandOutput | UpdateCampaignOutboundCallConfigCommandOutput;
41
+ /**
42
+ * @public
43
+ */
35
44
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
36
45
  /**
37
46
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
38
47
  */
39
48
  requestHandler?: __HttpHandler;
40
49
  /**
41
- * A constructor for a class implementing the {@link __Checksum} interface
50
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
42
51
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
43
52
  * @internal
44
53
  */
@@ -128,23 +137,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
128
137
  */
129
138
  logger?: __Logger;
130
139
  /**
131
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
140
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
132
141
  */
133
142
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
134
143
  }
144
+ /**
145
+ * @public
146
+ */
135
147
  type ConnectCampaignsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
136
148
  /**
137
- * The configuration interface of ConnectCampaignsClient class constructor that set the region, credentials and other options.
149
+ * @public
150
+ *
151
+ * The configuration interface of ConnectCampaignsClient class constructor that set the region, credentials and other options.
138
152
  */
139
153
  export interface ConnectCampaignsClientConfig extends ConnectCampaignsClientConfigType {
140
154
  }
155
+ /**
156
+ * @public
157
+ */
141
158
  type ConnectCampaignsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
142
159
  /**
143
- * The resolved configuration interface of ConnectCampaignsClient class. This is resolved and normalized from the {@link ConnectCampaignsClientConfig | constructor configuration interface}.
160
+ * @public
161
+ *
162
+ * The resolved configuration interface of ConnectCampaignsClient class. This is resolved and normalized from the {@link ConnectCampaignsClientConfig | constructor configuration interface}.
144
163
  */
145
164
  export interface ConnectCampaignsClientResolvedConfig extends ConnectCampaignsClientResolvedConfigType {
146
165
  }
147
166
  /**
167
+ * @public
148
168
  * Provide APIs to create and manage Amazon Connect Campaigns.
149
169
  */
150
170
  export declare class ConnectCampaignsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ConnectCampaignsClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectCampaignsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsClient";
5
5
  import { CreateCampaignRequest, CreateCampaignResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateCampaignCommand}.
8
10
  */
9
11
  export interface CreateCampaignCommandInput extends CreateCampaignRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateCampaignCommand}.
13
17
  */
14
18
  export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Creates a campaign for the specified Amazon Connect account. This API is idempotent.
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 CreateCampaignCommandOutput extends CreateCampaignResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateCampaignCommandInput - {@link CreateCampaignCommandInput}
34
+ * @returns {@link CreateCampaignCommandOutput}
28
35
  * @see {@link CreateCampaignCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateCampaignCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCampaignsClientResolvedConfig | config} for ConnectCampaignsClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
55
62
  export declare class CreateCampaignCommand extends $Command<CreateCampaignCommandInput, CreateCampaignCommandOutput, ConnectCampaignsClientResolvedConfig> {
56
63
  readonly input: CreateCampaignCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateCampaignCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCampaignsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCampaignCommandInput, CreateCampaignCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectCampaignsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsClient";
5
5
  import { DeleteCampaignRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCampaignCommand}.
8
10
  */
9
11
  export interface DeleteCampaignCommandInput extends DeleteCampaignRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCampaignCommand}.
13
17
  */
14
18
  export interface DeleteCampaignCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Deletes a campaign from the specified Amazon Connect account.
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 DeleteCampaignCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteCampaignCommandInput - {@link DeleteCampaignCommandInput}
34
+ * @returns {@link DeleteCampaignCommandOutput}
28
35
  * @see {@link DeleteCampaignCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteCampaignCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCampaignsClientResolvedConfig | config} for ConnectCampaignsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DeleteCampaignCommandOutput extends __MetadataBearer {
46
53
  export declare class DeleteCampaignCommand extends $Command<DeleteCampaignCommandInput, DeleteCampaignCommandOutput, ConnectCampaignsClientResolvedConfig> {
47
54
  readonly input: DeleteCampaignCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DeleteCampaignCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCampaignsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCampaignCommandInput, DeleteCampaignCommandOutput>;
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 { ConnectCampaignsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsClient";
5
5
  import { DeleteConnectInstanceConfigRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteConnectInstanceConfigCommand}.
8
10
  */
9
11
  export interface DeleteConnectInstanceConfigCommandInput extends DeleteConnectInstanceConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteConnectInstanceConfigCommand}.
13
17
  */
14
18
  export interface DeleteConnectInstanceConfigCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Deletes a connect instance config from the specified AWS account.
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 DeleteConnectInstanceConfigCommandOutput extends __MetadataBear
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteConnectInstanceConfigCommandInput - {@link DeleteConnectInstanceConfigCommandInput}
34
+ * @returns {@link DeleteConnectInstanceConfigCommandOutput}
28
35
  * @see {@link DeleteConnectInstanceConfigCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteConnectInstanceConfigCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCampaignsClientResolvedConfig | config} for ConnectCampaignsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteConnectInstanceConfigCommandOutput extends __MetadataBear
52
59
  export declare class DeleteConnectInstanceConfigCommand extends $Command<DeleteConnectInstanceConfigCommandInput, DeleteConnectInstanceConfigCommandOutput, ConnectCampaignsClientResolvedConfig> {
53
60
  readonly input: DeleteConnectInstanceConfigCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteConnectInstanceConfigCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCampaignsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConnectInstanceConfigCommandInput, DeleteConnectInstanceConfigCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectCampaignsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsClient";
5
5
  import { DeleteInstanceOnboardingJobRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteInstanceOnboardingJobCommand}.
8
10
  */
9
11
  export interface DeleteInstanceOnboardingJobCommandInput extends DeleteInstanceOnboardingJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteInstanceOnboardingJobCommand}.
13
17
  */
14
18
  export interface DeleteInstanceOnboardingJobCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
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 DeleteInstanceOnboardingJobCommandOutput extends __MetadataBear
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteInstanceOnboardingJobCommandInput - {@link DeleteInstanceOnboardingJobCommandInput}
34
+ * @returns {@link DeleteInstanceOnboardingJobCommandOutput}
28
35
  * @see {@link DeleteInstanceOnboardingJobCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteInstanceOnboardingJobCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCampaignsClientResolvedConfig | config} for ConnectCampaignsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteInstanceOnboardingJobCommandOutput extends __MetadataBear
49
56
  export declare class DeleteInstanceOnboardingJobCommand extends $Command<DeleteInstanceOnboardingJobCommandInput, DeleteInstanceOnboardingJobCommandOutput, ConnectCampaignsClientResolvedConfig> {
50
57
  readonly input: DeleteInstanceOnboardingJobCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteInstanceOnboardingJobCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCampaignsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteInstanceOnboardingJobCommandInput, DeleteInstanceOnboardingJobCommandOutput>;
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 { ConnectCampaignsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsClient";
5
5
  import { DescribeCampaignRequest, DescribeCampaignResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCampaignCommand}.
8
10
  */
9
11
  export interface DescribeCampaignCommandInput extends DescribeCampaignRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCampaignCommand}.
13
17
  */
14
18
  export interface DescribeCampaignCommandOutput extends DescribeCampaignResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Describes the specific campaign.
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 DescribeCampaignCommandOutput extends DescribeCampaignResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeCampaignCommandInput - {@link DescribeCampaignCommandInput}
34
+ * @returns {@link DescribeCampaignCommandOutput}
28
35
  * @see {@link DescribeCampaignCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeCampaignCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCampaignsClientResolvedConfig | config} for ConnectCampaignsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribeCampaignCommandOutput extends DescribeCampaignResponse,
46
53
  export declare class DescribeCampaignCommand extends $Command<DescribeCampaignCommandInput, DescribeCampaignCommandOutput, ConnectCampaignsClientResolvedConfig> {
47
54
  readonly input: DescribeCampaignCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribeCampaignCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCampaignsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCampaignCommandInput, DescribeCampaignCommandOutput>;
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 { ConnectCampaignsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsClient";
5
5
  import { GetCampaignStateBatchRequest, GetCampaignStateBatchResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCampaignStateBatchCommand}.
8
10
  */
9
11
  export interface GetCampaignStateBatchCommandInput extends GetCampaignStateBatchRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCampaignStateBatchCommand}.
13
17
  */
14
18
  export interface GetCampaignStateBatchCommandOutput extends GetCampaignStateBatchResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Get state of campaigns for the specified Amazon Connect account.
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 GetCampaignStateBatchCommandOutput extends GetCampaignStateBatc
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetCampaignStateBatchCommandInput - {@link GetCampaignStateBatchCommandInput}
34
+ * @returns {@link GetCampaignStateBatchCommandOutput}
28
35
  * @see {@link GetCampaignStateBatchCommandInput} for command's `input` shape.
29
36
  * @see {@link GetCampaignStateBatchCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCampaignsClientResolvedConfig | config} for ConnectCampaignsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetCampaignStateBatchCommandOutput extends GetCampaignStateBatc
46
53
  export declare class GetCampaignStateBatchCommand extends $Command<GetCampaignStateBatchCommandInput, GetCampaignStateBatchCommandOutput, ConnectCampaignsClientResolvedConfig> {
47
54
  readonly input: GetCampaignStateBatchCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetCampaignStateBatchCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCampaignsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCampaignStateBatchCommandInput, GetCampaignStateBatchCommandOutput>;
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 { ConnectCampaignsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsClient";
5
5
  import { GetCampaignStateRequest, GetCampaignStateResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCampaignStateCommand}.
8
10
  */
9
11
  export interface GetCampaignStateCommandInput extends GetCampaignStateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCampaignStateCommand}.
13
17
  */
14
18
  export interface GetCampaignStateCommandOutput extends GetCampaignStateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Get state of a campaign for the specified Amazon Connect account.
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 GetCampaignStateCommandOutput extends GetCampaignStateResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetCampaignStateCommandInput - {@link GetCampaignStateCommandInput}
34
+ * @returns {@link GetCampaignStateCommandOutput}
28
35
  * @see {@link GetCampaignStateCommandInput} for command's `input` shape.
29
36
  * @see {@link GetCampaignStateCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCampaignsClientResolvedConfig | config} for ConnectCampaignsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetCampaignStateCommandOutput extends GetCampaignStateResponse,
49
56
  export declare class GetCampaignStateCommand extends $Command<GetCampaignStateCommandInput, GetCampaignStateCommandOutput, ConnectCampaignsClientResolvedConfig> {
50
57
  readonly input: GetCampaignStateCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetCampaignStateCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCampaignsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCampaignStateCommandInput, GetCampaignStateCommandOutput>;
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 { ConnectCampaignsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsClient";
5
5
  import { GetConnectInstanceConfigRequest, GetConnectInstanceConfigResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetConnectInstanceConfigCommand}.
8
10
  */
9
11
  export interface GetConnectInstanceConfigCommandInput extends GetConnectInstanceConfigRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetConnectInstanceConfigCommand}.
13
17
  */
14
18
  export interface GetConnectInstanceConfigCommandOutput extends GetConnectInstanceConfigResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * Get the specific Connect instance config.
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 GetConnectInstanceConfigCommandOutput extends GetConnectInstanc
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetConnectInstanceConfigCommandInput - {@link GetConnectInstanceConfigCommandInput}
34
+ * @returns {@link GetConnectInstanceConfigCommandOutput}
28
35
  * @see {@link GetConnectInstanceConfigCommandInput} for command's `input` shape.
29
36
  * @see {@link GetConnectInstanceConfigCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCampaignsClientResolvedConfig | config} for ConnectCampaignsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetConnectInstanceConfigCommandOutput extends GetConnectInstanc
46
53
  export declare class GetConnectInstanceConfigCommand extends $Command<GetConnectInstanceConfigCommandInput, GetConnectInstanceConfigCommandOutput, ConnectCampaignsClientResolvedConfig> {
47
54
  readonly input: GetConnectInstanceConfigCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetConnectInstanceConfigCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCampaignsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConnectInstanceConfigCommandInput, GetConnectInstanceConfigCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }