connectcampaigns/aws.sdk.kotlin.services.connectcampaigns/ConnectCampaignsClient

ConnectCampaignsClient

interface ConnectCampaignsClient : SdkClient

Provide APIs to create and manage Amazon Connect Campaigns.

Types

class Builder : AbstractSdkClientBuilder<ConnectCampaignsClient.Config, ConnectCampaignsClient.Config.Builder, ConnectCampaignsClient>

object Companion : AbstractAwsSdkClientFactory<ConnectCampaignsClient.Config, ConnectCampaignsClient.Config.Builder, ConnectCampaignsClient, ConnectCampaignsClient.Builder>

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

abstract override val config: ConnectCampaignsClient.Config

ConnectCampaignsClient's configuration

Functions

abstract suspend fun createCampaign(input: CreateCampaignRequest): CreateCampaignResponse

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

abstract suspend fun deleteCampaign(input: DeleteCampaignRequest): DeleteCampaignResponse

Deletes a campaign from the specified Amazon Connect account.

deleteConnectInstanceConfig

abstract suspend fun deleteConnectInstanceConfig(input: DeleteConnectInstanceConfigRequest): DeleteConnectInstanceConfigResponse

Deletes a connect instance config from the specified AWS account.

deleteInstanceOnboardingJob

abstract suspend fun deleteInstanceOnboardingJob(input: DeleteInstanceOnboardingJobRequest): DeleteInstanceOnboardingJobResponse

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

describeCampaign

abstract suspend fun describeCampaign(input: DescribeCampaignRequest): DescribeCampaignResponse

Describes the specific campaign.

getCampaignState

abstract suspend fun getCampaignState(input: GetCampaignStateRequest): GetCampaignStateResponse

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

getCampaignStateBatch

abstract suspend fun getCampaignStateBatch(input: GetCampaignStateBatchRequest): GetCampaignStateBatchResponse

Get state of campaigns for the specified Amazon Connect account.

getConnectInstanceConfig

abstract suspend fun getConnectInstanceConfig(input: GetConnectInstanceConfigRequest): GetConnectInstanceConfigResponse

Get the specific Connect instance config.

getInstanceOnboardingJobStatus

abstract suspend fun getInstanceOnboardingJobStatus(input: GetInstanceOnboardingJobStatusRequest): GetInstanceOnboardingJobStatusResponse

Get the specific instance onboarding job status.

abstract suspend fun listCampaigns(input: ListCampaignsRequest = ListCampaignsRequest { }): ListCampaignsResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

List tags for a resource.

abstract suspend fun pauseCampaign(input: PauseCampaignRequest): PauseCampaignResponse

Pauses a campaign for the specified Amazon Connect account.

putDialRequestBatch

abstract suspend fun putDialRequestBatch(input: PutDialRequestBatchRequest): PutDialRequestBatchResponse

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

abstract suspend fun resumeCampaign(input: ResumeCampaignRequest): ResumeCampaignResponse

Stops a campaign for the specified Amazon Connect account.

abstract suspend fun startCampaign(input: StartCampaignRequest): StartCampaignResponse

Starts a campaign for the specified Amazon Connect account.

startInstanceOnboardingJob

abstract suspend fun startInstanceOnboardingJob(input: StartInstanceOnboardingJobRequest): StartInstanceOnboardingJobResponse

Onboard the specific Amazon Connect instance to Connect Campaigns.

abstract suspend fun stopCampaign(input: StopCampaignRequest): StopCampaignResponse

Stops a campaign for the specified Amazon Connect account.

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tag a resource.

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Untag a resource.

updateCampaignDialerConfig

abstract suspend fun updateCampaignDialerConfig(input: UpdateCampaignDialerConfigRequest): UpdateCampaignDialerConfigResponse

Updates the dialer config of a campaign. This API is idempotent.

updateCampaignName

abstract suspend fun updateCampaignName(input: UpdateCampaignNameRequest): UpdateCampaignNameResponse

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

updateCampaignOutboundCallConfig

abstract suspend fun updateCampaignOutboundCallConfig(input: UpdateCampaignOutboundCallConfigRequest): UpdateCampaignOutboundCallConfigResponse

Updates the outbound call config of a campaign. This API is idempotent.

Inherited functions

expect abstract fun close()

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

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

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

Deletes a campaign from the specified Amazon Connect account.

deleteConnectInstanceConfig

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

Deletes a connect instance config from the specified AWS account.

deleteInstanceOnboardingJob

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

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

describeCampaign

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

Describes the specific campaign.

getCampaignState

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

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

getCampaignStateBatch

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

Get state of campaigns for the specified Amazon Connect account.

getConnectInstanceConfig

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

Get the specific Connect instance config.

getInstanceOnboardingJobStatus

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

Get the specific instance onboarding job status.

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

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

listCampaignsPaginated

fun ConnectCampaignsClient.listCampaignsPaginated(initialRequest: ListCampaignsRequest = ListCampaignsRequest { }): Flow<ListCampaignsResponse>

fun ConnectCampaignsClient.listCampaignsPaginated(block: ListCampaignsRequest.Builder.() -> Unit): Flow<ListCampaignsResponse>

Paginate over ListCampaignsResponse results.

listTagsForResource

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

List tags for a resource.

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

Pauses a campaign for the specified Amazon Connect account.

putDialRequestBatch

inline suspend fun ConnectCampaignsClient.putDialRequestBatch(crossinline block: PutDialRequestBatchRequest.Builder.() -> Unit): PutDialRequestBatchResponse

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

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

Stops a campaign for the specified Amazon Connect account.

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

Starts a campaign for the specified Amazon Connect account.

startInstanceOnboardingJob

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

Onboard the specific Amazon Connect instance to Connect Campaigns.

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

Stops a campaign for the specified Amazon Connect account.

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

Tag a resource.

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

Untag a resource.

updateCampaignDialerConfig

inline suspend fun ConnectCampaignsClient.updateCampaignDialerConfig(crossinline block: UpdateCampaignDialerConfigRequest.Builder.() -> Unit): UpdateCampaignDialerConfigResponse

Updates the dialer config of a campaign. This API is idempotent.

updateCampaignName

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

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

updateCampaignOutboundCallConfig

inline suspend fun ConnectCampaignsClient.updateCampaignOutboundCallConfig(crossinline block: UpdateCampaignOutboundCallConfigRequest.Builder.() -> Unit): UpdateCampaignOutboundCallConfigResponse

Updates the outbound call config of a campaign. This API is idempotent.

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

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.