@aws-sdk/client-connectcampaignsv2 3.694.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.
- package/LICENSE +201 -0
- package/README.md +461 -0
- package/dist-cjs/ConnectCampaignsV2.js +75 -0
- package/dist-cjs/ConnectCampaignsV2Client.js +50 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/CreateCampaignCommand.js +27 -0
- package/dist-cjs/commands/DeleteCampaignChannelSubtypeConfigCommand.js +26 -0
- package/dist-cjs/commands/DeleteCampaignCommand.js +26 -0
- package/dist-cjs/commands/DeleteCampaignCommunicationLimitsCommand.js +26 -0
- package/dist-cjs/commands/DeleteCampaignCommunicationTimeCommand.js +26 -0
- package/dist-cjs/commands/DeleteConnectInstanceConfigCommand.js +26 -0
- package/dist-cjs/commands/DeleteConnectInstanceIntegrationCommand.js +26 -0
- package/dist-cjs/commands/DeleteInstanceOnboardingJobCommand.js +26 -0
- package/dist-cjs/commands/DescribeCampaignCommand.js +27 -0
- package/dist-cjs/commands/GetCampaignStateBatchCommand.js +26 -0
- package/dist-cjs/commands/GetCampaignStateCommand.js +26 -0
- package/dist-cjs/commands/GetConnectInstanceConfigCommand.js +26 -0
- package/dist-cjs/commands/GetInstanceOnboardingJobStatusCommand.js +26 -0
- package/dist-cjs/commands/ListCampaignsCommand.js +26 -0
- package/dist-cjs/commands/ListConnectInstanceIntegrationsCommand.js +26 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
- package/dist-cjs/commands/PauseCampaignCommand.js +26 -0
- package/dist-cjs/commands/PutConnectInstanceIntegrationCommand.js +26 -0
- package/dist-cjs/commands/PutOutboundRequestBatchCommand.js +27 -0
- package/dist-cjs/commands/ResumeCampaignCommand.js +26 -0
- package/dist-cjs/commands/StartCampaignCommand.js +26 -0
- package/dist-cjs/commands/StartInstanceOnboardingJobCommand.js +26 -0
- package/dist-cjs/commands/StopCampaignCommand.js +26 -0
- package/dist-cjs/commands/TagResourceCommand.js +26 -0
- package/dist-cjs/commands/UntagResourceCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignChannelSubtypeConfigCommand.js +27 -0
- package/dist-cjs/commands/UpdateCampaignCommunicationLimitsCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignCommunicationTimeCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignFlowAssociationCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignNameCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignScheduleCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignSourceCommand.js +26 -0
- package/dist-cjs/commands/index.js +35 -0
- package/dist-cjs/endpoint/EndpointParameters.js +18 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/ConnectCampaignsV2ServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +409 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListCampaignsPaginator.js +7 -0
- package/dist-cjs/pagination/ListConnectInstanceIntegrationsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +6 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1193 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +25 -0
- package/dist-es/ConnectCampaignsV2.js +71 -0
- package/dist-es/ConnectCampaignsV2Client.js +46 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/CreateCampaignCommand.js +23 -0
- package/dist-es/commands/DeleteCampaignChannelSubtypeConfigCommand.js +22 -0
- package/dist-es/commands/DeleteCampaignCommand.js +22 -0
- package/dist-es/commands/DeleteCampaignCommunicationLimitsCommand.js +22 -0
- package/dist-es/commands/DeleteCampaignCommunicationTimeCommand.js +22 -0
- package/dist-es/commands/DeleteConnectInstanceConfigCommand.js +22 -0
- package/dist-es/commands/DeleteConnectInstanceIntegrationCommand.js +22 -0
- package/dist-es/commands/DeleteInstanceOnboardingJobCommand.js +22 -0
- package/dist-es/commands/DescribeCampaignCommand.js +23 -0
- package/dist-es/commands/GetCampaignStateBatchCommand.js +22 -0
- package/dist-es/commands/GetCampaignStateCommand.js +22 -0
- package/dist-es/commands/GetConnectInstanceConfigCommand.js +22 -0
- package/dist-es/commands/GetInstanceOnboardingJobStatusCommand.js +22 -0
- package/dist-es/commands/ListCampaignsCommand.js +22 -0
- package/dist-es/commands/ListConnectInstanceIntegrationsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/PauseCampaignCommand.js +22 -0
- package/dist-es/commands/PutConnectInstanceIntegrationCommand.js +22 -0
- package/dist-es/commands/PutOutboundRequestBatchCommand.js +23 -0
- package/dist-es/commands/ResumeCampaignCommand.js +22 -0
- package/dist-es/commands/StartCampaignCommand.js +22 -0
- package/dist-es/commands/StartInstanceOnboardingJobCommand.js +22 -0
- package/dist-es/commands/StopCampaignCommand.js +22 -0
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignChannelSubtypeConfigCommand.js +23 -0
- package/dist-es/commands/UpdateCampaignCommunicationLimitsCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignCommunicationTimeCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignFlowAssociationCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignNameCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignScheduleCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignSourceCommand.js +22 -0
- package/dist-es/commands/index.js +32 -0
- package/dist-es/endpoint/EndpointParameters.js +14 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/ConnectCampaignsV2ServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +384 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListCampaignsPaginator.js +4 -0
- package/dist-es/pagination/ListConnectInstanceIntegrationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1125 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +21 -0
- package/dist-types/ConnectCampaignsV2.d.ts +235 -0
- package/dist-types/ConnectCampaignsV2Client.d.ts +201 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +235 -0
- package/dist-types/commands/DeleteCampaignChannelSubtypeConfigCommand.d.ts +85 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +81 -0
- package/dist-types/commands/DeleteCampaignCommunicationLimitsCommand.d.ts +88 -0
- package/dist-types/commands/DeleteCampaignCommunicationTimeCommand.d.ts +88 -0
- package/dist-types/commands/DeleteConnectInstanceConfigCommand.d.ts +88 -0
- package/dist-types/commands/DeleteConnectInstanceIntegrationCommand.d.ts +92 -0
- package/dist-types/commands/DeleteInstanceOnboardingJobCommand.d.ts +84 -0
- package/dist-types/commands/DescribeCampaignCommand.d.ts +226 -0
- package/dist-types/commands/GetCampaignStateBatchCommand.d.ts +96 -0
- package/dist-types/commands/GetCampaignStateCommand.d.ts +86 -0
- package/dist-types/commands/GetConnectInstanceConfigCommand.d.ts +91 -0
- package/dist-types/commands/GetInstanceOnboardingJobStatusCommand.d.ts +87 -0
- package/dist-types/commands/ListCampaignsCommand.d.ts +104 -0
- package/dist-types/commands/ListConnectInstanceIntegrationsCommand.d.ts +101 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +88 -0
- package/dist-types/commands/PauseCampaignCommand.d.ts +90 -0
- package/dist-types/commands/PutConnectInstanceIntegrationCommand.d.ts +98 -0
- package/dist-types/commands/PutOutboundRequestBatchCommand.d.ts +139 -0
- package/dist-types/commands/ResumeCampaignCommand.d.ts +90 -0
- package/dist-types/commands/StartCampaignCommand.d.ts +90 -0
- package/dist-types/commands/StartInstanceOnboardingJobCommand.d.ts +98 -0
- package/dist-types/commands/StopCampaignCommand.d.ts +90 -0
- package/dist-types/commands/TagResourceCommand.d.ts +87 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +87 -0
- package/dist-types/commands/UpdateCampaignChannelSubtypeConfigCommand.d.ts +128 -0
- package/dist-types/commands/UpdateCampaignCommunicationLimitsCommand.d.ts +98 -0
- package/dist-types/commands/UpdateCampaignCommunicationTimeCommand.d.ts +158 -0
- package/dist-types/commands/UpdateCampaignFlowAssociationCommand.d.ts +88 -0
- package/dist-types/commands/UpdateCampaignNameCommand.d.ts +85 -0
- package/dist-types/commands/UpdateCampaignScheduleCommand.d.ts +92 -0
- package/dist-types/commands/UpdateCampaignSourceCommand.d.ts +90 -0
- package/dist-types/commands/index.d.ts +32 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +14 -0
- package/dist-types/models/ConnectCampaignsV2ServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2299 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListCampaignsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListConnectInstanceIntegrationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +290 -0
- package/dist-types/runtimeConfig.browser.d.ts +48 -0
- package/dist-types/runtimeConfig.d.ts +48 -0
- package/dist-types/runtimeConfig.native.d.ts +47 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/ConnectCampaignsV2.d.ts +576 -0
- package/dist-types/ts3.4/ConnectCampaignsV2Client.d.ts +313 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteCampaignChannelSubtypeConfigCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/DeleteCampaignCommunicationLimitsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteCampaignCommunicationTimeCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteConnectInstanceConfigCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteConnectInstanceIntegrationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteInstanceOnboardingJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeCampaignCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetCampaignStateBatchCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCampaignStateCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetConnectInstanceConfigCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetInstanceOnboardingJobStatusCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCampaignsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListConnectInstanceIntegrationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PauseCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/PutConnectInstanceIntegrationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/PutOutboundRequestBatchCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ResumeCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/StartCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/StartInstanceOnboardingJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/UpdateCampaignChannelSubtypeConfigCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCampaignCommunicationLimitsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCampaignCommunicationTimeCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCampaignFlowAssociationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCampaignNameCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/UpdateCampaignScheduleCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/UpdateCampaignSourceCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/index.d.ts +32 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/ConnectCampaignsV2ServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +827 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListCampaignsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListConnectInstanceIntegrationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +389 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +96 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +89 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/package.json +101 -0
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsV2Client";
|
|
4
|
+
import { DeleteConnectInstanceConfigRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteConnectInstanceConfigCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteConnectInstanceConfigCommandInput extends DeleteConnectInstanceConfigRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteConnectInstanceConfigCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteConnectInstanceConfigCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteConnectInstanceConfigCommand_base: {
|
|
25
|
+
new (input: DeleteConnectInstanceConfigCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteConnectInstanceConfigCommandInput, DeleteConnectInstanceConfigCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteConnectInstanceConfigCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteConnectInstanceConfigCommandInput, DeleteConnectInstanceConfigCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Deletes a connect instance config from the specified AWS account.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectCampaignsV2Client, DeleteConnectInstanceConfigCommand } from "@aws-sdk/client-connectcampaignsv2"; // ES Modules import
|
|
35
|
+
* // const { ConnectCampaignsV2Client, DeleteConnectInstanceConfigCommand } = require("@aws-sdk/client-connectcampaignsv2"); // CommonJS import
|
|
36
|
+
* const client = new ConnectCampaignsV2Client(config);
|
|
37
|
+
* const input = { // DeleteConnectInstanceConfigRequest
|
|
38
|
+
* connectInstanceId: "STRING_VALUE", // required
|
|
39
|
+
* campaignDeletionPolicy: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteConnectInstanceConfigCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param DeleteConnectInstanceConfigCommandInput - {@link DeleteConnectInstanceConfigCommandInput}
|
|
48
|
+
* @returns {@link DeleteConnectInstanceConfigCommandOutput}
|
|
49
|
+
* @see {@link DeleteConnectInstanceConfigCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link DeleteConnectInstanceConfigCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link ConnectCampaignsV2ClientResolvedConfig | config} for ConnectCampaignsV2Client's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
+
* You do not have sufficient access to perform this action.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InternalServerException} (server fault)
|
|
57
|
+
* Request processing failed because of an error or failure with the service.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InvalidStateException} (client fault)
|
|
60
|
+
* The request could not be processed because of conflict in the current state.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
|
+
* The specified resource was not found.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
+
* The request was denied due to request throttling.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ValidationException} (client fault)
|
|
69
|
+
* The input fails to satisfy the constraints specified by an AWS service.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ConnectCampaignsV2ServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from ConnectCampaignsV2 service.</p>
|
|
73
|
+
*
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
export declare class DeleteConnectInstanceConfigCommand extends DeleteConnectInstanceConfigCommand_base {
|
|
77
|
+
/** @internal type navigation helper, not in runtime. */
|
|
78
|
+
protected static __types: {
|
|
79
|
+
api: {
|
|
80
|
+
input: DeleteConnectInstanceConfigRequest;
|
|
81
|
+
output: {};
|
|
82
|
+
};
|
|
83
|
+
sdk: {
|
|
84
|
+
input: DeleteConnectInstanceConfigCommandInput;
|
|
85
|
+
output: DeleteConnectInstanceConfigCommandOutput;
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsV2Client";
|
|
4
|
+
import { DeleteConnectInstanceIntegrationRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteConnectInstanceIntegrationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteConnectInstanceIntegrationCommandInput extends DeleteConnectInstanceIntegrationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteConnectInstanceIntegrationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteConnectInstanceIntegrationCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteConnectInstanceIntegrationCommand_base: {
|
|
25
|
+
new (input: DeleteConnectInstanceIntegrationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteConnectInstanceIntegrationCommandInput, DeleteConnectInstanceIntegrationCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteConnectInstanceIntegrationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteConnectInstanceIntegrationCommandInput, DeleteConnectInstanceIntegrationCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Delete the integration for the specified Amazon Connect instance.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectCampaignsV2Client, DeleteConnectInstanceIntegrationCommand } from "@aws-sdk/client-connectcampaignsv2"; // ES Modules import
|
|
35
|
+
* // const { ConnectCampaignsV2Client, DeleteConnectInstanceIntegrationCommand } = require("@aws-sdk/client-connectcampaignsv2"); // CommonJS import
|
|
36
|
+
* const client = new ConnectCampaignsV2Client(config);
|
|
37
|
+
* const input = { // DeleteConnectInstanceIntegrationRequest
|
|
38
|
+
* connectInstanceId: "STRING_VALUE", // required
|
|
39
|
+
* integrationIdentifier: { // IntegrationIdentifier Union: only one key present
|
|
40
|
+
* customerProfiles: { // CustomerProfilesIntegrationIdentifier
|
|
41
|
+
* domainArn: "STRING_VALUE", // required
|
|
42
|
+
* },
|
|
43
|
+
* qConnect: { // QConnectIntegrationIdentifier
|
|
44
|
+
* knowledgeBaseArn: "STRING_VALUE", // required
|
|
45
|
+
* },
|
|
46
|
+
* },
|
|
47
|
+
* };
|
|
48
|
+
* const command = new DeleteConnectInstanceIntegrationCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // {};
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param DeleteConnectInstanceIntegrationCommandInput - {@link DeleteConnectInstanceIntegrationCommandInput}
|
|
55
|
+
* @returns {@link DeleteConnectInstanceIntegrationCommandOutput}
|
|
56
|
+
* @see {@link DeleteConnectInstanceIntegrationCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link DeleteConnectInstanceIntegrationCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link ConnectCampaignsV2ClientResolvedConfig | config} for ConnectCampaignsV2Client's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
61
|
+
* You do not have sufficient access to perform this action.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServerException} (server fault)
|
|
64
|
+
* Request processing failed because of an error or failure with the service.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
+
* The specified resource was not found.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* The request was denied due to request throttling.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ValidationException} (client fault)
|
|
73
|
+
* The input fails to satisfy the constraints specified by an AWS service.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ConnectCampaignsV2ServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from ConnectCampaignsV2 service.</p>
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
export declare class DeleteConnectInstanceIntegrationCommand extends DeleteConnectInstanceIntegrationCommand_base {
|
|
81
|
+
/** @internal type navigation helper, not in runtime. */
|
|
82
|
+
protected static __types: {
|
|
83
|
+
api: {
|
|
84
|
+
input: DeleteConnectInstanceIntegrationRequest;
|
|
85
|
+
output: {};
|
|
86
|
+
};
|
|
87
|
+
sdk: {
|
|
88
|
+
input: DeleteConnectInstanceIntegrationCommandInput;
|
|
89
|
+
output: DeleteConnectInstanceIntegrationCommandOutput;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsV2Client";
|
|
4
|
+
import { DeleteInstanceOnboardingJobRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteInstanceOnboardingJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteInstanceOnboardingJobCommandInput extends DeleteInstanceOnboardingJobRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteInstanceOnboardingJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteInstanceOnboardingJobCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteInstanceOnboardingJobCommand_base: {
|
|
25
|
+
new (input: DeleteInstanceOnboardingJobCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteInstanceOnboardingJobCommandInput, DeleteInstanceOnboardingJobCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteInstanceOnboardingJobCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteInstanceOnboardingJobCommandInput, DeleteInstanceOnboardingJobCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectCampaignsV2Client, DeleteInstanceOnboardingJobCommand } from "@aws-sdk/client-connectcampaignsv2"; // ES Modules import
|
|
35
|
+
* // const { ConnectCampaignsV2Client, DeleteInstanceOnboardingJobCommand } = require("@aws-sdk/client-connectcampaignsv2"); // CommonJS import
|
|
36
|
+
* const client = new ConnectCampaignsV2Client(config);
|
|
37
|
+
* const input = { // DeleteInstanceOnboardingJobRequest
|
|
38
|
+
* connectInstanceId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteInstanceOnboardingJobCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // {};
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* @param DeleteInstanceOnboardingJobCommandInput - {@link DeleteInstanceOnboardingJobCommandInput}
|
|
47
|
+
* @returns {@link DeleteInstanceOnboardingJobCommandOutput}
|
|
48
|
+
* @see {@link DeleteInstanceOnboardingJobCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link DeleteInstanceOnboardingJobCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link ConnectCampaignsV2ClientResolvedConfig | config} for ConnectCampaignsV2Client's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
+
* You do not have sufficient access to perform this action.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link InternalServerException} (server fault)
|
|
56
|
+
* Request processing failed because of an error or failure with the service.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InvalidStateException} (client fault)
|
|
59
|
+
* The request could not be processed because of conflict in the current state.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
+
* The specified resource was not found.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ValidationException} (client fault)
|
|
65
|
+
* The input fails to satisfy the constraints specified by an AWS service.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ConnectCampaignsV2ServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from ConnectCampaignsV2 service.</p>
|
|
69
|
+
*
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare class DeleteInstanceOnboardingJobCommand extends DeleteInstanceOnboardingJobCommand_base {
|
|
73
|
+
/** @internal type navigation helper, not in runtime. */
|
|
74
|
+
protected static __types: {
|
|
75
|
+
api: {
|
|
76
|
+
input: DeleteInstanceOnboardingJobRequest;
|
|
77
|
+
output: {};
|
|
78
|
+
};
|
|
79
|
+
sdk: {
|
|
80
|
+
input: DeleteInstanceOnboardingJobCommandInput;
|
|
81
|
+
output: DeleteInstanceOnboardingJobCommandOutput;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsV2Client";
|
|
4
|
+
import { DescribeCampaignRequest, DescribeCampaignResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeCampaignCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeCampaignCommandInput extends DescribeCampaignRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeCampaignCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeCampaignCommandOutput extends DescribeCampaignResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeCampaignCommand_base: {
|
|
25
|
+
new (input: DescribeCampaignCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeCampaignCommandInput, DescribeCampaignCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DescribeCampaignCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeCampaignCommandInput, DescribeCampaignCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Describes the specific campaign.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectCampaignsV2Client, DescribeCampaignCommand } from "@aws-sdk/client-connectcampaignsv2"; // ES Modules import
|
|
35
|
+
* // const { ConnectCampaignsV2Client, DescribeCampaignCommand } = require("@aws-sdk/client-connectcampaignsv2"); // CommonJS import
|
|
36
|
+
* const client = new ConnectCampaignsV2Client(config);
|
|
37
|
+
* const input = { // DescribeCampaignRequest
|
|
38
|
+
* id: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeCampaignCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeCampaignResponse
|
|
43
|
+
* // campaign: { // Campaign
|
|
44
|
+
* // id: "STRING_VALUE", // required
|
|
45
|
+
* // arn: "STRING_VALUE", // required
|
|
46
|
+
* // name: "STRING_VALUE", // required
|
|
47
|
+
* // connectInstanceId: "STRING_VALUE", // required
|
|
48
|
+
* // channelSubtypeConfig: { // ChannelSubtypeConfig
|
|
49
|
+
* // telephony: { // TelephonyChannelSubtypeConfig
|
|
50
|
+
* // capacity: Number("double"),
|
|
51
|
+
* // connectQueueId: "STRING_VALUE",
|
|
52
|
+
* // outboundMode: { // TelephonyOutboundMode Union: only one key present
|
|
53
|
+
* // progressive: { // ProgressiveConfig
|
|
54
|
+
* // bandwidthAllocation: Number("double"), // required
|
|
55
|
+
* // },
|
|
56
|
+
* // predictive: { // PredictiveConfig
|
|
57
|
+
* // bandwidthAllocation: Number("double"), // required
|
|
58
|
+
* // },
|
|
59
|
+
* // agentless: {},
|
|
60
|
+
* // },
|
|
61
|
+
* // defaultOutboundConfig: { // TelephonyOutboundConfig
|
|
62
|
+
* // connectContactFlowId: "STRING_VALUE", // required
|
|
63
|
+
* // connectSourcePhoneNumber: "STRING_VALUE",
|
|
64
|
+
* // answerMachineDetectionConfig: { // AnswerMachineDetectionConfig
|
|
65
|
+
* // enableAnswerMachineDetection: true || false, // required
|
|
66
|
+
* // awaitAnswerMachinePrompt: true || false,
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // sms: { // SmsChannelSubtypeConfig
|
|
71
|
+
* // capacity: Number("double"),
|
|
72
|
+
* // outboundMode: { // SmsOutboundMode Union: only one key present
|
|
73
|
+
* // agentless: {},
|
|
74
|
+
* // },
|
|
75
|
+
* // defaultOutboundConfig: { // SmsOutboundConfig
|
|
76
|
+
* // connectSourcePhoneNumberArn: "STRING_VALUE", // required
|
|
77
|
+
* // wisdomTemplateArn: "STRING_VALUE", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // },
|
|
80
|
+
* // email: { // EmailChannelSubtypeConfig
|
|
81
|
+
* // capacity: Number("double"),
|
|
82
|
+
* // outboundMode: { // EmailOutboundMode Union: only one key present
|
|
83
|
+
* // agentless: {},
|
|
84
|
+
* // },
|
|
85
|
+
* // defaultOutboundConfig: { // EmailOutboundConfig
|
|
86
|
+
* // connectSourceEmailAddress: "STRING_VALUE", // required
|
|
87
|
+
* // sourceEmailAddressDisplayName: "STRING_VALUE",
|
|
88
|
+
* // wisdomTemplateArn: "STRING_VALUE", // required
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
91
|
+
* // },
|
|
92
|
+
* // source: { // Source Union: only one key present
|
|
93
|
+
* // customerProfilesSegmentArn: "STRING_VALUE",
|
|
94
|
+
* // },
|
|
95
|
+
* // connectCampaignFlowArn: "STRING_VALUE",
|
|
96
|
+
* // schedule: { // Schedule
|
|
97
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
98
|
+
* // endTime: new Date("TIMESTAMP"), // required
|
|
99
|
+
* // refreshFrequency: "STRING_VALUE",
|
|
100
|
+
* // },
|
|
101
|
+
* // communicationTimeConfig: { // CommunicationTimeConfig
|
|
102
|
+
* // localTimeZoneConfig: { // LocalTimeZoneConfig
|
|
103
|
+
* // defaultTimeZone: "STRING_VALUE",
|
|
104
|
+
* // localTimeZoneDetection: [ // LocalTimeZoneDetection
|
|
105
|
+
* // "STRING_VALUE",
|
|
106
|
+
* // ],
|
|
107
|
+
* // },
|
|
108
|
+
* // telephony: { // TimeWindow
|
|
109
|
+
* // openHours: { // OpenHours Union: only one key present
|
|
110
|
+
* // dailyHours: { // DailyHours
|
|
111
|
+
* // "<keys>": [ // TimeRangeList
|
|
112
|
+
* // { // TimeRange
|
|
113
|
+
* // startTime: "STRING_VALUE", // required
|
|
114
|
+
* // endTime: "STRING_VALUE", // required
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // },
|
|
118
|
+
* // },
|
|
119
|
+
* // restrictedPeriods: { // RestrictedPeriods Union: only one key present
|
|
120
|
+
* // restrictedPeriodList: [ // RestrictedPeriodList
|
|
121
|
+
* // { // RestrictedPeriod
|
|
122
|
+
* // name: "STRING_VALUE",
|
|
123
|
+
* // startDate: "STRING_VALUE", // required
|
|
124
|
+
* // endDate: "STRING_VALUE", // required
|
|
125
|
+
* // },
|
|
126
|
+
* // ],
|
|
127
|
+
* // },
|
|
128
|
+
* // },
|
|
129
|
+
* // sms: {
|
|
130
|
+
* // openHours: {// Union: only one key present
|
|
131
|
+
* // dailyHours: {
|
|
132
|
+
* // "<keys>": [
|
|
133
|
+
* // {
|
|
134
|
+
* // startTime: "STRING_VALUE", // required
|
|
135
|
+
* // endTime: "STRING_VALUE", // required
|
|
136
|
+
* // },
|
|
137
|
+
* // ],
|
|
138
|
+
* // },
|
|
139
|
+
* // },
|
|
140
|
+
* // restrictedPeriods: {// Union: only one key present
|
|
141
|
+
* // restrictedPeriodList: [
|
|
142
|
+
* // {
|
|
143
|
+
* // name: "STRING_VALUE",
|
|
144
|
+
* // startDate: "STRING_VALUE", // required
|
|
145
|
+
* // endDate: "STRING_VALUE", // required
|
|
146
|
+
* // },
|
|
147
|
+
* // ],
|
|
148
|
+
* // },
|
|
149
|
+
* // },
|
|
150
|
+
* // email: {
|
|
151
|
+
* // openHours: {// Union: only one key present
|
|
152
|
+
* // dailyHours: {
|
|
153
|
+
* // "<keys>": [
|
|
154
|
+
* // {
|
|
155
|
+
* // startTime: "STRING_VALUE", // required
|
|
156
|
+
* // endTime: "STRING_VALUE", // required
|
|
157
|
+
* // },
|
|
158
|
+
* // ],
|
|
159
|
+
* // },
|
|
160
|
+
* // },
|
|
161
|
+
* // restrictedPeriods: {// Union: only one key present
|
|
162
|
+
* // restrictedPeriodList: [
|
|
163
|
+
* // {
|
|
164
|
+
* // name: "STRING_VALUE",
|
|
165
|
+
* // startDate: "STRING_VALUE", // required
|
|
166
|
+
* // endDate: "STRING_VALUE", // required
|
|
167
|
+
* // },
|
|
168
|
+
* // ],
|
|
169
|
+
* // },
|
|
170
|
+
* // },
|
|
171
|
+
* // },
|
|
172
|
+
* // communicationLimitsOverride: { // CommunicationLimitsConfig
|
|
173
|
+
* // allChannelSubtypes: { // CommunicationLimits Union: only one key present
|
|
174
|
+
* // communicationLimitsList: [ // CommunicationLimitList
|
|
175
|
+
* // { // CommunicationLimit
|
|
176
|
+
* // maxCountPerRecipient: Number("int"), // required
|
|
177
|
+
* // frequency: Number("int"), // required
|
|
178
|
+
* // unit: "STRING_VALUE", // required
|
|
179
|
+
* // },
|
|
180
|
+
* // ],
|
|
181
|
+
* // },
|
|
182
|
+
* // },
|
|
183
|
+
* // tags: { // TagMap
|
|
184
|
+
* // "<keys>": "STRING_VALUE",
|
|
185
|
+
* // },
|
|
186
|
+
* // },
|
|
187
|
+
* // };
|
|
188
|
+
*
|
|
189
|
+
* ```
|
|
190
|
+
*
|
|
191
|
+
* @param DescribeCampaignCommandInput - {@link DescribeCampaignCommandInput}
|
|
192
|
+
* @returns {@link DescribeCampaignCommandOutput}
|
|
193
|
+
* @see {@link DescribeCampaignCommandInput} for command's `input` shape.
|
|
194
|
+
* @see {@link DescribeCampaignCommandOutput} for command's `response` shape.
|
|
195
|
+
* @see {@link ConnectCampaignsV2ClientResolvedConfig | config} for ConnectCampaignsV2Client's `config` shape.
|
|
196
|
+
*
|
|
197
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
198
|
+
* You do not have sufficient access to perform this action.
|
|
199
|
+
*
|
|
200
|
+
* @throws {@link InternalServerException} (server fault)
|
|
201
|
+
* Request processing failed because of an error or failure with the service.
|
|
202
|
+
*
|
|
203
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
204
|
+
* The specified resource was not found.
|
|
205
|
+
*
|
|
206
|
+
* @throws {@link ValidationException} (client fault)
|
|
207
|
+
* The input fails to satisfy the constraints specified by an AWS service.
|
|
208
|
+
*
|
|
209
|
+
* @throws {@link ConnectCampaignsV2ServiceException}
|
|
210
|
+
* <p>Base exception class for all service exceptions from ConnectCampaignsV2 service.</p>
|
|
211
|
+
*
|
|
212
|
+
* @public
|
|
213
|
+
*/
|
|
214
|
+
export declare class DescribeCampaignCommand extends DescribeCampaignCommand_base {
|
|
215
|
+
/** @internal type navigation helper, not in runtime. */
|
|
216
|
+
protected static __types: {
|
|
217
|
+
api: {
|
|
218
|
+
input: DescribeCampaignRequest;
|
|
219
|
+
output: DescribeCampaignResponse;
|
|
220
|
+
};
|
|
221
|
+
sdk: {
|
|
222
|
+
input: DescribeCampaignCommandInput;
|
|
223
|
+
output: DescribeCampaignCommandOutput;
|
|
224
|
+
};
|
|
225
|
+
};
|
|
226
|
+
}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsV2Client";
|
|
4
|
+
import { GetCampaignStateBatchRequest, GetCampaignStateBatchResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetCampaignStateBatchCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCampaignStateBatchCommandInput extends GetCampaignStateBatchRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCampaignStateBatchCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCampaignStateBatchCommandOutput extends GetCampaignStateBatchResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetCampaignStateBatchCommand_base: {
|
|
25
|
+
new (input: GetCampaignStateBatchCommandInput): import("@smithy/smithy-client").CommandImpl<GetCampaignStateBatchCommandInput, GetCampaignStateBatchCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetCampaignStateBatchCommandInput): import("@smithy/smithy-client").CommandImpl<GetCampaignStateBatchCommandInput, GetCampaignStateBatchCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Get state of campaigns for the specified Amazon Connect account.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectCampaignsV2Client, GetCampaignStateBatchCommand } from "@aws-sdk/client-connectcampaignsv2"; // ES Modules import
|
|
35
|
+
* // const { ConnectCampaignsV2Client, GetCampaignStateBatchCommand } = require("@aws-sdk/client-connectcampaignsv2"); // CommonJS import
|
|
36
|
+
* const client = new ConnectCampaignsV2Client(config);
|
|
37
|
+
* const input = { // GetCampaignStateBatchRequest
|
|
38
|
+
* campaignIds: [ // CampaignIdList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetCampaignStateBatchCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetCampaignStateBatchResponse
|
|
45
|
+
* // successfulRequests: [ // SuccessfulCampaignStateResponseList
|
|
46
|
+
* // { // SuccessfulCampaignStateResponse
|
|
47
|
+
* // campaignId: "STRING_VALUE",
|
|
48
|
+
* // state: "STRING_VALUE",
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // failedRequests: [ // FailedCampaignStateResponseList
|
|
52
|
+
* // { // FailedCampaignStateResponse
|
|
53
|
+
* // campaignId: "STRING_VALUE",
|
|
54
|
+
* // failureCode: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param GetCampaignStateBatchCommandInput - {@link GetCampaignStateBatchCommandInput}
|
|
62
|
+
* @returns {@link GetCampaignStateBatchCommandOutput}
|
|
63
|
+
* @see {@link GetCampaignStateBatchCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link GetCampaignStateBatchCommandOutput} for command's `response` shape.
|
|
65
|
+
* @see {@link ConnectCampaignsV2ClientResolvedConfig | config} for ConnectCampaignsV2Client's `config` shape.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
+
* You do not have sufficient access to perform this action.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerException} (server fault)
|
|
71
|
+
* Request processing failed because of an error or failure with the service.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
74
|
+
* The request was denied due to request throttling.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationException} (client fault)
|
|
77
|
+
* The input fails to satisfy the constraints specified by an AWS service.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ConnectCampaignsV2ServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from ConnectCampaignsV2 service.</p>
|
|
81
|
+
*
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export declare class GetCampaignStateBatchCommand extends GetCampaignStateBatchCommand_base {
|
|
85
|
+
/** @internal type navigation helper, not in runtime. */
|
|
86
|
+
protected static __types: {
|
|
87
|
+
api: {
|
|
88
|
+
input: GetCampaignStateBatchRequest;
|
|
89
|
+
output: GetCampaignStateBatchResponse;
|
|
90
|
+
};
|
|
91
|
+
sdk: {
|
|
92
|
+
input: GetCampaignStateBatchCommandInput;
|
|
93
|
+
output: GetCampaignStateBatchCommandOutput;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
96
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCampaignsV2Client";
|
|
4
|
+
import { GetCampaignStateRequest, GetCampaignStateResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetCampaignStateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCampaignStateCommandInput extends GetCampaignStateRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCampaignStateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCampaignStateCommandOutput extends GetCampaignStateResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetCampaignStateCommand_base: {
|
|
25
|
+
new (input: GetCampaignStateCommandInput): import("@smithy/smithy-client").CommandImpl<GetCampaignStateCommandInput, GetCampaignStateCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetCampaignStateCommandInput): import("@smithy/smithy-client").CommandImpl<GetCampaignStateCommandInput, GetCampaignStateCommandOutput, ConnectCampaignsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Get state of a campaign for the specified Amazon Connect account.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectCampaignsV2Client, GetCampaignStateCommand } from "@aws-sdk/client-connectcampaignsv2"; // ES Modules import
|
|
35
|
+
* // const { ConnectCampaignsV2Client, GetCampaignStateCommand } = require("@aws-sdk/client-connectcampaignsv2"); // CommonJS import
|
|
36
|
+
* const client = new ConnectCampaignsV2Client(config);
|
|
37
|
+
* const input = { // GetCampaignStateRequest
|
|
38
|
+
* id: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetCampaignStateCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetCampaignStateResponse
|
|
43
|
+
* // state: "STRING_VALUE",
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param GetCampaignStateCommandInput - {@link GetCampaignStateCommandInput}
|
|
49
|
+
* @returns {@link GetCampaignStateCommandOutput}
|
|
50
|
+
* @see {@link GetCampaignStateCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link GetCampaignStateCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link ConnectCampaignsV2ClientResolvedConfig | config} for ConnectCampaignsV2Client's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
+
* You do not have sufficient access to perform this action.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerException} (server fault)
|
|
58
|
+
* Request processing failed because of an error or failure with the service.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
61
|
+
* The specified resource was not found.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
64
|
+
* The request was denied due to request throttling.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
* The input fails to satisfy the constraints specified by an AWS service.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ConnectCampaignsV2ServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from ConnectCampaignsV2 service.</p>
|
|
71
|
+
*
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export declare class GetCampaignStateCommand extends GetCampaignStateCommand_base {
|
|
75
|
+
/** @internal type navigation helper, not in runtime. */
|
|
76
|
+
protected static __types: {
|
|
77
|
+
api: {
|
|
78
|
+
input: GetCampaignStateRequest;
|
|
79
|
+
output: GetCampaignStateResponse;
|
|
80
|
+
};
|
|
81
|
+
sdk: {
|
|
82
|
+
input: GetCampaignStateCommandInput;
|
|
83
|
+
output: GetCampaignStateCommandOutput;
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
}
|