connectcampaignsv2/aws.sdk.kotlin.services.connectcampaignsv2

Package-level declarations

Types

ConnectCampaignsV2Client

interface ConnectCampaignsV2Client : SdkClient

Provide APIs to create and manage Amazon Connect Campaigns.

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Inherited functions

inline suspend fun ConnectCampaignsV2Client.createCampaign(crossinline block: CreateCampaignRequest.Builder.() -> Unit): CreateCampaignResponse

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

inline suspend fun ConnectCampaignsV2Client.deleteCampaign(crossinline block: DeleteCampaignRequest.Builder.() -> Unit): DeleteCampaignResponse

Deletes a campaign from the specified Amazon Connect account.

deleteCampaignChannelSubtypeConfig

inline suspend fun ConnectCampaignsV2Client.deleteCampaignChannelSubtypeConfig(crossinline block: DeleteCampaignChannelSubtypeConfigRequest.Builder.() -> Unit): DeleteCampaignChannelSubtypeConfigResponse

Deletes the channel subtype config of a campaign. This API is idempotent.

deleteCampaignCommunicationLimits

inline suspend fun ConnectCampaignsV2Client.deleteCampaignCommunicationLimits(crossinline block: DeleteCampaignCommunicationLimitsRequest.Builder.() -> Unit): DeleteCampaignCommunicationLimitsResponse

Deletes the communication limits config for a campaign. This API is idempotent.

deleteCampaignCommunicationTime

inline suspend fun ConnectCampaignsV2Client.deleteCampaignCommunicationTime(crossinline block: DeleteCampaignCommunicationTimeRequest.Builder.() -> Unit): DeleteCampaignCommunicationTimeResponse

Deletes the communication time config for a campaign. This API is idempotent.

deleteConnectInstanceConfig

inline suspend fun ConnectCampaignsV2Client.deleteConnectInstanceConfig(crossinline block: DeleteConnectInstanceConfigRequest.Builder.() -> Unit): DeleteConnectInstanceConfigResponse

Deletes a connect instance config from the specified AWS account.

deleteConnectInstanceIntegration

inline suspend fun ConnectCampaignsV2Client.deleteConnectInstanceIntegration(crossinline block: DeleteConnectInstanceIntegrationRequest.Builder.() -> Unit): DeleteConnectInstanceIntegrationResponse

Delete the integration for the specified Amazon Connect instance.

deleteInstanceOnboardingJob

inline suspend fun ConnectCampaignsV2Client.deleteInstanceOnboardingJob(crossinline block: DeleteInstanceOnboardingJobRequest.Builder.() -> Unit): DeleteInstanceOnboardingJobResponse

Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.

describeCampaign

inline suspend fun ConnectCampaignsV2Client.describeCampaign(crossinline block: DescribeCampaignRequest.Builder.() -> Unit): DescribeCampaignResponse

Describes the specific campaign.

getCampaignState

inline suspend fun ConnectCampaignsV2Client.getCampaignState(crossinline block: GetCampaignStateRequest.Builder.() -> Unit): GetCampaignStateResponse

Get state of a campaign for the specified Amazon Connect account.

getCampaignStateBatch

inline suspend fun ConnectCampaignsV2Client.getCampaignStateBatch(crossinline block: GetCampaignStateBatchRequest.Builder.() -> Unit): GetCampaignStateBatchResponse

Get state of campaigns for the specified Amazon Connect account.

getConnectInstanceConfig

inline suspend fun ConnectCampaignsV2Client.getConnectInstanceConfig(crossinline block: GetConnectInstanceConfigRequest.Builder.() -> Unit): GetConnectInstanceConfigResponse

Get the specific Connect instance config.

getInstanceCommunicationLimits

inline suspend fun ConnectCampaignsV2Client.getInstanceCommunicationLimits(crossinline block: GetInstanceCommunicationLimitsRequest.Builder.() -> Unit): GetInstanceCommunicationLimitsResponse

Get the instance communication limits.

getInstanceOnboardingJobStatus

inline suspend fun ConnectCampaignsV2Client.getInstanceOnboardingJobStatus(crossinline block: GetInstanceOnboardingJobStatusRequest.Builder.() -> Unit): GetInstanceOnboardingJobStatusResponse

Get the specific instance onboarding job status.

inline suspend fun ConnectCampaignsV2Client.listCampaigns(crossinline block: ListCampaignsRequest.Builder.() -> Unit): ListCampaignsResponse

Provides summary information about the campaigns under the specified Amazon Connect account.

listConnectInstanceIntegrations

inline suspend fun ConnectCampaignsV2Client.listConnectInstanceIntegrations(crossinline block: ListConnectInstanceIntegrationsRequest.Builder.() -> Unit): ListConnectInstanceIntegrationsResponse

Provides summary information about the integration under the specified Connect instance.

listTagsForResource

inline suspend fun ConnectCampaignsV2Client.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List tags for a resource.

inline suspend fun ConnectCampaignsV2Client.pauseCampaign(crossinline block: PauseCampaignRequest.Builder.() -> Unit): PauseCampaignResponse

Pauses a campaign for the specified Amazon Connect account.

putConnectInstanceIntegration

inline suspend fun ConnectCampaignsV2Client.putConnectInstanceIntegration(crossinline block: PutConnectInstanceIntegrationRequest.Builder.() -> Unit): PutConnectInstanceIntegrationResponse

Put or update the integration for the specified Amazon Connect instance.

putInstanceCommunicationLimits

inline suspend fun ConnectCampaignsV2Client.putInstanceCommunicationLimits(crossinline block: PutInstanceCommunicationLimitsRequest.Builder.() -> Unit): PutInstanceCommunicationLimitsResponse

Put the instance communication limits. This API is idempotent.

putOutboundRequestBatch

inline suspend fun ConnectCampaignsV2Client.putOutboundRequestBatch(crossinline block: PutOutboundRequestBatchRequest.Builder.() -> Unit): PutOutboundRequestBatchResponse

Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent.

putProfileOutboundRequestBatch

inline suspend fun ConnectCampaignsV2Client.putProfileOutboundRequestBatch(crossinline block: PutProfileOutboundRequestBatchRequest.Builder.() -> Unit): PutProfileOutboundRequestBatchResponse

Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent.

inline suspend fun ConnectCampaignsV2Client.resumeCampaign(crossinline block: ResumeCampaignRequest.Builder.() -> Unit): ResumeCampaignResponse

Stops a campaign for the specified Amazon Connect account.

inline suspend fun ConnectCampaignsV2Client.startCampaign(crossinline block: StartCampaignRequest.Builder.() -> Unit): StartCampaignResponse

Starts a campaign for the specified Amazon Connect account.

startInstanceOnboardingJob

inline suspend fun ConnectCampaignsV2Client.startInstanceOnboardingJob(crossinline block: StartInstanceOnboardingJobRequest.Builder.() -> Unit): StartInstanceOnboardingJobResponse

Onboard the specific Amazon Connect instance to Connect Campaigns.

inline suspend fun ConnectCampaignsV2Client.stopCampaign(crossinline block: StopCampaignRequest.Builder.() -> Unit): StopCampaignResponse

Stops a campaign for the specified Amazon Connect account.

inline suspend fun ConnectCampaignsV2Client.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tag a resource.

inline suspend fun ConnectCampaignsV2Client.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Untag a resource.

updateCampaignChannelSubtypeConfig

inline suspend fun ConnectCampaignsV2Client.updateCampaignChannelSubtypeConfig(crossinline block: UpdateCampaignChannelSubtypeConfigRequest.Builder.() -> Unit): UpdateCampaignChannelSubtypeConfigResponse

Updates the channel subtype config of a campaign. This API is idempotent.

updateCampaignCommunicationLimits

inline suspend fun ConnectCampaignsV2Client.updateCampaignCommunicationLimits(crossinline block: UpdateCampaignCommunicationLimitsRequest.Builder.() -> Unit): UpdateCampaignCommunicationLimitsResponse

Updates the communication limits config for a campaign. This API is idempotent.

updateCampaignCommunicationTime

inline suspend fun ConnectCampaignsV2Client.updateCampaignCommunicationTime(crossinline block: UpdateCampaignCommunicationTimeRequest.Builder.() -> Unit): UpdateCampaignCommunicationTimeResponse

Updates the communication time config for a campaign. This API is idempotent.

updateCampaignFlowAssociation

inline suspend fun ConnectCampaignsV2Client.updateCampaignFlowAssociation(crossinline block: UpdateCampaignFlowAssociationRequest.Builder.() -> Unit): UpdateCampaignFlowAssociationResponse

Updates the campaign flow associated with a campaign. This API is idempotent.

updateCampaignName

inline suspend fun ConnectCampaignsV2Client.updateCampaignName(crossinline block: UpdateCampaignNameRequest.Builder.() -> Unit): UpdateCampaignNameResponse

Updates the name of a campaign. This API is idempotent.

updateCampaignSchedule

inline suspend fun ConnectCampaignsV2Client.updateCampaignSchedule(crossinline block: UpdateCampaignScheduleRequest.Builder.() -> Unit): UpdateCampaignScheduleResponse

Updates the schedule for a campaign. This API is idempotent.

updateCampaignSource

inline suspend fun ConnectCampaignsV2Client.updateCampaignSource(crossinline block: UpdateCampaignSourceRequest.Builder.() -> Unit): UpdateCampaignSourceResponse

Updates the campaign source with a campaign. This API is idempotent.

fun ConnectCampaignsV2Client.withConfig(block: ConnectCampaignsV2Client.Config.Builder.() -> Unit): ConnectCampaignsV2Client

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.