@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,2299 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { ConnectCampaignsV2ServiceException as __BaseException } from "./ConnectCampaignsV2ServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* You do not have sufficient access to perform this action.
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
8
|
+
readonly name: "AccessDeniedException";
|
|
9
|
+
readonly $fault: "client";
|
|
10
|
+
/**
|
|
11
|
+
* A header that defines the error encountered while processing the request.
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
xAmzErrorType?: string | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
18
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Agentless config
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export interface AgentlessConfig {
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* The request could not be processed because of conflict in the current state of the resource.
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export declare class ConflictException extends __BaseException {
|
|
31
|
+
readonly name: "ConflictException";
|
|
32
|
+
readonly $fault: "client";
|
|
33
|
+
/**
|
|
34
|
+
* A header that defines the error encountered while processing the request.
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
xAmzErrorType?: string | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* @internal
|
|
40
|
+
*/
|
|
41
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Default Email Outbound config
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
export interface EmailOutboundConfig {
|
|
48
|
+
/**
|
|
49
|
+
* Source/Destination Email address used for Email messages
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
connectSourceEmailAddress: string | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* Display name for Email Address
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
sourceEmailAddressDisplayName?: string | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Amazon Resource Names(ARN)
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
wisdomTemplateArn: string | undefined;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Email Outbound Mode
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export type EmailOutboundMode = EmailOutboundMode.AgentlessMember | EmailOutboundMode.$UnknownMember;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare namespace EmailOutboundMode {
|
|
73
|
+
/**
|
|
74
|
+
* Agentless config
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
interface AgentlessMember {
|
|
78
|
+
agentless: AgentlessConfig;
|
|
79
|
+
$unknown?: never;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
interface $UnknownMember {
|
|
85
|
+
agentless?: never;
|
|
86
|
+
$unknown: [string, any];
|
|
87
|
+
}
|
|
88
|
+
interface Visitor<T> {
|
|
89
|
+
agentless: (value: AgentlessConfig) => T;
|
|
90
|
+
_: (name: string, value: any) => T;
|
|
91
|
+
}
|
|
92
|
+
const visit: <T>(value: EmailOutboundMode, visitor: Visitor<T>) => T;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Email Channel Subtype config
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export interface EmailChannelSubtypeConfig {
|
|
99
|
+
/**
|
|
100
|
+
* Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
capacity?: number | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* Email Outbound Mode
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
outboundMode: EmailOutboundMode | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* Default Email Outbound config
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
defaultOutboundConfig: EmailOutboundConfig | undefined;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Default SMS Outbound config
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export interface SmsOutboundConfig {
|
|
120
|
+
/**
|
|
121
|
+
* Amazon Resource Names(ARN)
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
connectSourcePhoneNumberArn: string | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* Amazon Resource Names(ARN)
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
wisdomTemplateArn: string | undefined;
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* SMS Outbound Mode
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
export type SmsOutboundMode = SmsOutboundMode.AgentlessMember | SmsOutboundMode.$UnknownMember;
|
|
136
|
+
/**
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export declare namespace SmsOutboundMode {
|
|
140
|
+
/**
|
|
141
|
+
* Agentless config
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
interface AgentlessMember {
|
|
145
|
+
agentless: AgentlessConfig;
|
|
146
|
+
$unknown?: never;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
interface $UnknownMember {
|
|
152
|
+
agentless?: never;
|
|
153
|
+
$unknown: [string, any];
|
|
154
|
+
}
|
|
155
|
+
interface Visitor<T> {
|
|
156
|
+
agentless: (value: AgentlessConfig) => T;
|
|
157
|
+
_: (name: string, value: any) => T;
|
|
158
|
+
}
|
|
159
|
+
const visit: <T>(value: SmsOutboundMode, visitor: Visitor<T>) => T;
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* SMS Channel Subtype config
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
export interface SmsChannelSubtypeConfig {
|
|
166
|
+
/**
|
|
167
|
+
* Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
capacity?: number | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* SMS Outbound Mode
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
outboundMode: SmsOutboundMode | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* Default SMS Outbound config
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
defaultOutboundConfig: SmsOutboundConfig | undefined;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Answering Machine Detection config
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
export interface AnswerMachineDetectionConfig {
|
|
187
|
+
/**
|
|
188
|
+
* Enable or disable answering machine detection
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
enableAnswerMachineDetection: boolean | undefined;
|
|
192
|
+
/**
|
|
193
|
+
* Enable or disable await answer machine prompt
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
awaitAnswerMachinePrompt?: boolean | undefined;
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* Default Telephony Outbound config
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
export interface TelephonyOutboundConfig {
|
|
203
|
+
/**
|
|
204
|
+
* The identifier of the contact flow for the outbound call.
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
connectContactFlowId: string | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
connectSourcePhoneNumber?: string | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* Answering Machine Detection config
|
|
215
|
+
* @public
|
|
216
|
+
*/
|
|
217
|
+
answerMachineDetectionConfig?: AnswerMachineDetectionConfig | undefined;
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* Predictive config
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
export interface PredictiveConfig {
|
|
224
|
+
/**
|
|
225
|
+
* The bandwidth allocation of a queue resource.
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
bandwidthAllocation: number | undefined;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* Progressive config
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
export interface ProgressiveConfig {
|
|
235
|
+
/**
|
|
236
|
+
* The bandwidth allocation of a queue resource.
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
bandwidthAllocation: number | undefined;
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Telephony Outbound Mode
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export type TelephonyOutboundMode = TelephonyOutboundMode.AgentlessMember | TelephonyOutboundMode.PredictiveMember | TelephonyOutboundMode.ProgressiveMember | TelephonyOutboundMode.$UnknownMember;
|
|
246
|
+
/**
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
export declare namespace TelephonyOutboundMode {
|
|
250
|
+
/**
|
|
251
|
+
* Progressive config
|
|
252
|
+
* @public
|
|
253
|
+
*/
|
|
254
|
+
interface ProgressiveMember {
|
|
255
|
+
progressive: ProgressiveConfig;
|
|
256
|
+
predictive?: never;
|
|
257
|
+
agentless?: never;
|
|
258
|
+
$unknown?: never;
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* Predictive config
|
|
262
|
+
* @public
|
|
263
|
+
*/
|
|
264
|
+
interface PredictiveMember {
|
|
265
|
+
progressive?: never;
|
|
266
|
+
predictive: PredictiveConfig;
|
|
267
|
+
agentless?: never;
|
|
268
|
+
$unknown?: never;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* Agentless config
|
|
272
|
+
* @public
|
|
273
|
+
*/
|
|
274
|
+
interface AgentlessMember {
|
|
275
|
+
progressive?: never;
|
|
276
|
+
predictive?: never;
|
|
277
|
+
agentless: AgentlessConfig;
|
|
278
|
+
$unknown?: never;
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
interface $UnknownMember {
|
|
284
|
+
progressive?: never;
|
|
285
|
+
predictive?: never;
|
|
286
|
+
agentless?: never;
|
|
287
|
+
$unknown: [string, any];
|
|
288
|
+
}
|
|
289
|
+
interface Visitor<T> {
|
|
290
|
+
progressive: (value: ProgressiveConfig) => T;
|
|
291
|
+
predictive: (value: PredictiveConfig) => T;
|
|
292
|
+
agentless: (value: AgentlessConfig) => T;
|
|
293
|
+
_: (name: string, value: any) => T;
|
|
294
|
+
}
|
|
295
|
+
const visit: <T>(value: TelephonyOutboundMode, visitor: Visitor<T>) => T;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* Telephony Channel Subtype config
|
|
299
|
+
* @public
|
|
300
|
+
*/
|
|
301
|
+
export interface TelephonyChannelSubtypeConfig {
|
|
302
|
+
/**
|
|
303
|
+
* Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
|
|
304
|
+
* @public
|
|
305
|
+
*/
|
|
306
|
+
capacity?: number | undefined;
|
|
307
|
+
/**
|
|
308
|
+
* The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
connectQueueId?: string | undefined;
|
|
312
|
+
/**
|
|
313
|
+
* Telephony Outbound Mode
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
outboundMode: TelephonyOutboundMode | undefined;
|
|
317
|
+
/**
|
|
318
|
+
* Default Telephony Outbound config
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
defaultOutboundConfig: TelephonyOutboundConfig | undefined;
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
* Campaign Channel Subtype config
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
export interface ChannelSubtypeConfig {
|
|
328
|
+
/**
|
|
329
|
+
* Telephony Channel Subtype config
|
|
330
|
+
* @public
|
|
331
|
+
*/
|
|
332
|
+
telephony?: TelephonyChannelSubtypeConfig | undefined;
|
|
333
|
+
/**
|
|
334
|
+
* SMS Channel Subtype config
|
|
335
|
+
* @public
|
|
336
|
+
*/
|
|
337
|
+
sms?: SmsChannelSubtypeConfig | undefined;
|
|
338
|
+
/**
|
|
339
|
+
* Email Channel Subtype config
|
|
340
|
+
* @public
|
|
341
|
+
*/
|
|
342
|
+
email?: EmailChannelSubtypeConfig | undefined;
|
|
343
|
+
}
|
|
344
|
+
/**
|
|
345
|
+
* @public
|
|
346
|
+
* @enum
|
|
347
|
+
*/
|
|
348
|
+
export declare const CommunicationLimitTimeUnit: {
|
|
349
|
+
readonly DAY: "DAY";
|
|
350
|
+
};
|
|
351
|
+
/**
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
export type CommunicationLimitTimeUnit = (typeof CommunicationLimitTimeUnit)[keyof typeof CommunicationLimitTimeUnit];
|
|
355
|
+
/**
|
|
356
|
+
* Communication Limit
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
export interface CommunicationLimit {
|
|
360
|
+
/**
|
|
361
|
+
* Maximum number of contacts allowed for a given target within the given frequency.
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
maxCountPerRecipient: number | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* The number of days to consider with regards to this limit.
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
frequency: number | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* The communication limit time unit.
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
unit: CommunicationLimitTimeUnit | undefined;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* Communication limits
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
export type CommunicationLimits = CommunicationLimits.CommunicationLimitsListMember | CommunicationLimits.$UnknownMember;
|
|
381
|
+
/**
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
export declare namespace CommunicationLimits {
|
|
385
|
+
/**
|
|
386
|
+
* List of communication limit
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
interface CommunicationLimitsListMember {
|
|
390
|
+
communicationLimitsList: CommunicationLimit[];
|
|
391
|
+
$unknown?: never;
|
|
392
|
+
}
|
|
393
|
+
/**
|
|
394
|
+
* @public
|
|
395
|
+
*/
|
|
396
|
+
interface $UnknownMember {
|
|
397
|
+
communicationLimitsList?: never;
|
|
398
|
+
$unknown: [string, any];
|
|
399
|
+
}
|
|
400
|
+
interface Visitor<T> {
|
|
401
|
+
communicationLimitsList: (value: CommunicationLimit[]) => T;
|
|
402
|
+
_: (name: string, value: any) => T;
|
|
403
|
+
}
|
|
404
|
+
const visit: <T>(value: CommunicationLimits, visitor: Visitor<T>) => T;
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* Communication limits config
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
export interface CommunicationLimitsConfig {
|
|
411
|
+
/**
|
|
412
|
+
* Communication limits
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
allChannelSubtypes?: CommunicationLimits | undefined;
|
|
416
|
+
}
|
|
417
|
+
/**
|
|
418
|
+
* @public
|
|
419
|
+
* @enum
|
|
420
|
+
*/
|
|
421
|
+
export declare const DayOfWeek: {
|
|
422
|
+
readonly FRIDAY: "FRIDAY";
|
|
423
|
+
readonly MONDAY: "MONDAY";
|
|
424
|
+
readonly SATURDAY: "SATURDAY";
|
|
425
|
+
readonly SUNDAY: "SUNDAY";
|
|
426
|
+
readonly THURSDAY: "THURSDAY";
|
|
427
|
+
readonly TUESDAY: "TUESDAY";
|
|
428
|
+
readonly WEDNESDAY: "WEDNESDAY";
|
|
429
|
+
};
|
|
430
|
+
/**
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek];
|
|
434
|
+
/**
|
|
435
|
+
* Time range in 24 hour format
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
export interface TimeRange {
|
|
439
|
+
/**
|
|
440
|
+
* Time in ISO 8601 format, e.g. T23:11
|
|
441
|
+
* @public
|
|
442
|
+
*/
|
|
443
|
+
startTime: string | undefined;
|
|
444
|
+
/**
|
|
445
|
+
* Time in ISO 8601 format, e.g. T23:11
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
endTime: string | undefined;
|
|
449
|
+
}
|
|
450
|
+
/**
|
|
451
|
+
* Open Hours config
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
export type OpenHours = OpenHours.DailyHoursMember | OpenHours.$UnknownMember;
|
|
455
|
+
/**
|
|
456
|
+
* @public
|
|
457
|
+
*/
|
|
458
|
+
export declare namespace OpenHours {
|
|
459
|
+
/**
|
|
460
|
+
* Daily Hours map
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
interface DailyHoursMember {
|
|
464
|
+
dailyHours: Partial<Record<DayOfWeek, TimeRange[]>>;
|
|
465
|
+
$unknown?: never;
|
|
466
|
+
}
|
|
467
|
+
/**
|
|
468
|
+
* @public
|
|
469
|
+
*/
|
|
470
|
+
interface $UnknownMember {
|
|
471
|
+
dailyHours?: never;
|
|
472
|
+
$unknown: [string, any];
|
|
473
|
+
}
|
|
474
|
+
interface Visitor<T> {
|
|
475
|
+
dailyHours: (value: Partial<Record<DayOfWeek, TimeRange[]>>) => T;
|
|
476
|
+
_: (name: string, value: any) => T;
|
|
477
|
+
}
|
|
478
|
+
const visit: <T>(value: OpenHours, visitor: Visitor<T>) => T;
|
|
479
|
+
}
|
|
480
|
+
/**
|
|
481
|
+
* Restricted period
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
export interface RestrictedPeriod {
|
|
485
|
+
/**
|
|
486
|
+
* The name of a restricted period.
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
name?: string | undefined;
|
|
490
|
+
/**
|
|
491
|
+
* Date in ISO 8601 format, e.g. 2024-01-01
|
|
492
|
+
* @public
|
|
493
|
+
*/
|
|
494
|
+
startDate: string | undefined;
|
|
495
|
+
/**
|
|
496
|
+
* Date in ISO 8601 format, e.g. 2024-01-01
|
|
497
|
+
* @public
|
|
498
|
+
*/
|
|
499
|
+
endDate: string | undefined;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* Restricted period config
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
export type RestrictedPeriods = RestrictedPeriods.RestrictedPeriodListMember | RestrictedPeriods.$UnknownMember;
|
|
506
|
+
/**
|
|
507
|
+
* @public
|
|
508
|
+
*/
|
|
509
|
+
export declare namespace RestrictedPeriods {
|
|
510
|
+
/**
|
|
511
|
+
* List of restricted period
|
|
512
|
+
* @public
|
|
513
|
+
*/
|
|
514
|
+
interface RestrictedPeriodListMember {
|
|
515
|
+
restrictedPeriodList: RestrictedPeriod[];
|
|
516
|
+
$unknown?: never;
|
|
517
|
+
}
|
|
518
|
+
/**
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
interface $UnknownMember {
|
|
522
|
+
restrictedPeriodList?: never;
|
|
523
|
+
$unknown: [string, any];
|
|
524
|
+
}
|
|
525
|
+
interface Visitor<T> {
|
|
526
|
+
restrictedPeriodList: (value: RestrictedPeriod[]) => T;
|
|
527
|
+
_: (name: string, value: any) => T;
|
|
528
|
+
}
|
|
529
|
+
const visit: <T>(value: RestrictedPeriods, visitor: Visitor<T>) => T;
|
|
530
|
+
}
|
|
531
|
+
/**
|
|
532
|
+
* Time window config
|
|
533
|
+
* @public
|
|
534
|
+
*/
|
|
535
|
+
export interface TimeWindow {
|
|
536
|
+
/**
|
|
537
|
+
* Open Hours config
|
|
538
|
+
* @public
|
|
539
|
+
*/
|
|
540
|
+
openHours: OpenHours | undefined;
|
|
541
|
+
/**
|
|
542
|
+
* Restricted period config
|
|
543
|
+
* @public
|
|
544
|
+
*/
|
|
545
|
+
restrictedPeriods?: RestrictedPeriods | undefined;
|
|
546
|
+
}
|
|
547
|
+
/**
|
|
548
|
+
* @public
|
|
549
|
+
* @enum
|
|
550
|
+
*/
|
|
551
|
+
export declare const LocalTimeZoneDetectionType: {
|
|
552
|
+
readonly AREA_CODE: "AREA_CODE";
|
|
553
|
+
readonly ZIP_CODE: "ZIP_CODE";
|
|
554
|
+
};
|
|
555
|
+
/**
|
|
556
|
+
* @public
|
|
557
|
+
*/
|
|
558
|
+
export type LocalTimeZoneDetectionType = (typeof LocalTimeZoneDetectionType)[keyof typeof LocalTimeZoneDetectionType];
|
|
559
|
+
/**
|
|
560
|
+
* Local time zone config
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
export interface LocalTimeZoneConfig {
|
|
564
|
+
/**
|
|
565
|
+
* Time Zone Id in the IANA format
|
|
566
|
+
* @public
|
|
567
|
+
*/
|
|
568
|
+
defaultTimeZone?: string | undefined;
|
|
569
|
+
/**
|
|
570
|
+
* Local TimeZone Detection method list
|
|
571
|
+
* @public
|
|
572
|
+
*/
|
|
573
|
+
localTimeZoneDetection?: LocalTimeZoneDetectionType[] | undefined;
|
|
574
|
+
}
|
|
575
|
+
/**
|
|
576
|
+
* Campaign communication time config
|
|
577
|
+
* @public
|
|
578
|
+
*/
|
|
579
|
+
export interface CommunicationTimeConfig {
|
|
580
|
+
/**
|
|
581
|
+
* Local time zone config
|
|
582
|
+
* @public
|
|
583
|
+
*/
|
|
584
|
+
localTimeZoneConfig: LocalTimeZoneConfig | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* Time window config
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
telephony?: TimeWindow | undefined;
|
|
590
|
+
/**
|
|
591
|
+
* Time window config
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
sms?: TimeWindow | undefined;
|
|
595
|
+
/**
|
|
596
|
+
* Time window config
|
|
597
|
+
* @public
|
|
598
|
+
*/
|
|
599
|
+
email?: TimeWindow | undefined;
|
|
600
|
+
}
|
|
601
|
+
/**
|
|
602
|
+
* Campaign schedule
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
export interface Schedule {
|
|
606
|
+
/**
|
|
607
|
+
* Timestamp with no UTC offset or timezone
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
startTime: Date | undefined;
|
|
611
|
+
/**
|
|
612
|
+
* Timestamp with no UTC offset or timezone
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
endTime: Date | undefined;
|
|
616
|
+
/**
|
|
617
|
+
* Time duration in ISO 8601 format
|
|
618
|
+
* @public
|
|
619
|
+
*/
|
|
620
|
+
refreshFrequency?: string | undefined;
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* Source of the campaign
|
|
624
|
+
* @public
|
|
625
|
+
*/
|
|
626
|
+
export type Source = Source.CustomerProfilesSegmentArnMember | Source.$UnknownMember;
|
|
627
|
+
/**
|
|
628
|
+
* @public
|
|
629
|
+
*/
|
|
630
|
+
export declare namespace Source {
|
|
631
|
+
/**
|
|
632
|
+
* Amazon Resource Names(ARN)
|
|
633
|
+
* @public
|
|
634
|
+
*/
|
|
635
|
+
interface CustomerProfilesSegmentArnMember {
|
|
636
|
+
customerProfilesSegmentArn: string;
|
|
637
|
+
$unknown?: never;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
interface $UnknownMember {
|
|
643
|
+
customerProfilesSegmentArn?: never;
|
|
644
|
+
$unknown: [string, any];
|
|
645
|
+
}
|
|
646
|
+
interface Visitor<T> {
|
|
647
|
+
customerProfilesSegmentArn: (value: string) => T;
|
|
648
|
+
_: (name: string, value: any) => T;
|
|
649
|
+
}
|
|
650
|
+
const visit: <T>(value: Source, visitor: Visitor<T>) => T;
|
|
651
|
+
}
|
|
652
|
+
/**
|
|
653
|
+
* The request for CreateCampaign API.
|
|
654
|
+
* @public
|
|
655
|
+
*/
|
|
656
|
+
export interface CreateCampaignRequest {
|
|
657
|
+
/**
|
|
658
|
+
* The name of an Amazon Connect Campaign name.
|
|
659
|
+
* @public
|
|
660
|
+
*/
|
|
661
|
+
name: string | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* Amazon Connect Instance Id
|
|
664
|
+
* @public
|
|
665
|
+
*/
|
|
666
|
+
connectInstanceId: string | undefined;
|
|
667
|
+
/**
|
|
668
|
+
* Campaign Channel Subtype config
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
channelSubtypeConfig: ChannelSubtypeConfig | undefined;
|
|
672
|
+
/**
|
|
673
|
+
* Source of the campaign
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
source?: Source | undefined;
|
|
677
|
+
/**
|
|
678
|
+
* Amazon Resource Names(ARN)
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
connectCampaignFlowArn?: string | undefined;
|
|
682
|
+
/**
|
|
683
|
+
* Campaign schedule
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
schedule?: Schedule | undefined;
|
|
687
|
+
/**
|
|
688
|
+
* Campaign communication time config
|
|
689
|
+
* @public
|
|
690
|
+
*/
|
|
691
|
+
communicationTimeConfig?: CommunicationTimeConfig | undefined;
|
|
692
|
+
/**
|
|
693
|
+
* Communication limits config
|
|
694
|
+
* @public
|
|
695
|
+
*/
|
|
696
|
+
communicationLimitsOverride?: CommunicationLimitsConfig | undefined;
|
|
697
|
+
/**
|
|
698
|
+
* Tag map with key and value.
|
|
699
|
+
* @public
|
|
700
|
+
*/
|
|
701
|
+
tags?: Record<string, string> | undefined;
|
|
702
|
+
}
|
|
703
|
+
/**
|
|
704
|
+
* The response for Create Campaign API
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
export interface CreateCampaignResponse {
|
|
708
|
+
/**
|
|
709
|
+
* Identifier representing a Campaign
|
|
710
|
+
* @public
|
|
711
|
+
*/
|
|
712
|
+
id?: string | undefined;
|
|
713
|
+
/**
|
|
714
|
+
* The resource name of an Amazon Connect campaign.
|
|
715
|
+
* @public
|
|
716
|
+
*/
|
|
717
|
+
arn?: string | undefined;
|
|
718
|
+
/**
|
|
719
|
+
* Tag map with key and value.
|
|
720
|
+
* @public
|
|
721
|
+
*/
|
|
722
|
+
tags?: Record<string, string> | undefined;
|
|
723
|
+
}
|
|
724
|
+
/**
|
|
725
|
+
* Request processing failed because of an error or failure with the service.
|
|
726
|
+
* @public
|
|
727
|
+
*/
|
|
728
|
+
export declare class InternalServerException extends __BaseException {
|
|
729
|
+
readonly name: "InternalServerException";
|
|
730
|
+
readonly $fault: "server";
|
|
731
|
+
$retryable: {};
|
|
732
|
+
/**
|
|
733
|
+
* A header that defines the error encountered while processing the request.
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
xAmzErrorType?: string | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* @internal
|
|
739
|
+
*/
|
|
740
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
741
|
+
}
|
|
742
|
+
/**
|
|
743
|
+
* The specified resource was not found.
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
747
|
+
readonly name: "ResourceNotFoundException";
|
|
748
|
+
readonly $fault: "client";
|
|
749
|
+
/**
|
|
750
|
+
* A header that defines the error encountered while processing the request.
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
xAmzErrorType?: string | undefined;
|
|
754
|
+
/**
|
|
755
|
+
* @internal
|
|
756
|
+
*/
|
|
757
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
758
|
+
}
|
|
759
|
+
/**
|
|
760
|
+
* Request would cause a service quota to be exceeded.
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
764
|
+
readonly name: "ServiceQuotaExceededException";
|
|
765
|
+
readonly $fault: "client";
|
|
766
|
+
/**
|
|
767
|
+
* A header that defines the error encountered while processing the request.
|
|
768
|
+
* @public
|
|
769
|
+
*/
|
|
770
|
+
xAmzErrorType?: string | undefined;
|
|
771
|
+
/**
|
|
772
|
+
* @internal
|
|
773
|
+
*/
|
|
774
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
775
|
+
}
|
|
776
|
+
/**
|
|
777
|
+
* The request was denied due to request throttling.
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
export declare class ThrottlingException extends __BaseException {
|
|
781
|
+
readonly name: "ThrottlingException";
|
|
782
|
+
readonly $fault: "client";
|
|
783
|
+
$retryable: {};
|
|
784
|
+
/**
|
|
785
|
+
* A header that defines the error encountered while processing the request.
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
788
|
+
xAmzErrorType?: string | undefined;
|
|
789
|
+
/**
|
|
790
|
+
* @internal
|
|
791
|
+
*/
|
|
792
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
793
|
+
}
|
|
794
|
+
/**
|
|
795
|
+
* The input fails to satisfy the constraints specified by an AWS service.
|
|
796
|
+
* @public
|
|
797
|
+
*/
|
|
798
|
+
export declare class ValidationException extends __BaseException {
|
|
799
|
+
readonly name: "ValidationException";
|
|
800
|
+
readonly $fault: "client";
|
|
801
|
+
/**
|
|
802
|
+
* A header that defines the error encountered while processing the request.
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
805
|
+
xAmzErrorType?: string | undefined;
|
|
806
|
+
/**
|
|
807
|
+
* @internal
|
|
808
|
+
*/
|
|
809
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
810
|
+
}
|
|
811
|
+
/**
|
|
812
|
+
* The request for DeleteCampaign API.
|
|
813
|
+
* @public
|
|
814
|
+
*/
|
|
815
|
+
export interface DeleteCampaignRequest {
|
|
816
|
+
/**
|
|
817
|
+
* Identifier representing a Campaign
|
|
818
|
+
* @public
|
|
819
|
+
*/
|
|
820
|
+
id: string | undefined;
|
|
821
|
+
}
|
|
822
|
+
/**
|
|
823
|
+
* @public
|
|
824
|
+
* @enum
|
|
825
|
+
*/
|
|
826
|
+
export declare const ChannelSubtype: {
|
|
827
|
+
readonly EMAIL: "EMAIL";
|
|
828
|
+
readonly SMS: "SMS";
|
|
829
|
+
readonly TELEPHONY: "TELEPHONY";
|
|
830
|
+
};
|
|
831
|
+
/**
|
|
832
|
+
* @public
|
|
833
|
+
*/
|
|
834
|
+
export type ChannelSubtype = (typeof ChannelSubtype)[keyof typeof ChannelSubtype];
|
|
835
|
+
/**
|
|
836
|
+
* The request for DeleteCampaignChannelSubtypeConfig API.
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
export interface DeleteCampaignChannelSubtypeConfigRequest {
|
|
840
|
+
/**
|
|
841
|
+
* Identifier representing a Campaign
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
id: string | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* The type of campaign channel subtype.
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
850
|
+
}
|
|
851
|
+
/**
|
|
852
|
+
* @public
|
|
853
|
+
* @enum
|
|
854
|
+
*/
|
|
855
|
+
export declare const CommunicationLimitsConfigType: {
|
|
856
|
+
readonly ALL_CHANNEL_SUBTYPES: "ALL_CHANNEL_SUBTYPES";
|
|
857
|
+
};
|
|
858
|
+
/**
|
|
859
|
+
* @public
|
|
860
|
+
*/
|
|
861
|
+
export type CommunicationLimitsConfigType = (typeof CommunicationLimitsConfigType)[keyof typeof CommunicationLimitsConfigType];
|
|
862
|
+
/**
|
|
863
|
+
* The request for DeleteCampaignCommunicationLimits API.
|
|
864
|
+
* @public
|
|
865
|
+
*/
|
|
866
|
+
export interface DeleteCampaignCommunicationLimitsRequest {
|
|
867
|
+
/**
|
|
868
|
+
* Identifier representing a Campaign
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
id: string | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* The type of campaign communication limits config.
|
|
874
|
+
* @public
|
|
875
|
+
*/
|
|
876
|
+
config: CommunicationLimitsConfigType | undefined;
|
|
877
|
+
}
|
|
878
|
+
/**
|
|
879
|
+
* @public
|
|
880
|
+
* @enum
|
|
881
|
+
*/
|
|
882
|
+
export declare const CampaignState: {
|
|
883
|
+
/**
|
|
884
|
+
* Campaign is in completed state
|
|
885
|
+
*/
|
|
886
|
+
readonly COMPLETED: "Completed";
|
|
887
|
+
/**
|
|
888
|
+
* Campaign is in failed state
|
|
889
|
+
*/
|
|
890
|
+
readonly FAILED: "Failed";
|
|
891
|
+
/**
|
|
892
|
+
* Campaign is in initialized state
|
|
893
|
+
*/
|
|
894
|
+
readonly INITIALIZED: "Initialized";
|
|
895
|
+
/**
|
|
896
|
+
* Campaign is in paused state
|
|
897
|
+
*/
|
|
898
|
+
readonly PAUSED: "Paused";
|
|
899
|
+
/**
|
|
900
|
+
* Campaign is in running state
|
|
901
|
+
*/
|
|
902
|
+
readonly RUNNING: "Running";
|
|
903
|
+
/**
|
|
904
|
+
* Campaign is in stopped state
|
|
905
|
+
*/
|
|
906
|
+
readonly STOPPED: "Stopped";
|
|
907
|
+
};
|
|
908
|
+
/**
|
|
909
|
+
* @public
|
|
910
|
+
*/
|
|
911
|
+
export type CampaignState = (typeof CampaignState)[keyof typeof CampaignState];
|
|
912
|
+
/**
|
|
913
|
+
* The request could not be processed because of conflict in the current state of the campaign.
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
export declare class InvalidCampaignStateException extends __BaseException {
|
|
917
|
+
readonly name: "InvalidCampaignStateException";
|
|
918
|
+
readonly $fault: "client";
|
|
919
|
+
/**
|
|
920
|
+
* State of a campaign
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
state: CampaignState | undefined;
|
|
924
|
+
/**
|
|
925
|
+
* A header that defines the error encountered while processing the request.
|
|
926
|
+
* @public
|
|
927
|
+
*/
|
|
928
|
+
xAmzErrorType?: string | undefined;
|
|
929
|
+
/**
|
|
930
|
+
* @internal
|
|
931
|
+
*/
|
|
932
|
+
constructor(opts: __ExceptionOptionType<InvalidCampaignStateException, __BaseException>);
|
|
933
|
+
}
|
|
934
|
+
/**
|
|
935
|
+
* @public
|
|
936
|
+
* @enum
|
|
937
|
+
*/
|
|
938
|
+
export declare const CommunicationTimeConfigType: {
|
|
939
|
+
readonly EMAIL: "EMAIL";
|
|
940
|
+
readonly SMS: "SMS";
|
|
941
|
+
readonly TELEPHONY: "TELEPHONY";
|
|
942
|
+
};
|
|
943
|
+
/**
|
|
944
|
+
* @public
|
|
945
|
+
*/
|
|
946
|
+
export type CommunicationTimeConfigType = (typeof CommunicationTimeConfigType)[keyof typeof CommunicationTimeConfigType];
|
|
947
|
+
/**
|
|
948
|
+
* The request for DeleteCampaignCommunicationTime API.
|
|
949
|
+
* @public
|
|
950
|
+
*/
|
|
951
|
+
export interface DeleteCampaignCommunicationTimeRequest {
|
|
952
|
+
/**
|
|
953
|
+
* Identifier representing a Campaign
|
|
954
|
+
* @public
|
|
955
|
+
*/
|
|
956
|
+
id: string | undefined;
|
|
957
|
+
/**
|
|
958
|
+
* The type of campaign communication time config
|
|
959
|
+
* @public
|
|
960
|
+
*/
|
|
961
|
+
config: CommunicationTimeConfigType | undefined;
|
|
962
|
+
}
|
|
963
|
+
/**
|
|
964
|
+
* @public
|
|
965
|
+
* @enum
|
|
966
|
+
*/
|
|
967
|
+
export declare const CampaignDeletionPolicy: {
|
|
968
|
+
readonly DELETE_ALL: "DELETE_ALL";
|
|
969
|
+
readonly RETAIN_ALL: "RETAIN_ALL";
|
|
970
|
+
};
|
|
971
|
+
/**
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
export type CampaignDeletionPolicy = (typeof CampaignDeletionPolicy)[keyof typeof CampaignDeletionPolicy];
|
|
975
|
+
/**
|
|
976
|
+
* The request for DeleteConnectInstanceConfig API.
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
export interface DeleteConnectInstanceConfigRequest {
|
|
980
|
+
/**
|
|
981
|
+
* Amazon Connect Instance Id
|
|
982
|
+
* @public
|
|
983
|
+
*/
|
|
984
|
+
connectInstanceId: string | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* Enumeration of the policies to enact on existing campaigns during instance config deletion
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
campaignDeletionPolicy?: CampaignDeletionPolicy | undefined;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* The request could not be processed because of conflict in the current state.
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
export declare class InvalidStateException extends __BaseException {
|
|
996
|
+
readonly name: "InvalidStateException";
|
|
997
|
+
readonly $fault: "client";
|
|
998
|
+
/**
|
|
999
|
+
* A header that defines the error encountered while processing the request.
|
|
1000
|
+
* @public
|
|
1001
|
+
*/
|
|
1002
|
+
xAmzErrorType?: string | undefined;
|
|
1003
|
+
/**
|
|
1004
|
+
* @internal
|
|
1005
|
+
*/
|
|
1006
|
+
constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
|
|
1007
|
+
}
|
|
1008
|
+
/**
|
|
1009
|
+
* Customer Profiles integration identifier
|
|
1010
|
+
* @public
|
|
1011
|
+
*/
|
|
1012
|
+
export interface CustomerProfilesIntegrationIdentifier {
|
|
1013
|
+
/**
|
|
1014
|
+
* Amazon Resource Names(ARN)
|
|
1015
|
+
* @public
|
|
1016
|
+
*/
|
|
1017
|
+
domainArn: string | undefined;
|
|
1018
|
+
}
|
|
1019
|
+
/**
|
|
1020
|
+
* Q Connect integration identifier
|
|
1021
|
+
* @public
|
|
1022
|
+
*/
|
|
1023
|
+
export interface QConnectIntegrationIdentifier {
|
|
1024
|
+
/**
|
|
1025
|
+
* Amazon Resource Names(ARN)
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
knowledgeBaseArn: string | undefined;
|
|
1029
|
+
}
|
|
1030
|
+
/**
|
|
1031
|
+
* Integration identifier for Connect instance
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
export type IntegrationIdentifier = IntegrationIdentifier.CustomerProfilesMember | IntegrationIdentifier.QConnectMember | IntegrationIdentifier.$UnknownMember;
|
|
1035
|
+
/**
|
|
1036
|
+
* @public
|
|
1037
|
+
*/
|
|
1038
|
+
export declare namespace IntegrationIdentifier {
|
|
1039
|
+
/**
|
|
1040
|
+
* Customer Profiles integration identifier
|
|
1041
|
+
* @public
|
|
1042
|
+
*/
|
|
1043
|
+
interface CustomerProfilesMember {
|
|
1044
|
+
customerProfiles: CustomerProfilesIntegrationIdentifier;
|
|
1045
|
+
qConnect?: never;
|
|
1046
|
+
$unknown?: never;
|
|
1047
|
+
}
|
|
1048
|
+
/**
|
|
1049
|
+
* Q Connect integration identifier
|
|
1050
|
+
* @public
|
|
1051
|
+
*/
|
|
1052
|
+
interface QConnectMember {
|
|
1053
|
+
customerProfiles?: never;
|
|
1054
|
+
qConnect: QConnectIntegrationIdentifier;
|
|
1055
|
+
$unknown?: never;
|
|
1056
|
+
}
|
|
1057
|
+
/**
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
interface $UnknownMember {
|
|
1061
|
+
customerProfiles?: never;
|
|
1062
|
+
qConnect?: never;
|
|
1063
|
+
$unknown: [string, any];
|
|
1064
|
+
}
|
|
1065
|
+
interface Visitor<T> {
|
|
1066
|
+
customerProfiles: (value: CustomerProfilesIntegrationIdentifier) => T;
|
|
1067
|
+
qConnect: (value: QConnectIntegrationIdentifier) => T;
|
|
1068
|
+
_: (name: string, value: any) => T;
|
|
1069
|
+
}
|
|
1070
|
+
const visit: <T>(value: IntegrationIdentifier, visitor: Visitor<T>) => T;
|
|
1071
|
+
}
|
|
1072
|
+
/**
|
|
1073
|
+
* The request for DeleteConnectInstanceIntegration API.
|
|
1074
|
+
* @public
|
|
1075
|
+
*/
|
|
1076
|
+
export interface DeleteConnectInstanceIntegrationRequest {
|
|
1077
|
+
/**
|
|
1078
|
+
* Amazon Connect Instance Id
|
|
1079
|
+
* @public
|
|
1080
|
+
*/
|
|
1081
|
+
connectInstanceId: string | undefined;
|
|
1082
|
+
/**
|
|
1083
|
+
* Integration identifier for Connect instance
|
|
1084
|
+
* @public
|
|
1085
|
+
*/
|
|
1086
|
+
integrationIdentifier: IntegrationIdentifier | undefined;
|
|
1087
|
+
}
|
|
1088
|
+
/**
|
|
1089
|
+
* The request for DeleteInstanceOnboardingJob API.
|
|
1090
|
+
* @public
|
|
1091
|
+
*/
|
|
1092
|
+
export interface DeleteInstanceOnboardingJobRequest {
|
|
1093
|
+
/**
|
|
1094
|
+
* Amazon Connect Instance Id
|
|
1095
|
+
* @public
|
|
1096
|
+
*/
|
|
1097
|
+
connectInstanceId: string | undefined;
|
|
1098
|
+
}
|
|
1099
|
+
/**
|
|
1100
|
+
* The request for DescribeCampaign API.
|
|
1101
|
+
* @public
|
|
1102
|
+
*/
|
|
1103
|
+
export interface DescribeCampaignRequest {
|
|
1104
|
+
/**
|
|
1105
|
+
* Identifier representing a Campaign
|
|
1106
|
+
* @public
|
|
1107
|
+
*/
|
|
1108
|
+
id: string | undefined;
|
|
1109
|
+
}
|
|
1110
|
+
/**
|
|
1111
|
+
* An Amazon Connect campaign.
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1114
|
+
export interface Campaign {
|
|
1115
|
+
/**
|
|
1116
|
+
* Identifier representing a Campaign
|
|
1117
|
+
* @public
|
|
1118
|
+
*/
|
|
1119
|
+
id: string | undefined;
|
|
1120
|
+
/**
|
|
1121
|
+
* The resource name of an Amazon Connect campaign.
|
|
1122
|
+
* @public
|
|
1123
|
+
*/
|
|
1124
|
+
arn: string | undefined;
|
|
1125
|
+
/**
|
|
1126
|
+
* The name of an Amazon Connect Campaign name.
|
|
1127
|
+
* @public
|
|
1128
|
+
*/
|
|
1129
|
+
name: string | undefined;
|
|
1130
|
+
/**
|
|
1131
|
+
* Amazon Connect Instance Id
|
|
1132
|
+
* @public
|
|
1133
|
+
*/
|
|
1134
|
+
connectInstanceId: string | undefined;
|
|
1135
|
+
/**
|
|
1136
|
+
* Campaign Channel Subtype config
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
channelSubtypeConfig: ChannelSubtypeConfig | undefined;
|
|
1140
|
+
/**
|
|
1141
|
+
* Source of the campaign
|
|
1142
|
+
* @public
|
|
1143
|
+
*/
|
|
1144
|
+
source?: Source | undefined;
|
|
1145
|
+
/**
|
|
1146
|
+
* Amazon Resource Names(ARN)
|
|
1147
|
+
* @public
|
|
1148
|
+
*/
|
|
1149
|
+
connectCampaignFlowArn?: string | undefined;
|
|
1150
|
+
/**
|
|
1151
|
+
* Campaign schedule
|
|
1152
|
+
* @public
|
|
1153
|
+
*/
|
|
1154
|
+
schedule?: Schedule | undefined;
|
|
1155
|
+
/**
|
|
1156
|
+
* Campaign communication time config
|
|
1157
|
+
* @public
|
|
1158
|
+
*/
|
|
1159
|
+
communicationTimeConfig?: CommunicationTimeConfig | undefined;
|
|
1160
|
+
/**
|
|
1161
|
+
* Communication limits config
|
|
1162
|
+
* @public
|
|
1163
|
+
*/
|
|
1164
|
+
communicationLimitsOverride?: CommunicationLimitsConfig | undefined;
|
|
1165
|
+
/**
|
|
1166
|
+
* Tag map with key and value.
|
|
1167
|
+
* @public
|
|
1168
|
+
*/
|
|
1169
|
+
tags?: Record<string, string> | undefined;
|
|
1170
|
+
}
|
|
1171
|
+
/**
|
|
1172
|
+
* The response for DescribeCampaign API.
|
|
1173
|
+
* @public
|
|
1174
|
+
*/
|
|
1175
|
+
export interface DescribeCampaignResponse {
|
|
1176
|
+
/**
|
|
1177
|
+
* An Amazon Connect campaign.
|
|
1178
|
+
* @public
|
|
1179
|
+
*/
|
|
1180
|
+
campaign?: Campaign | undefined;
|
|
1181
|
+
}
|
|
1182
|
+
/**
|
|
1183
|
+
* The request for GetCampaignState API.
|
|
1184
|
+
* @public
|
|
1185
|
+
*/
|
|
1186
|
+
export interface GetCampaignStateRequest {
|
|
1187
|
+
/**
|
|
1188
|
+
* Identifier representing a Campaign
|
|
1189
|
+
* @public
|
|
1190
|
+
*/
|
|
1191
|
+
id: string | undefined;
|
|
1192
|
+
}
|
|
1193
|
+
/**
|
|
1194
|
+
* The response for GetCampaignState API.
|
|
1195
|
+
* @public
|
|
1196
|
+
*/
|
|
1197
|
+
export interface GetCampaignStateResponse {
|
|
1198
|
+
/**
|
|
1199
|
+
* State of a campaign
|
|
1200
|
+
* @public
|
|
1201
|
+
*/
|
|
1202
|
+
state?: CampaignState | undefined;
|
|
1203
|
+
}
|
|
1204
|
+
/**
|
|
1205
|
+
* The request for GetCampaignStateBatch API.
|
|
1206
|
+
* @public
|
|
1207
|
+
*/
|
|
1208
|
+
export interface GetCampaignStateBatchRequest {
|
|
1209
|
+
/**
|
|
1210
|
+
* List of CampaignId
|
|
1211
|
+
* @public
|
|
1212
|
+
*/
|
|
1213
|
+
campaignIds: string[] | undefined;
|
|
1214
|
+
}
|
|
1215
|
+
/**
|
|
1216
|
+
* @public
|
|
1217
|
+
* @enum
|
|
1218
|
+
*/
|
|
1219
|
+
export declare const GetCampaignStateBatchFailureCode: {
|
|
1220
|
+
/**
|
|
1221
|
+
* The specified resource was not found
|
|
1222
|
+
*/
|
|
1223
|
+
readonly RESOURCE_NOT_FOUND: "ResourceNotFound";
|
|
1224
|
+
/**
|
|
1225
|
+
* Unexpected error during processing of request
|
|
1226
|
+
*/
|
|
1227
|
+
readonly UNKNOWN_ERROR: "UnknownError";
|
|
1228
|
+
};
|
|
1229
|
+
/**
|
|
1230
|
+
* @public
|
|
1231
|
+
*/
|
|
1232
|
+
export type GetCampaignStateBatchFailureCode = (typeof GetCampaignStateBatchFailureCode)[keyof typeof GetCampaignStateBatchFailureCode];
|
|
1233
|
+
/**
|
|
1234
|
+
* Failed response of campaign state
|
|
1235
|
+
* @public
|
|
1236
|
+
*/
|
|
1237
|
+
export interface FailedCampaignStateResponse {
|
|
1238
|
+
/**
|
|
1239
|
+
* Identifier representing a Campaign
|
|
1240
|
+
* @public
|
|
1241
|
+
*/
|
|
1242
|
+
campaignId?: string | undefined;
|
|
1243
|
+
/**
|
|
1244
|
+
* A predefined code indicating the error that caused the failure in getting state of campaigns
|
|
1245
|
+
* @public
|
|
1246
|
+
*/
|
|
1247
|
+
failureCode?: GetCampaignStateBatchFailureCode | undefined;
|
|
1248
|
+
}
|
|
1249
|
+
/**
|
|
1250
|
+
* Successful response of campaign state
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
export interface SuccessfulCampaignStateResponse {
|
|
1254
|
+
/**
|
|
1255
|
+
* Identifier representing a Campaign
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
campaignId?: string | undefined;
|
|
1259
|
+
/**
|
|
1260
|
+
* State of a campaign
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
state?: CampaignState | undefined;
|
|
1264
|
+
}
|
|
1265
|
+
/**
|
|
1266
|
+
* The response for GetCampaignStateBatch API.
|
|
1267
|
+
* @public
|
|
1268
|
+
*/
|
|
1269
|
+
export interface GetCampaignStateBatchResponse {
|
|
1270
|
+
/**
|
|
1271
|
+
* List of successful response of campaign state
|
|
1272
|
+
* @public
|
|
1273
|
+
*/
|
|
1274
|
+
successfulRequests?: SuccessfulCampaignStateResponse[] | undefined;
|
|
1275
|
+
/**
|
|
1276
|
+
* List of failed requests of campaign state
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
failedRequests?: FailedCampaignStateResponse[] | undefined;
|
|
1280
|
+
}
|
|
1281
|
+
/**
|
|
1282
|
+
* The request for GetConnectInstanceConfig API.
|
|
1283
|
+
* @public
|
|
1284
|
+
*/
|
|
1285
|
+
export interface GetConnectInstanceConfigRequest {
|
|
1286
|
+
/**
|
|
1287
|
+
* Amazon Connect Instance Id
|
|
1288
|
+
* @public
|
|
1289
|
+
*/
|
|
1290
|
+
connectInstanceId: string | undefined;
|
|
1291
|
+
}
|
|
1292
|
+
/**
|
|
1293
|
+
* @public
|
|
1294
|
+
* @enum
|
|
1295
|
+
*/
|
|
1296
|
+
export declare const EncryptionType: {
|
|
1297
|
+
readonly KMS: "KMS";
|
|
1298
|
+
};
|
|
1299
|
+
/**
|
|
1300
|
+
* @public
|
|
1301
|
+
*/
|
|
1302
|
+
export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
|
|
1303
|
+
/**
|
|
1304
|
+
* Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
|
|
1305
|
+
* If disabled, service will perform encryption with its own key.
|
|
1306
|
+
* If enabled, a KMS key id needs to be provided and KMS charges will apply.
|
|
1307
|
+
* KMS is only type supported
|
|
1308
|
+
* @public
|
|
1309
|
+
*/
|
|
1310
|
+
export interface EncryptionConfig {
|
|
1311
|
+
/**
|
|
1312
|
+
* Boolean to indicate if custom encryption has been enabled.
|
|
1313
|
+
* @public
|
|
1314
|
+
*/
|
|
1315
|
+
enabled: boolean | undefined;
|
|
1316
|
+
/**
|
|
1317
|
+
* Server-side encryption type.
|
|
1318
|
+
* @public
|
|
1319
|
+
*/
|
|
1320
|
+
encryptionType?: EncryptionType | undefined;
|
|
1321
|
+
/**
|
|
1322
|
+
* KMS key id/arn for encryption config.
|
|
1323
|
+
* @public
|
|
1324
|
+
*/
|
|
1325
|
+
keyArn?: string | undefined;
|
|
1326
|
+
}
|
|
1327
|
+
/**
|
|
1328
|
+
* Instance config object
|
|
1329
|
+
* @public
|
|
1330
|
+
*/
|
|
1331
|
+
export interface InstanceConfig {
|
|
1332
|
+
/**
|
|
1333
|
+
* Amazon Connect Instance Id
|
|
1334
|
+
* @public
|
|
1335
|
+
*/
|
|
1336
|
+
connectInstanceId: string | undefined;
|
|
1337
|
+
/**
|
|
1338
|
+
* Service linked role arn
|
|
1339
|
+
* @public
|
|
1340
|
+
*/
|
|
1341
|
+
serviceLinkedRoleArn: string | undefined;
|
|
1342
|
+
/**
|
|
1343
|
+
* Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
|
|
1344
|
+
* If disabled, service will perform encryption with its own key.
|
|
1345
|
+
* If enabled, a KMS key id needs to be provided and KMS charges will apply.
|
|
1346
|
+
* KMS is only type supported
|
|
1347
|
+
* @public
|
|
1348
|
+
*/
|
|
1349
|
+
encryptionConfig: EncryptionConfig | undefined;
|
|
1350
|
+
}
|
|
1351
|
+
/**
|
|
1352
|
+
* The response for GetConnectInstanceConfig API.
|
|
1353
|
+
* @public
|
|
1354
|
+
*/
|
|
1355
|
+
export interface GetConnectInstanceConfigResponse {
|
|
1356
|
+
/**
|
|
1357
|
+
* Instance config object
|
|
1358
|
+
* @public
|
|
1359
|
+
*/
|
|
1360
|
+
connectInstanceConfig?: InstanceConfig | undefined;
|
|
1361
|
+
}
|
|
1362
|
+
/**
|
|
1363
|
+
* The request for GetInstanceOnboardingJobStatus API.
|
|
1364
|
+
* @public
|
|
1365
|
+
*/
|
|
1366
|
+
export interface GetInstanceOnboardingJobStatusRequest {
|
|
1367
|
+
/**
|
|
1368
|
+
* Amazon Connect Instance Id
|
|
1369
|
+
* @public
|
|
1370
|
+
*/
|
|
1371
|
+
connectInstanceId: string | undefined;
|
|
1372
|
+
}
|
|
1373
|
+
/**
|
|
1374
|
+
* @public
|
|
1375
|
+
* @enum
|
|
1376
|
+
*/
|
|
1377
|
+
export declare const InstanceOnboardingJobFailureCode: {
|
|
1378
|
+
readonly EVENT_BRIDGE_ACCESS_DENIED: "EVENT_BRIDGE_ACCESS_DENIED";
|
|
1379
|
+
readonly EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED: "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED";
|
|
1380
|
+
readonly IAM_ACCESS_DENIED: "IAM_ACCESS_DENIED";
|
|
1381
|
+
readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
|
|
1382
|
+
readonly KMS_ACCESS_DENIED: "KMS_ACCESS_DENIED";
|
|
1383
|
+
readonly KMS_KEY_NOT_FOUND: "KMS_KEY_NOT_FOUND";
|
|
1384
|
+
};
|
|
1385
|
+
/**
|
|
1386
|
+
* @public
|
|
1387
|
+
*/
|
|
1388
|
+
export type InstanceOnboardingJobFailureCode = (typeof InstanceOnboardingJobFailureCode)[keyof typeof InstanceOnboardingJobFailureCode];
|
|
1389
|
+
/**
|
|
1390
|
+
* @public
|
|
1391
|
+
* @enum
|
|
1392
|
+
*/
|
|
1393
|
+
export declare const InstanceOnboardingJobStatusCode: {
|
|
1394
|
+
readonly FAILED: "FAILED";
|
|
1395
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1396
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
1397
|
+
};
|
|
1398
|
+
/**
|
|
1399
|
+
* @public
|
|
1400
|
+
*/
|
|
1401
|
+
export type InstanceOnboardingJobStatusCode = (typeof InstanceOnboardingJobStatusCode)[keyof typeof InstanceOnboardingJobStatusCode];
|
|
1402
|
+
/**
|
|
1403
|
+
* Instance onboarding job status object
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
export interface InstanceOnboardingJobStatus {
|
|
1407
|
+
/**
|
|
1408
|
+
* Amazon Connect Instance Id
|
|
1409
|
+
* @public
|
|
1410
|
+
*/
|
|
1411
|
+
connectInstanceId: string | undefined;
|
|
1412
|
+
/**
|
|
1413
|
+
* Enumeration of the possible states for instance onboarding job
|
|
1414
|
+
* @public
|
|
1415
|
+
*/
|
|
1416
|
+
status: InstanceOnboardingJobStatusCode | undefined;
|
|
1417
|
+
/**
|
|
1418
|
+
* Enumeration of the possible failure codes for instance onboarding job
|
|
1419
|
+
* @public
|
|
1420
|
+
*/
|
|
1421
|
+
failureCode?: InstanceOnboardingJobFailureCode | undefined;
|
|
1422
|
+
}
|
|
1423
|
+
/**
|
|
1424
|
+
* The response for GetInstanceOnboardingJobStatus API.
|
|
1425
|
+
* @public
|
|
1426
|
+
*/
|
|
1427
|
+
export interface GetInstanceOnboardingJobStatusResponse {
|
|
1428
|
+
/**
|
|
1429
|
+
* Instance onboarding job status object
|
|
1430
|
+
* @public
|
|
1431
|
+
*/
|
|
1432
|
+
connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus | undefined;
|
|
1433
|
+
}
|
|
1434
|
+
/**
|
|
1435
|
+
* @public
|
|
1436
|
+
* @enum
|
|
1437
|
+
*/
|
|
1438
|
+
export declare const InstanceIdFilterOperator: {
|
|
1439
|
+
/**
|
|
1440
|
+
* Equals operator
|
|
1441
|
+
*/
|
|
1442
|
+
readonly EQ: "Eq";
|
|
1443
|
+
};
|
|
1444
|
+
/**
|
|
1445
|
+
* @public
|
|
1446
|
+
*/
|
|
1447
|
+
export type InstanceIdFilterOperator = (typeof InstanceIdFilterOperator)[keyof typeof InstanceIdFilterOperator];
|
|
1448
|
+
/**
|
|
1449
|
+
* Connect instance identifier filter
|
|
1450
|
+
* @public
|
|
1451
|
+
*/
|
|
1452
|
+
export interface InstanceIdFilter {
|
|
1453
|
+
/**
|
|
1454
|
+
* Amazon Connect Instance Id
|
|
1455
|
+
* @public
|
|
1456
|
+
*/
|
|
1457
|
+
value: string | undefined;
|
|
1458
|
+
/**
|
|
1459
|
+
* Operators for Connect instance identifier filter
|
|
1460
|
+
* @public
|
|
1461
|
+
*/
|
|
1462
|
+
operator: InstanceIdFilterOperator | undefined;
|
|
1463
|
+
}
|
|
1464
|
+
/**
|
|
1465
|
+
* Filter model by type
|
|
1466
|
+
* @public
|
|
1467
|
+
*/
|
|
1468
|
+
export interface CampaignFilters {
|
|
1469
|
+
/**
|
|
1470
|
+
* Connect instance identifier filter
|
|
1471
|
+
* @public
|
|
1472
|
+
*/
|
|
1473
|
+
instanceIdFilter?: InstanceIdFilter | undefined;
|
|
1474
|
+
}
|
|
1475
|
+
/**
|
|
1476
|
+
* The request for ListCampaigns API.
|
|
1477
|
+
* @public
|
|
1478
|
+
*/
|
|
1479
|
+
export interface ListCampaignsRequest {
|
|
1480
|
+
/**
|
|
1481
|
+
* The maximum number of results to return per page.
|
|
1482
|
+
* @public
|
|
1483
|
+
*/
|
|
1484
|
+
maxResults?: number | undefined;
|
|
1485
|
+
/**
|
|
1486
|
+
* The token for the next set of results.
|
|
1487
|
+
* @public
|
|
1488
|
+
*/
|
|
1489
|
+
nextToken?: string | undefined;
|
|
1490
|
+
/**
|
|
1491
|
+
* Filter model by type
|
|
1492
|
+
* @public
|
|
1493
|
+
*/
|
|
1494
|
+
filters?: CampaignFilters | undefined;
|
|
1495
|
+
}
|
|
1496
|
+
/**
|
|
1497
|
+
* An Amazon Connect campaign summary.
|
|
1498
|
+
* @public
|
|
1499
|
+
*/
|
|
1500
|
+
export interface CampaignSummary {
|
|
1501
|
+
/**
|
|
1502
|
+
* Identifier representing a Campaign
|
|
1503
|
+
* @public
|
|
1504
|
+
*/
|
|
1505
|
+
id: string | undefined;
|
|
1506
|
+
/**
|
|
1507
|
+
* The resource name of an Amazon Connect campaign.
|
|
1508
|
+
* @public
|
|
1509
|
+
*/
|
|
1510
|
+
arn: string | undefined;
|
|
1511
|
+
/**
|
|
1512
|
+
* The name of an Amazon Connect Campaign name.
|
|
1513
|
+
* @public
|
|
1514
|
+
*/
|
|
1515
|
+
name: string | undefined;
|
|
1516
|
+
/**
|
|
1517
|
+
* Amazon Connect Instance Id
|
|
1518
|
+
* @public
|
|
1519
|
+
*/
|
|
1520
|
+
connectInstanceId: string | undefined;
|
|
1521
|
+
/**
|
|
1522
|
+
* Channel subtype list
|
|
1523
|
+
* @public
|
|
1524
|
+
*/
|
|
1525
|
+
channelSubtypes: ChannelSubtype[] | undefined;
|
|
1526
|
+
/**
|
|
1527
|
+
* Campaign schedule
|
|
1528
|
+
* @public
|
|
1529
|
+
*/
|
|
1530
|
+
schedule?: Schedule | undefined;
|
|
1531
|
+
/**
|
|
1532
|
+
* Amazon Resource Names(ARN)
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
connectCampaignFlowArn?: string | undefined;
|
|
1536
|
+
}
|
|
1537
|
+
/**
|
|
1538
|
+
* The response for ListCampaigns API.
|
|
1539
|
+
* @public
|
|
1540
|
+
*/
|
|
1541
|
+
export interface ListCampaignsResponse {
|
|
1542
|
+
/**
|
|
1543
|
+
* The token for the next set of results.
|
|
1544
|
+
* @public
|
|
1545
|
+
*/
|
|
1546
|
+
nextToken?: string | undefined;
|
|
1547
|
+
/**
|
|
1548
|
+
* A list of Amazon Connect campaigns.
|
|
1549
|
+
* @public
|
|
1550
|
+
*/
|
|
1551
|
+
campaignSummaryList?: CampaignSummary[] | undefined;
|
|
1552
|
+
}
|
|
1553
|
+
/**
|
|
1554
|
+
* The request for ListConnectInstanceIntegrations API.
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
export interface ListConnectInstanceIntegrationsRequest {
|
|
1558
|
+
/**
|
|
1559
|
+
* Amazon Connect Instance Id
|
|
1560
|
+
* @public
|
|
1561
|
+
*/
|
|
1562
|
+
connectInstanceId: string | undefined;
|
|
1563
|
+
/**
|
|
1564
|
+
* The maximum number of results to return per page.
|
|
1565
|
+
* @public
|
|
1566
|
+
*/
|
|
1567
|
+
maxResults?: number | undefined;
|
|
1568
|
+
/**
|
|
1569
|
+
* The token for the next set of results.
|
|
1570
|
+
* @public
|
|
1571
|
+
*/
|
|
1572
|
+
nextToken?: string | undefined;
|
|
1573
|
+
}
|
|
1574
|
+
/**
|
|
1575
|
+
* @public
|
|
1576
|
+
* @enum
|
|
1577
|
+
*/
|
|
1578
|
+
export declare const EventType: {
|
|
1579
|
+
readonly CAMPAIGN_EMAIL: "Campaign-Email";
|
|
1580
|
+
readonly CAMPAIGN_ORCHESTRATION: "Campaign-Orchestration";
|
|
1581
|
+
readonly CAMPAIGN_SMS: "Campaign-SMS";
|
|
1582
|
+
readonly CAMPAIGN_TELEPHONY: "Campaign-Telephony";
|
|
1583
|
+
};
|
|
1584
|
+
/**
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1587
|
+
export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
1588
|
+
/**
|
|
1589
|
+
* Customer Profiles integration summary
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
export interface CustomerProfilesIntegrationSummary {
|
|
1593
|
+
/**
|
|
1594
|
+
* Amazon Resource Names(ARN)
|
|
1595
|
+
* @public
|
|
1596
|
+
*/
|
|
1597
|
+
domainArn: string | undefined;
|
|
1598
|
+
/**
|
|
1599
|
+
* Object type names map.
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
objectTypeNames: Partial<Record<EventType, string>> | undefined;
|
|
1603
|
+
}
|
|
1604
|
+
/**
|
|
1605
|
+
* Q Connect integration summary
|
|
1606
|
+
* @public
|
|
1607
|
+
*/
|
|
1608
|
+
export interface QConnectIntegrationSummary {
|
|
1609
|
+
/**
|
|
1610
|
+
* Amazon Resource Names(ARN)
|
|
1611
|
+
* @public
|
|
1612
|
+
*/
|
|
1613
|
+
knowledgeBaseArn: string | undefined;
|
|
1614
|
+
}
|
|
1615
|
+
/**
|
|
1616
|
+
* Integration summary for Connect instance.
|
|
1617
|
+
* @public
|
|
1618
|
+
*/
|
|
1619
|
+
export type IntegrationSummary = IntegrationSummary.CustomerProfilesMember | IntegrationSummary.QConnectMember | IntegrationSummary.$UnknownMember;
|
|
1620
|
+
/**
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
export declare namespace IntegrationSummary {
|
|
1624
|
+
/**
|
|
1625
|
+
* Customer Profiles integration summary
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
interface CustomerProfilesMember {
|
|
1629
|
+
customerProfiles: CustomerProfilesIntegrationSummary;
|
|
1630
|
+
qConnect?: never;
|
|
1631
|
+
$unknown?: never;
|
|
1632
|
+
}
|
|
1633
|
+
/**
|
|
1634
|
+
* Q Connect integration summary
|
|
1635
|
+
* @public
|
|
1636
|
+
*/
|
|
1637
|
+
interface QConnectMember {
|
|
1638
|
+
customerProfiles?: never;
|
|
1639
|
+
qConnect: QConnectIntegrationSummary;
|
|
1640
|
+
$unknown?: never;
|
|
1641
|
+
}
|
|
1642
|
+
/**
|
|
1643
|
+
* @public
|
|
1644
|
+
*/
|
|
1645
|
+
interface $UnknownMember {
|
|
1646
|
+
customerProfiles?: never;
|
|
1647
|
+
qConnect?: never;
|
|
1648
|
+
$unknown: [string, any];
|
|
1649
|
+
}
|
|
1650
|
+
interface Visitor<T> {
|
|
1651
|
+
customerProfiles: (value: CustomerProfilesIntegrationSummary) => T;
|
|
1652
|
+
qConnect: (value: QConnectIntegrationSummary) => T;
|
|
1653
|
+
_: (name: string, value: any) => T;
|
|
1654
|
+
}
|
|
1655
|
+
const visit: <T>(value: IntegrationSummary, visitor: Visitor<T>) => T;
|
|
1656
|
+
}
|
|
1657
|
+
/**
|
|
1658
|
+
* The response for ListConnectInstanceIntegrations API.
|
|
1659
|
+
* @public
|
|
1660
|
+
*/
|
|
1661
|
+
export interface ListConnectInstanceIntegrationsResponse {
|
|
1662
|
+
/**
|
|
1663
|
+
* The token for the next set of results.
|
|
1664
|
+
* @public
|
|
1665
|
+
*/
|
|
1666
|
+
nextToken?: string | undefined;
|
|
1667
|
+
/**
|
|
1668
|
+
* A list of Amazon Connect Instance Integrations.
|
|
1669
|
+
* @public
|
|
1670
|
+
*/
|
|
1671
|
+
integrationSummaryList?: IntegrationSummary[] | undefined;
|
|
1672
|
+
}
|
|
1673
|
+
/**
|
|
1674
|
+
* The request for ListTagsForResource API.
|
|
1675
|
+
* @public
|
|
1676
|
+
*/
|
|
1677
|
+
export interface ListTagsForResourceRequest {
|
|
1678
|
+
/**
|
|
1679
|
+
* Amazon Resource Names(ARN)
|
|
1680
|
+
* @public
|
|
1681
|
+
*/
|
|
1682
|
+
arn: string | undefined;
|
|
1683
|
+
}
|
|
1684
|
+
/**
|
|
1685
|
+
* The request for ListTagsForResource API.
|
|
1686
|
+
* @public
|
|
1687
|
+
*/
|
|
1688
|
+
export interface ListTagsForResourceResponse {
|
|
1689
|
+
/**
|
|
1690
|
+
* Tag map with key and value.
|
|
1691
|
+
* @public
|
|
1692
|
+
*/
|
|
1693
|
+
tags?: Record<string, string> | undefined;
|
|
1694
|
+
}
|
|
1695
|
+
/**
|
|
1696
|
+
* The request for PauseCampaign API.
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1699
|
+
export interface PauseCampaignRequest {
|
|
1700
|
+
/**
|
|
1701
|
+
* Identifier representing a Campaign
|
|
1702
|
+
* @public
|
|
1703
|
+
*/
|
|
1704
|
+
id: string | undefined;
|
|
1705
|
+
}
|
|
1706
|
+
/**
|
|
1707
|
+
* Customer Profiles integration config
|
|
1708
|
+
* @public
|
|
1709
|
+
*/
|
|
1710
|
+
export interface CustomerProfilesIntegrationConfig {
|
|
1711
|
+
/**
|
|
1712
|
+
* Amazon Resource Names(ARN)
|
|
1713
|
+
* @public
|
|
1714
|
+
*/
|
|
1715
|
+
domainArn: string | undefined;
|
|
1716
|
+
/**
|
|
1717
|
+
* Object type names map.
|
|
1718
|
+
* @public
|
|
1719
|
+
*/
|
|
1720
|
+
objectTypeNames: Partial<Record<EventType, string>> | undefined;
|
|
1721
|
+
}
|
|
1722
|
+
/**
|
|
1723
|
+
* Q Connect integration config
|
|
1724
|
+
* @public
|
|
1725
|
+
*/
|
|
1726
|
+
export interface QConnectIntegrationConfig {
|
|
1727
|
+
/**
|
|
1728
|
+
* Amazon Resource Names(ARN)
|
|
1729
|
+
* @public
|
|
1730
|
+
*/
|
|
1731
|
+
knowledgeBaseArn: string | undefined;
|
|
1732
|
+
}
|
|
1733
|
+
/**
|
|
1734
|
+
* Integration config for Connect Instance
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
export type IntegrationConfig = IntegrationConfig.CustomerProfilesMember | IntegrationConfig.QConnectMember | IntegrationConfig.$UnknownMember;
|
|
1738
|
+
/**
|
|
1739
|
+
* @public
|
|
1740
|
+
*/
|
|
1741
|
+
export declare namespace IntegrationConfig {
|
|
1742
|
+
/**
|
|
1743
|
+
* Customer Profiles integration config
|
|
1744
|
+
* @public
|
|
1745
|
+
*/
|
|
1746
|
+
interface CustomerProfilesMember {
|
|
1747
|
+
customerProfiles: CustomerProfilesIntegrationConfig;
|
|
1748
|
+
qConnect?: never;
|
|
1749
|
+
$unknown?: never;
|
|
1750
|
+
}
|
|
1751
|
+
/**
|
|
1752
|
+
* Q Connect integration config
|
|
1753
|
+
* @public
|
|
1754
|
+
*/
|
|
1755
|
+
interface QConnectMember {
|
|
1756
|
+
customerProfiles?: never;
|
|
1757
|
+
qConnect: QConnectIntegrationConfig;
|
|
1758
|
+
$unknown?: never;
|
|
1759
|
+
}
|
|
1760
|
+
/**
|
|
1761
|
+
* @public
|
|
1762
|
+
*/
|
|
1763
|
+
interface $UnknownMember {
|
|
1764
|
+
customerProfiles?: never;
|
|
1765
|
+
qConnect?: never;
|
|
1766
|
+
$unknown: [string, any];
|
|
1767
|
+
}
|
|
1768
|
+
interface Visitor<T> {
|
|
1769
|
+
customerProfiles: (value: CustomerProfilesIntegrationConfig) => T;
|
|
1770
|
+
qConnect: (value: QConnectIntegrationConfig) => T;
|
|
1771
|
+
_: (name: string, value: any) => T;
|
|
1772
|
+
}
|
|
1773
|
+
const visit: <T>(value: IntegrationConfig, visitor: Visitor<T>) => T;
|
|
1774
|
+
}
|
|
1775
|
+
/**
|
|
1776
|
+
* The request for PutConnectInstanceIntegration API.
|
|
1777
|
+
* @public
|
|
1778
|
+
*/
|
|
1779
|
+
export interface PutConnectInstanceIntegrationRequest {
|
|
1780
|
+
/**
|
|
1781
|
+
* Amazon Connect Instance Id
|
|
1782
|
+
* @public
|
|
1783
|
+
*/
|
|
1784
|
+
connectInstanceId: string | undefined;
|
|
1785
|
+
/**
|
|
1786
|
+
* Integration config for Connect Instance
|
|
1787
|
+
* @public
|
|
1788
|
+
*/
|
|
1789
|
+
integrationConfig: IntegrationConfig | undefined;
|
|
1790
|
+
}
|
|
1791
|
+
/**
|
|
1792
|
+
* Parameters for the Email Channel Subtype
|
|
1793
|
+
* @public
|
|
1794
|
+
*/
|
|
1795
|
+
export interface EmailChannelSubtypeParameters {
|
|
1796
|
+
/**
|
|
1797
|
+
* Source/Destination Email address used for Email messages
|
|
1798
|
+
* @public
|
|
1799
|
+
*/
|
|
1800
|
+
destinationEmailAddress: string | undefined;
|
|
1801
|
+
/**
|
|
1802
|
+
* Source/Destination Email address used for Email messages
|
|
1803
|
+
* @public
|
|
1804
|
+
*/
|
|
1805
|
+
connectSourceEmailAddress?: string | undefined;
|
|
1806
|
+
/**
|
|
1807
|
+
* Amazon Resource Names(ARN)
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1810
|
+
templateArn?: string | undefined;
|
|
1811
|
+
/**
|
|
1812
|
+
* A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1815
|
+
templateParameters: Record<string, string> | undefined;
|
|
1816
|
+
}
|
|
1817
|
+
/**
|
|
1818
|
+
* Parameters for the SMS Channel Subtype
|
|
1819
|
+
* @public
|
|
1820
|
+
*/
|
|
1821
|
+
export interface SmsChannelSubtypeParameters {
|
|
1822
|
+
/**
|
|
1823
|
+
* The phone number of the customer, in E.164 format.
|
|
1824
|
+
* @public
|
|
1825
|
+
*/
|
|
1826
|
+
destinationPhoneNumber: string | undefined;
|
|
1827
|
+
/**
|
|
1828
|
+
* Amazon Resource Names(ARN)
|
|
1829
|
+
* @public
|
|
1830
|
+
*/
|
|
1831
|
+
connectSourcePhoneNumberArn?: string | undefined;
|
|
1832
|
+
/**
|
|
1833
|
+
* Amazon Resource Names(ARN)
|
|
1834
|
+
* @public
|
|
1835
|
+
*/
|
|
1836
|
+
templateArn?: string | undefined;
|
|
1837
|
+
/**
|
|
1838
|
+
* A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
|
|
1839
|
+
* @public
|
|
1840
|
+
*/
|
|
1841
|
+
templateParameters: Record<string, string> | undefined;
|
|
1842
|
+
}
|
|
1843
|
+
/**
|
|
1844
|
+
* Parameters for the Telephony Channel Subtype
|
|
1845
|
+
* @public
|
|
1846
|
+
*/
|
|
1847
|
+
export interface TelephonyChannelSubtypeParameters {
|
|
1848
|
+
/**
|
|
1849
|
+
* The phone number of the customer, in E.164 format.
|
|
1850
|
+
* @public
|
|
1851
|
+
*/
|
|
1852
|
+
destinationPhoneNumber: string | undefined;
|
|
1853
|
+
/**
|
|
1854
|
+
* A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
|
|
1855
|
+
* @public
|
|
1856
|
+
*/
|
|
1857
|
+
attributes: Record<string, string> | undefined;
|
|
1858
|
+
/**
|
|
1859
|
+
* The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
|
|
1860
|
+
* @public
|
|
1861
|
+
*/
|
|
1862
|
+
connectSourcePhoneNumber?: string | undefined;
|
|
1863
|
+
/**
|
|
1864
|
+
* Answering Machine Detection config
|
|
1865
|
+
* @public
|
|
1866
|
+
*/
|
|
1867
|
+
answerMachineDetectionConfig?: AnswerMachineDetectionConfig | undefined;
|
|
1868
|
+
}
|
|
1869
|
+
/**
|
|
1870
|
+
* ChannelSubtypeParameters for an outbound request
|
|
1871
|
+
* @public
|
|
1872
|
+
*/
|
|
1873
|
+
export type ChannelSubtypeParameters = ChannelSubtypeParameters.EmailMember | ChannelSubtypeParameters.SmsMember | ChannelSubtypeParameters.TelephonyMember | ChannelSubtypeParameters.$UnknownMember;
|
|
1874
|
+
/**
|
|
1875
|
+
* @public
|
|
1876
|
+
*/
|
|
1877
|
+
export declare namespace ChannelSubtypeParameters {
|
|
1878
|
+
/**
|
|
1879
|
+
* Parameters for the Telephony Channel Subtype
|
|
1880
|
+
* @public
|
|
1881
|
+
*/
|
|
1882
|
+
interface TelephonyMember {
|
|
1883
|
+
telephony: TelephonyChannelSubtypeParameters;
|
|
1884
|
+
sms?: never;
|
|
1885
|
+
email?: never;
|
|
1886
|
+
$unknown?: never;
|
|
1887
|
+
}
|
|
1888
|
+
/**
|
|
1889
|
+
* Parameters for the SMS Channel Subtype
|
|
1890
|
+
* @public
|
|
1891
|
+
*/
|
|
1892
|
+
interface SmsMember {
|
|
1893
|
+
telephony?: never;
|
|
1894
|
+
sms: SmsChannelSubtypeParameters;
|
|
1895
|
+
email?: never;
|
|
1896
|
+
$unknown?: never;
|
|
1897
|
+
}
|
|
1898
|
+
/**
|
|
1899
|
+
* Parameters for the Email Channel Subtype
|
|
1900
|
+
* @public
|
|
1901
|
+
*/
|
|
1902
|
+
interface EmailMember {
|
|
1903
|
+
telephony?: never;
|
|
1904
|
+
sms?: never;
|
|
1905
|
+
email: EmailChannelSubtypeParameters;
|
|
1906
|
+
$unknown?: never;
|
|
1907
|
+
}
|
|
1908
|
+
/**
|
|
1909
|
+
* @public
|
|
1910
|
+
*/
|
|
1911
|
+
interface $UnknownMember {
|
|
1912
|
+
telephony?: never;
|
|
1913
|
+
sms?: never;
|
|
1914
|
+
email?: never;
|
|
1915
|
+
$unknown: [string, any];
|
|
1916
|
+
}
|
|
1917
|
+
interface Visitor<T> {
|
|
1918
|
+
telephony: (value: TelephonyChannelSubtypeParameters) => T;
|
|
1919
|
+
sms: (value: SmsChannelSubtypeParameters) => T;
|
|
1920
|
+
email: (value: EmailChannelSubtypeParameters) => T;
|
|
1921
|
+
_: (name: string, value: any) => T;
|
|
1922
|
+
}
|
|
1923
|
+
const visit: <T>(value: ChannelSubtypeParameters, visitor: Visitor<T>) => T;
|
|
1924
|
+
}
|
|
1925
|
+
/**
|
|
1926
|
+
* An outbound request for a campaign.
|
|
1927
|
+
* @public
|
|
1928
|
+
*/
|
|
1929
|
+
export interface OutboundRequest {
|
|
1930
|
+
/**
|
|
1931
|
+
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
1932
|
+
* @public
|
|
1933
|
+
*/
|
|
1934
|
+
clientToken: string | undefined;
|
|
1935
|
+
/**
|
|
1936
|
+
* Timestamp with no UTC offset or timezone
|
|
1937
|
+
* @public
|
|
1938
|
+
*/
|
|
1939
|
+
expirationTime: Date | undefined;
|
|
1940
|
+
/**
|
|
1941
|
+
* ChannelSubtypeParameters for an outbound request
|
|
1942
|
+
* @public
|
|
1943
|
+
*/
|
|
1944
|
+
channelSubtypeParameters: ChannelSubtypeParameters | undefined;
|
|
1945
|
+
}
|
|
1946
|
+
/**
|
|
1947
|
+
* The request for PutOutboundRequestBatch API.
|
|
1948
|
+
* @public
|
|
1949
|
+
*/
|
|
1950
|
+
export interface PutOutboundRequestBatchRequest {
|
|
1951
|
+
/**
|
|
1952
|
+
* Identifier representing a Campaign
|
|
1953
|
+
* @public
|
|
1954
|
+
*/
|
|
1955
|
+
id: string | undefined;
|
|
1956
|
+
/**
|
|
1957
|
+
* A list of outbound requests.
|
|
1958
|
+
* @public
|
|
1959
|
+
*/
|
|
1960
|
+
outboundRequests: OutboundRequest[] | undefined;
|
|
1961
|
+
}
|
|
1962
|
+
/**
|
|
1963
|
+
* @public
|
|
1964
|
+
* @enum
|
|
1965
|
+
*/
|
|
1966
|
+
export declare const FailureCode: {
|
|
1967
|
+
/**
|
|
1968
|
+
* Request throttled due to large number of pending dial requests
|
|
1969
|
+
*/
|
|
1970
|
+
readonly BUFFER_LIMIT_EXCEEDED: "BufferLimitExceeded";
|
|
1971
|
+
/**
|
|
1972
|
+
* The request failed to satisfy the constraints specified by the service
|
|
1973
|
+
*/
|
|
1974
|
+
readonly INVALID_INPUT: "InvalidInput";
|
|
1975
|
+
/**
|
|
1976
|
+
* The request was throttled due to excessive usage
|
|
1977
|
+
*/
|
|
1978
|
+
readonly REQUEST_THROTTLED: "RequestThrottled";
|
|
1979
|
+
/**
|
|
1980
|
+
* Unexpected error during processing of request
|
|
1981
|
+
*/
|
|
1982
|
+
readonly UNKNOWN_ERROR: "UnknownError";
|
|
1983
|
+
};
|
|
1984
|
+
/**
|
|
1985
|
+
* @public
|
|
1986
|
+
*/
|
|
1987
|
+
export type FailureCode = (typeof FailureCode)[keyof typeof FailureCode];
|
|
1988
|
+
/**
|
|
1989
|
+
* A failed request identified by the unique client token.
|
|
1990
|
+
* @public
|
|
1991
|
+
*/
|
|
1992
|
+
export interface FailedRequest {
|
|
1993
|
+
/**
|
|
1994
|
+
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
1995
|
+
* @public
|
|
1996
|
+
*/
|
|
1997
|
+
clientToken?: string | undefined;
|
|
1998
|
+
/**
|
|
1999
|
+
* Identifier representing a Dial request
|
|
2000
|
+
* @public
|
|
2001
|
+
*/
|
|
2002
|
+
id?: string | undefined;
|
|
2003
|
+
/**
|
|
2004
|
+
* A predefined code indicating the error that caused the failure.
|
|
2005
|
+
* @public
|
|
2006
|
+
*/
|
|
2007
|
+
failureCode?: FailureCode | undefined;
|
|
2008
|
+
}
|
|
2009
|
+
/**
|
|
2010
|
+
* A successful request identified by the unique client token.
|
|
2011
|
+
* @public
|
|
2012
|
+
*/
|
|
2013
|
+
export interface SuccessfulRequest {
|
|
2014
|
+
/**
|
|
2015
|
+
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
2016
|
+
* @public
|
|
2017
|
+
*/
|
|
2018
|
+
clientToken?: string | undefined;
|
|
2019
|
+
/**
|
|
2020
|
+
* Identifier representing a Dial request
|
|
2021
|
+
* @public
|
|
2022
|
+
*/
|
|
2023
|
+
id?: string | undefined;
|
|
2024
|
+
}
|
|
2025
|
+
/**
|
|
2026
|
+
* The response for PutOutboundRequestBatch API.
|
|
2027
|
+
* @public
|
|
2028
|
+
*/
|
|
2029
|
+
export interface PutOutboundRequestBatchResponse {
|
|
2030
|
+
/**
|
|
2031
|
+
* A list of successful requests identified by the unique client token.
|
|
2032
|
+
* @public
|
|
2033
|
+
*/
|
|
2034
|
+
successfulRequests?: SuccessfulRequest[] | undefined;
|
|
2035
|
+
/**
|
|
2036
|
+
* A list of failed requests.
|
|
2037
|
+
* @public
|
|
2038
|
+
*/
|
|
2039
|
+
failedRequests?: FailedRequest[] | undefined;
|
|
2040
|
+
}
|
|
2041
|
+
/**
|
|
2042
|
+
* The request for ResumeCampaign API.
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
export interface ResumeCampaignRequest {
|
|
2046
|
+
/**
|
|
2047
|
+
* Identifier representing a Campaign
|
|
2048
|
+
* @public
|
|
2049
|
+
*/
|
|
2050
|
+
id: string | undefined;
|
|
2051
|
+
}
|
|
2052
|
+
/**
|
|
2053
|
+
* The request for StartCampaign API.
|
|
2054
|
+
* @public
|
|
2055
|
+
*/
|
|
2056
|
+
export interface StartCampaignRequest {
|
|
2057
|
+
/**
|
|
2058
|
+
* Identifier representing a Campaign
|
|
2059
|
+
* @public
|
|
2060
|
+
*/
|
|
2061
|
+
id: string | undefined;
|
|
2062
|
+
}
|
|
2063
|
+
/**
|
|
2064
|
+
* The request for StartInstanceOnboardingJob API.
|
|
2065
|
+
* @public
|
|
2066
|
+
*/
|
|
2067
|
+
export interface StartInstanceOnboardingJobRequest {
|
|
2068
|
+
/**
|
|
2069
|
+
* Amazon Connect Instance Id
|
|
2070
|
+
* @public
|
|
2071
|
+
*/
|
|
2072
|
+
connectInstanceId: string | undefined;
|
|
2073
|
+
/**
|
|
2074
|
+
* Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
|
|
2075
|
+
* If disabled, service will perform encryption with its own key.
|
|
2076
|
+
* If enabled, a KMS key id needs to be provided and KMS charges will apply.
|
|
2077
|
+
* KMS is only type supported
|
|
2078
|
+
* @public
|
|
2079
|
+
*/
|
|
2080
|
+
encryptionConfig: EncryptionConfig | undefined;
|
|
2081
|
+
}
|
|
2082
|
+
/**
|
|
2083
|
+
* The response for StartInstanceOnboardingJob API.
|
|
2084
|
+
* @public
|
|
2085
|
+
*/
|
|
2086
|
+
export interface StartInstanceOnboardingJobResponse {
|
|
2087
|
+
/**
|
|
2088
|
+
* Instance onboarding job status object
|
|
2089
|
+
* @public
|
|
2090
|
+
*/
|
|
2091
|
+
connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus | undefined;
|
|
2092
|
+
}
|
|
2093
|
+
/**
|
|
2094
|
+
* The request for StopCampaign API.
|
|
2095
|
+
* @public
|
|
2096
|
+
*/
|
|
2097
|
+
export interface StopCampaignRequest {
|
|
2098
|
+
/**
|
|
2099
|
+
* Identifier representing a Campaign
|
|
2100
|
+
* @public
|
|
2101
|
+
*/
|
|
2102
|
+
id: string | undefined;
|
|
2103
|
+
}
|
|
2104
|
+
/**
|
|
2105
|
+
* The request for TagResource API.
|
|
2106
|
+
* @public
|
|
2107
|
+
*/
|
|
2108
|
+
export interface TagResourceRequest {
|
|
2109
|
+
/**
|
|
2110
|
+
* Amazon Resource Names(ARN)
|
|
2111
|
+
* @public
|
|
2112
|
+
*/
|
|
2113
|
+
arn: string | undefined;
|
|
2114
|
+
/**
|
|
2115
|
+
* Tag map with key and value.
|
|
2116
|
+
* @public
|
|
2117
|
+
*/
|
|
2118
|
+
tags: Record<string, string> | undefined;
|
|
2119
|
+
}
|
|
2120
|
+
/**
|
|
2121
|
+
* The request for UntagResource API.
|
|
2122
|
+
* @public
|
|
2123
|
+
*/
|
|
2124
|
+
export interface UntagResourceRequest {
|
|
2125
|
+
/**
|
|
2126
|
+
* Amazon Resource Names(ARN)
|
|
2127
|
+
* @public
|
|
2128
|
+
*/
|
|
2129
|
+
arn: string | undefined;
|
|
2130
|
+
/**
|
|
2131
|
+
* List of tag keys.
|
|
2132
|
+
* @public
|
|
2133
|
+
*/
|
|
2134
|
+
tagKeys: string[] | undefined;
|
|
2135
|
+
}
|
|
2136
|
+
/**
|
|
2137
|
+
* The request for UpdateCampaignChannelSubtypeConfig API.
|
|
2138
|
+
* @public
|
|
2139
|
+
*/
|
|
2140
|
+
export interface UpdateCampaignChannelSubtypeConfigRequest {
|
|
2141
|
+
/**
|
|
2142
|
+
* Identifier representing a Campaign
|
|
2143
|
+
* @public
|
|
2144
|
+
*/
|
|
2145
|
+
id: string | undefined;
|
|
2146
|
+
/**
|
|
2147
|
+
* Campaign Channel Subtype config
|
|
2148
|
+
* @public
|
|
2149
|
+
*/
|
|
2150
|
+
channelSubtypeConfig: ChannelSubtypeConfig | undefined;
|
|
2151
|
+
}
|
|
2152
|
+
/**
|
|
2153
|
+
* The request for UpdateCampaignCommunicationLimits API.
|
|
2154
|
+
* @public
|
|
2155
|
+
*/
|
|
2156
|
+
export interface UpdateCampaignCommunicationLimitsRequest {
|
|
2157
|
+
/**
|
|
2158
|
+
* Identifier representing a Campaign
|
|
2159
|
+
* @public
|
|
2160
|
+
*/
|
|
2161
|
+
id: string | undefined;
|
|
2162
|
+
/**
|
|
2163
|
+
* Communication limits config
|
|
2164
|
+
* @public
|
|
2165
|
+
*/
|
|
2166
|
+
communicationLimitsOverride: CommunicationLimitsConfig | undefined;
|
|
2167
|
+
}
|
|
2168
|
+
/**
|
|
2169
|
+
* The request for UpdateCampaignCommunicationTime API.
|
|
2170
|
+
* @public
|
|
2171
|
+
*/
|
|
2172
|
+
export interface UpdateCampaignCommunicationTimeRequest {
|
|
2173
|
+
/**
|
|
2174
|
+
* Identifier representing a Campaign
|
|
2175
|
+
* @public
|
|
2176
|
+
*/
|
|
2177
|
+
id: string | undefined;
|
|
2178
|
+
/**
|
|
2179
|
+
* Campaign communication time config
|
|
2180
|
+
* @public
|
|
2181
|
+
*/
|
|
2182
|
+
communicationTimeConfig: CommunicationTimeConfig | undefined;
|
|
2183
|
+
}
|
|
2184
|
+
/**
|
|
2185
|
+
* The request for UpdateCampaignFlowAssociation API.
|
|
2186
|
+
* @public
|
|
2187
|
+
*/
|
|
2188
|
+
export interface UpdateCampaignFlowAssociationRequest {
|
|
2189
|
+
/**
|
|
2190
|
+
* Identifier representing a Campaign
|
|
2191
|
+
* @public
|
|
2192
|
+
*/
|
|
2193
|
+
id: string | undefined;
|
|
2194
|
+
/**
|
|
2195
|
+
* Amazon Resource Names(ARN)
|
|
2196
|
+
* @public
|
|
2197
|
+
*/
|
|
2198
|
+
connectCampaignFlowArn: string | undefined;
|
|
2199
|
+
}
|
|
2200
|
+
/**
|
|
2201
|
+
* The request for UpdateCampaignName API.
|
|
2202
|
+
* @public
|
|
2203
|
+
*/
|
|
2204
|
+
export interface UpdateCampaignNameRequest {
|
|
2205
|
+
/**
|
|
2206
|
+
* Identifier representing a Campaign
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
id: string | undefined;
|
|
2210
|
+
/**
|
|
2211
|
+
* The name of an Amazon Connect Campaign name.
|
|
2212
|
+
* @public
|
|
2213
|
+
*/
|
|
2214
|
+
name: string | undefined;
|
|
2215
|
+
}
|
|
2216
|
+
/**
|
|
2217
|
+
* The request for UpdateCampaignSchedule API.
|
|
2218
|
+
* @public
|
|
2219
|
+
*/
|
|
2220
|
+
export interface UpdateCampaignScheduleRequest {
|
|
2221
|
+
/**
|
|
2222
|
+
* Identifier representing a Campaign
|
|
2223
|
+
* @public
|
|
2224
|
+
*/
|
|
2225
|
+
id: string | undefined;
|
|
2226
|
+
/**
|
|
2227
|
+
* Campaign schedule
|
|
2228
|
+
* @public
|
|
2229
|
+
*/
|
|
2230
|
+
schedule: Schedule | undefined;
|
|
2231
|
+
}
|
|
2232
|
+
/**
|
|
2233
|
+
* The request for UpdateCampaignSource API.
|
|
2234
|
+
* @public
|
|
2235
|
+
*/
|
|
2236
|
+
export interface UpdateCampaignSourceRequest {
|
|
2237
|
+
/**
|
|
2238
|
+
* Identifier representing a Campaign
|
|
2239
|
+
* @public
|
|
2240
|
+
*/
|
|
2241
|
+
id: string | undefined;
|
|
2242
|
+
/**
|
|
2243
|
+
* Source of the campaign
|
|
2244
|
+
* @public
|
|
2245
|
+
*/
|
|
2246
|
+
source: Source | undefined;
|
|
2247
|
+
}
|
|
2248
|
+
/**
|
|
2249
|
+
* @internal
|
|
2250
|
+
*/
|
|
2251
|
+
export declare const EmailOutboundConfigFilterSensitiveLog: (obj: EmailOutboundConfig) => any;
|
|
2252
|
+
/**
|
|
2253
|
+
* @internal
|
|
2254
|
+
*/
|
|
2255
|
+
export declare const EmailChannelSubtypeConfigFilterSensitiveLog: (obj: EmailChannelSubtypeConfig) => any;
|
|
2256
|
+
/**
|
|
2257
|
+
* @internal
|
|
2258
|
+
*/
|
|
2259
|
+
export declare const ChannelSubtypeConfigFilterSensitiveLog: (obj: ChannelSubtypeConfig) => any;
|
|
2260
|
+
/**
|
|
2261
|
+
* @internal
|
|
2262
|
+
*/
|
|
2263
|
+
export declare const CreateCampaignRequestFilterSensitiveLog: (obj: CreateCampaignRequest) => any;
|
|
2264
|
+
/**
|
|
2265
|
+
* @internal
|
|
2266
|
+
*/
|
|
2267
|
+
export declare const CampaignFilterSensitiveLog: (obj: Campaign) => any;
|
|
2268
|
+
/**
|
|
2269
|
+
* @internal
|
|
2270
|
+
*/
|
|
2271
|
+
export declare const DescribeCampaignResponseFilterSensitiveLog: (obj: DescribeCampaignResponse) => any;
|
|
2272
|
+
/**
|
|
2273
|
+
* @internal
|
|
2274
|
+
*/
|
|
2275
|
+
export declare const EmailChannelSubtypeParametersFilterSensitiveLog: (obj: EmailChannelSubtypeParameters) => any;
|
|
2276
|
+
/**
|
|
2277
|
+
* @internal
|
|
2278
|
+
*/
|
|
2279
|
+
export declare const SmsChannelSubtypeParametersFilterSensitiveLog: (obj: SmsChannelSubtypeParameters) => any;
|
|
2280
|
+
/**
|
|
2281
|
+
* @internal
|
|
2282
|
+
*/
|
|
2283
|
+
export declare const TelephonyChannelSubtypeParametersFilterSensitiveLog: (obj: TelephonyChannelSubtypeParameters) => any;
|
|
2284
|
+
/**
|
|
2285
|
+
* @internal
|
|
2286
|
+
*/
|
|
2287
|
+
export declare const ChannelSubtypeParametersFilterSensitiveLog: (obj: ChannelSubtypeParameters) => any;
|
|
2288
|
+
/**
|
|
2289
|
+
* @internal
|
|
2290
|
+
*/
|
|
2291
|
+
export declare const OutboundRequestFilterSensitiveLog: (obj: OutboundRequest) => any;
|
|
2292
|
+
/**
|
|
2293
|
+
* @internal
|
|
2294
|
+
*/
|
|
2295
|
+
export declare const PutOutboundRequestBatchRequestFilterSensitiveLog: (obj: PutOutboundRequestBatchRequest) => any;
|
|
2296
|
+
/**
|
|
2297
|
+
* @internal
|
|
2298
|
+
*/
|
|
2299
|
+
export declare const UpdateCampaignChannelSubtypeConfigRequestFilterSensitiveLog: (obj: UpdateCampaignChannelSubtypeConfigRequest) => any;
|