ConnectCampaignServiceClient

Index > ConnectCampaignService > ConnectCampaignServiceClient

Auto-generated documentation for ConnectCampaignService type annotations stubs module mypy-boto3-connectcampaigns.

ConnectCampaignServiceClient

Type annotations and code completion for boto3.client("connectcampaigns"). boto3 documentation

# ConnectCampaignServiceClient usage example

from boto3.session import Session
from mypy_boto3_connectcampaigns.client import ConnectCampaignServiceClient

def get_connectcampaigns_client() -> ConnectCampaignServiceClient:
    return Session().client("connectcampaigns")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("connectcampaigns").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("connectcampaigns")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidCampaignStateException,
    client.exceptions.InvalidStateException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_connectcampaigns.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("connectcampaigns").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("connectcampaigns").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_campaign

Creates a campaign for the specified Amazon Connect account.

Type annotations and code completion for boto3.client("connectcampaigns").create_campaign method. boto3 documentation

# create_campaign method definition

def create_campaign(
    self,
    *,
    name: str,
    connectInstanceId: str,
    dialerConfig: DialerConfigTypeDef,  # (1)
    outboundCallConfig: OutboundCallConfigTypeDef,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateCampaignResponseTypeDef:  # (3)
    ...

1. See DialerConfigTypeDef
2. See OutboundCallConfigTypeDef
3. See CreateCampaignResponseTypeDef

# create_campaign method usage example with argument unpacking

kwargs: CreateCampaignRequestRequestTypeDef = {  # (1)
    "name": ...,
    "connectInstanceId": ...,
    "dialerConfig": ...,
    "outboundCallConfig": ...,
}

parent.create_campaign(**kwargs)

1. See CreateCampaignRequestRequestTypeDef

delete_campaign

Deletes a campaign from the specified Amazon Connect account.

Type annotations and code completion for boto3.client("connectcampaigns").delete_campaign method. boto3 documentation

# delete_campaign method definition

def delete_campaign(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_campaign method usage example with argument unpacking

kwargs: DeleteCampaignRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_campaign(**kwargs)

1. See DeleteCampaignRequestRequestTypeDef

delete_connect_instance_config

Deletes a connect instance config from the specified AWS account.

Type annotations and code completion for boto3.client("connectcampaigns").delete_connect_instance_config method. boto3 documentation

# delete_connect_instance_config method definition

def delete_connect_instance_config(
    self,
    *,
    connectInstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_connect_instance_config method usage example with argument unpacking

kwargs: DeleteConnectInstanceConfigRequestRequestTypeDef = {  # (1)
    "connectInstanceId": ...,
}

parent.delete_connect_instance_config(**kwargs)

1. See DeleteConnectInstanceConfigRequestRequestTypeDef

delete_instance_onboarding_job

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

Type annotations and code completion for boto3.client("connectcampaigns").delete_instance_onboarding_job method. boto3 documentation

# delete_instance_onboarding_job method definition

def delete_instance_onboarding_job(
    self,
    *,
    connectInstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_instance_onboarding_job method usage example with argument unpacking

kwargs: DeleteInstanceOnboardingJobRequestRequestTypeDef = {  # (1)
    "connectInstanceId": ...,
}

parent.delete_instance_onboarding_job(**kwargs)

1. See DeleteInstanceOnboardingJobRequestRequestTypeDef

describe_campaign

Describes the specific campaign.

Type annotations and code completion for boto3.client("connectcampaigns").describe_campaign method. boto3 documentation

# describe_campaign method definition

def describe_campaign(
    self,
    *,
    id: str,
) -> DescribeCampaignResponseTypeDef:  # (1)
    ...

1. See DescribeCampaignResponseTypeDef

# describe_campaign method usage example with argument unpacking

kwargs: DescribeCampaignRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.describe_campaign(**kwargs)

1. See DescribeCampaignRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("connectcampaigns").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_campaign_state

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

Type annotations and code completion for boto3.client("connectcampaigns").get_campaign_state method. boto3 documentation

# get_campaign_state method definition

def get_campaign_state(
    self,
    *,
    id: str,
) -> GetCampaignStateResponseTypeDef:  # (1)
    ...

1. See GetCampaignStateResponseTypeDef

# get_campaign_state method usage example with argument unpacking

kwargs: GetCampaignStateRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_campaign_state(**kwargs)

1. See GetCampaignStateRequestRequestTypeDef

get_campaign_state_batch

Get state of campaigns for the specified Amazon Connect account.

Type annotations and code completion for boto3.client("connectcampaigns").get_campaign_state_batch method. boto3 documentation

# get_campaign_state_batch method definition

def get_campaign_state_batch(
    self,
    *,
    campaignIds: Sequence[str],
) -> GetCampaignStateBatchResponseTypeDef:  # (1)
    ...

1. See GetCampaignStateBatchResponseTypeDef

# get_campaign_state_batch method usage example with argument unpacking

kwargs: GetCampaignStateBatchRequestRequestTypeDef = {  # (1)
    "campaignIds": ...,
}

parent.get_campaign_state_batch(**kwargs)

1. See GetCampaignStateBatchRequestRequestTypeDef

get_connect_instance_config

Get the specific Connect instance config.

Type annotations and code completion for boto3.client("connectcampaigns").get_connect_instance_config method. boto3 documentation

# get_connect_instance_config method definition

def get_connect_instance_config(
    self,
    *,
    connectInstanceId: str,
) -> GetConnectInstanceConfigResponseTypeDef:  # (1)
    ...

1. See GetConnectInstanceConfigResponseTypeDef

# get_connect_instance_config method usage example with argument unpacking

kwargs: GetConnectInstanceConfigRequestRequestTypeDef = {  # (1)
    "connectInstanceId": ...,
}

parent.get_connect_instance_config(**kwargs)

1. See GetConnectInstanceConfigRequestRequestTypeDef

get_instance_onboarding_job_status

Get the specific instance onboarding job status.

Type annotations and code completion for boto3.client("connectcampaigns").get_instance_onboarding_job_status method. boto3 documentation

# get_instance_onboarding_job_status method definition

def get_instance_onboarding_job_status(
    self,
    *,
    connectInstanceId: str,
) -> GetInstanceOnboardingJobStatusResponseTypeDef:  # (1)
    ...

1. See GetInstanceOnboardingJobStatusResponseTypeDef

# get_instance_onboarding_job_status method usage example with argument unpacking

kwargs: GetInstanceOnboardingJobStatusRequestRequestTypeDef = {  # (1)
    "connectInstanceId": ...,
}

parent.get_instance_onboarding_job_status(**kwargs)

1. See GetInstanceOnboardingJobStatusRequestRequestTypeDef

list_campaigns

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

Type annotations and code completion for boto3.client("connectcampaigns").list_campaigns method. boto3 documentation

# list_campaigns method definition

def list_campaigns(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    filters: CampaignFiltersTypeDef = ...,  # (1)
) -> ListCampaignsResponseTypeDef:  # (2)
    ...

1. See CampaignFiltersTypeDef
2. See ListCampaignsResponseTypeDef

# list_campaigns method usage example with argument unpacking

kwargs: ListCampaignsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_campaigns(**kwargs)

1. See ListCampaignsRequestRequestTypeDef

list_tags_for_resource

List tags for a resource.

Type annotations and code completion for boto3.client("connectcampaigns").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    arn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

pause_campaign

Pauses a campaign for the specified Amazon Connect account.

Type annotations and code completion for boto3.client("connectcampaigns").pause_campaign method. boto3 documentation

# pause_campaign method definition

def pause_campaign(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# pause_campaign method usage example with argument unpacking

kwargs: PauseCampaignRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.pause_campaign(**kwargs)

1. See PauseCampaignRequestRequestTypeDef

put_dial_request_batch

Creates dials requests for the specified campaign Amazon Connect account.

Type annotations and code completion for boto3.client("connectcampaigns").put_dial_request_batch method. boto3 documentation

# put_dial_request_batch method definition

def put_dial_request_batch(
    self,
    *,
    id: str,
    dialRequests: Sequence[DialRequestTypeDef],  # (1)
) -> PutDialRequestBatchResponseTypeDef:  # (2)
    ...

1. See DialRequestTypeDef
2. See PutDialRequestBatchResponseTypeDef

# put_dial_request_batch method usage example with argument unpacking

kwargs: PutDialRequestBatchRequestRequestTypeDef = {  # (1)
    "id": ...,
    "dialRequests": ...,
}

parent.put_dial_request_batch(**kwargs)

1. See PutDialRequestBatchRequestRequestTypeDef

resume_campaign

Stops a campaign for the specified Amazon Connect account.

Type annotations and code completion for boto3.client("connectcampaigns").resume_campaign method. boto3 documentation

# resume_campaign method definition

def resume_campaign(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# resume_campaign method usage example with argument unpacking

kwargs: ResumeCampaignRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.resume_campaign(**kwargs)

1. See ResumeCampaignRequestRequestTypeDef

start_campaign

Starts a campaign for the specified Amazon Connect account.

Type annotations and code completion for boto3.client("connectcampaigns").start_campaign method. boto3 documentation

# start_campaign method definition

def start_campaign(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# start_campaign method usage example with argument unpacking

kwargs: StartCampaignRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.start_campaign(**kwargs)

1. See StartCampaignRequestRequestTypeDef

start_instance_onboarding_job

Onboard the specific Amazon Connect instance to Connect Campaigns.

Type annotations and code completion for boto3.client("connectcampaigns").start_instance_onboarding_job method. boto3 documentation

# start_instance_onboarding_job method definition

def start_instance_onboarding_job(
    self,
    *,
    connectInstanceId: str,
    encryptionConfig: EncryptionConfigTypeDef,  # (1)
) -> StartInstanceOnboardingJobResponseTypeDef:  # (2)
    ...

1. See EncryptionConfigTypeDef
2. See StartInstanceOnboardingJobResponseTypeDef

# start_instance_onboarding_job method usage example with argument unpacking

kwargs: StartInstanceOnboardingJobRequestRequestTypeDef = {  # (1)
    "connectInstanceId": ...,
    "encryptionConfig": ...,
}

parent.start_instance_onboarding_job(**kwargs)

1. See StartInstanceOnboardingJobRequestRequestTypeDef

stop_campaign

Stops a campaign for the specified Amazon Connect account.

Type annotations and code completion for boto3.client("connectcampaigns").stop_campaign method. boto3 documentation

# stop_campaign method definition

def stop_campaign(
    self,
    *,
    id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_campaign method usage example with argument unpacking

kwargs: StopCampaignRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.stop_campaign(**kwargs)

1. See StopCampaignRequestRequestTypeDef

tag_resource

Tag a resource.

Type annotations and code completion for boto3.client("connectcampaigns").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    arn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Untag a resource.

Type annotations and code completion for boto3.client("connectcampaigns").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    arn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_campaign_dialer_config

Updates the dialer config of a campaign.

Type annotations and code completion for boto3.client("connectcampaigns").update_campaign_dialer_config method. boto3 documentation

# update_campaign_dialer_config method definition

def update_campaign_dialer_config(
    self,
    *,
    id: str,
    dialerConfig: DialerConfigTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See DialerConfigTypeDef
2. See EmptyResponseMetadataTypeDef

# update_campaign_dialer_config method usage example with argument unpacking

kwargs: UpdateCampaignDialerConfigRequestRequestTypeDef = {  # (1)
    "id": ...,
    "dialerConfig": ...,
}

parent.update_campaign_dialer_config(**kwargs)

1. See UpdateCampaignDialerConfigRequestRequestTypeDef

update_campaign_name

Updates the name of a campaign.

Type annotations and code completion for boto3.client("connectcampaigns").update_campaign_name method. boto3 documentation

# update_campaign_name method definition

def update_campaign_name(
    self,
    *,
    id: str,
    name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# update_campaign_name method usage example with argument unpacking

kwargs: UpdateCampaignNameRequestRequestTypeDef = {  # (1)
    "id": ...,
    "name": ...,
}

parent.update_campaign_name(**kwargs)

1. See UpdateCampaignNameRequestRequestTypeDef

update_campaign_outbound_call_config

Updates the outbound call config of a campaign.

Type annotations and code completion for boto3.client("connectcampaigns").update_campaign_outbound_call_config method. boto3 documentation

# update_campaign_outbound_call_config method definition

def update_campaign_outbound_call_config(
    self,
    *,
    id: str,
    connectContactFlowId: str = ...,
    connectSourcePhoneNumber: str = ...,
    answerMachineDetectionConfig: AnswerMachineDetectionConfigTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See AnswerMachineDetectionConfigTypeDef
2. See EmptyResponseMetadataTypeDef

# update_campaign_outbound_call_config method usage example with argument unpacking

kwargs: UpdateCampaignOutboundCallConfigRequestRequestTypeDef = {  # (1)
    "id": ...,
}

parent.update_campaign_outbound_call_config(**kwargs)

1. See UpdateCampaignOutboundCallConfigRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("connectcampaigns").get_paginator method with overloads.

• client.get_paginator("list_campaigns") -> ListCampaignsPaginator