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.