- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ConnectCampaignsV2Client
Provide APIs to create and manage Amazon Connect Campaigns.
Installation
NPM
npm install @aws-sdk/client-connectcampaignsv2Yarn
yarn add @aws-sdk/client-connectcampaignsv2pnpm
pnpm add @aws-sdk/client-connectcampaignsv2ConnectCampaignsV2Client Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| CreateCampaignCommand | Creates a campaign for the specified Amazon Connect account. This API is idempotent. |
| DeleteCampaignChannelSubtypeConfigCommand | Deletes the channel subtype config of a campaign. This API is idempotent. |
| DeleteCampaignCommand | Deletes a campaign from the specified Amazon Connect account. |
| DeleteCampaignCommunicationLimitsCommand | Deletes the communication limits config for a campaign. This API is idempotent. |
| DeleteCampaignCommunicationTimeCommand | Deletes the communication time config for a campaign. This API is idempotent. |
| DeleteConnectInstanceConfigCommand | Deletes a connect instance config from the specified AWS account. |
| DeleteConnectInstanceIntegrationCommand | Delete the integration for the specified Amazon Connect instance. |
| DeleteInstanceOnboardingJobCommand | Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance. |
| DescribeCampaignCommand | Describes the specific campaign. |
| GetCampaignStateBatchCommand | Get state of campaigns for the specified Amazon Connect account. |
| GetCampaignStateCommand | Get state of a campaign for the specified Amazon Connect account. |
| GetConnectInstanceConfigCommand | Get the specific Connect instance config. |
| GetInstanceOnboardingJobStatusCommand | Get the specific instance onboarding job status. |
| ListCampaignsCommand | Provides summary information about the campaigns under the specified Amazon Connect account. |
| ListConnectInstanceIntegrationsCommand | Provides summary information about the integration under the specified Connect instance. |
| ListTagsForResourceCommand | List tags for a resource. |
| PauseCampaignCommand | Pauses a campaign for the specified Amazon Connect account. |
| PutConnectInstanceIntegrationCommand | Put or update the integration for the specified Amazon Connect instance. |
| PutOutboundRequestBatchCommand | Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent. |
| PutProfileOutboundRequestBatchCommand | Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent. |
| ResumeCampaignCommand | Stops a campaign for the specified Amazon Connect account. |
| StartCampaignCommand | Starts a campaign for the specified Amazon Connect account. |
| StartInstanceOnboardingJobCommand | Onboard the specific Amazon Connect instance to Connect Campaigns. |
| StopCampaignCommand | Stops a campaign for the specified Amazon Connect account. |
| TagResourceCommand | Tag a resource. |
| UntagResourceCommand | Untag a resource. |
| UpdateCampaignChannelSubtypeConfigCommand | Updates the channel subtype config of a campaign. This API is idempotent. |
| UpdateCampaignCommunicationLimitsCommand | Updates the communication limits config for a campaign. This API is idempotent. |
| UpdateCampaignCommunicationTimeCommand | Updates the communication time config for a campaign. This API is idempotent. |
| UpdateCampaignFlowAssociationCommand | Updates the campaign flow associated with a campaign. This API is idempotent. |
| UpdateCampaignNameCommand | Updates the name of a campaign. This API is idempotent. |
| UpdateCampaignScheduleCommand | Updates the schedule for a campaign. This API is idempotent. |
| UpdateCampaignSourceCommand | Updates the campaign source with a campaign. This API is idempotent. |
ConnectCampaignsV2Client Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ConnectCampaignsV2ClientConfig