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
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.
client = boto3.client("connectcampaigns")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.InvalidCampaignStateException,
client.InvalidStateException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("connectcampaigns").close
method.
boto3 documentation
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
def create_campaign(
self,
*,
connectInstanceId: str,
dialerConfig: DialerConfigTypeDef, # (1)
name: str,
outboundCallConfig: OutboundCallConfigTypeDef, # (2)
tags: Mapping[str, str] = ...,
) -> CreateCampaignResponseTypeDef: # (3)
...
kwargs: CreateCampaignRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
"dialerConfig": ...,
"name": ...,
"outboundCallConfig": ...,
}
parent.create_campaign(**kwargs)
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
def delete_campaign(
self,
*,
id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_campaign(**kwargs)
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
def delete_connect_instance_config(
self,
*,
connectInstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteConnectInstanceConfigRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
}
parent.delete_connect_instance_config(**kwargs)
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
def delete_instance_onboarding_job(
self,
*,
connectInstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteInstanceOnboardingJobRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
}
parent.delete_instance_onboarding_job(**kwargs)
describe_campaign
Describes the specific campaign.
Type annotations and code completion for boto3.client("connectcampaigns").describe_campaign
method.
boto3 documentation
def describe_campaign(
self,
*,
id: str,
) -> DescribeCampaignResponseTypeDef: # (1)
...
kwargs: DescribeCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.describe_campaign(**kwargs)
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
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
def get_campaign_state(
self,
*,
id: str,
) -> GetCampaignStateResponseTypeDef: # (1)
...
kwargs: GetCampaignStateRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.get_campaign_state(**kwargs)
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
def get_campaign_state_batch(
self,
*,
campaignIds: Sequence[str],
) -> GetCampaignStateBatchResponseTypeDef: # (1)
...
kwargs: GetCampaignStateBatchRequestRequestTypeDef = { # (1)
"campaignIds": ...,
}
parent.get_campaign_state_batch(**kwargs)
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
def get_connect_instance_config(
self,
*,
connectInstanceId: str,
) -> GetConnectInstanceConfigResponseTypeDef: # (1)
...
kwargs: GetConnectInstanceConfigRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
}
parent.get_connect_instance_config(**kwargs)
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
def get_instance_onboarding_job_status(
self,
*,
connectInstanceId: str,
) -> GetInstanceOnboardingJobStatusResponseTypeDef: # (1)
...
kwargs: GetInstanceOnboardingJobStatusRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
}
parent.get_instance_onboarding_job_status(**kwargs)
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
def list_campaigns(
self,
*,
filters: CampaignFiltersTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListCampaignsResponseTypeDef: # (2)
...
kwargs: ListCampaignsRequestRequestTypeDef = { # (1)
"filters": ...,
}
parent.list_campaigns(**kwargs)
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
def list_tags_for_resource(
self,
*,
arn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
kwargs: PauseCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.pause_campaign(**kwargs)
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
def put_dial_request_batch(
self,
*,
dialRequests: Sequence[DialRequestTypeDef], # (1)
id: str,
) -> PutDialRequestBatchResponseTypeDef: # (2)
...
kwargs: PutDialRequestBatchRequestRequestTypeDef = { # (1)
"dialRequests": ...,
"id": ...,
}
parent.put_dial_request_batch(**kwargs)
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
def resume_campaign(
self,
*,
id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ResumeCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.resume_campaign(**kwargs)
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
kwargs: StartCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.start_campaign(**kwargs)
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
def start_instance_onboarding_job(
self,
*,
connectInstanceId: str,
encryptionConfig: EncryptionConfigTypeDef, # (1)
) -> StartInstanceOnboardingJobResponseTypeDef: # (2)
...
kwargs: StartInstanceOnboardingJobRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
"encryptionConfig": ...,
}
parent.start_instance_onboarding_job(**kwargs)
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
kwargs: StopCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.stop_campaign(**kwargs)
tag_resource
Tag a resource.
Type annotations and code completion for boto3.client("connectcampaigns").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
arn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"arn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Untag a resource.
Type annotations and code completion for boto3.client("connectcampaigns").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
arn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"arn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
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
def update_campaign_dialer_config(
self,
*,
dialerConfig: DialerConfigTypeDef, # (1)
id: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateCampaignDialerConfigRequestRequestTypeDef = { # (1)
"dialerConfig": ...,
"id": ...,
}
parent.update_campaign_dialer_config(**kwargs)
update_campaign_name
Updates the name of a campaign.
Type annotations and code completion for boto3.client("connectcampaigns").update_campaign_name
method.
boto3 documentation
def update_campaign_name(
self,
*,
id: str,
name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateCampaignNameRequestRequestTypeDef = { # (1)
"id": ...,
"name": ...,
}
parent.update_campaign_name(**kwargs)
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
def update_campaign_outbound_call_config(
self,
*,
id: str,
answerMachineDetectionConfig: AnswerMachineDetectionConfigTypeDef = ..., # (1)
connectContactFlowId: str = ...,
connectSourcePhoneNumber: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateCampaignOutboundCallConfigRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.update_campaign_outbound_call_config(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("connectcampaigns").get_paginator
method with overloads.
client.get_paginator("list_campaigns")
-> ListCampaignsPaginator