ConnectCampaignServiceV2Client#
Index > ConnectCampaignServiceV2 > ConnectCampaignServiceV2Client
Auto-generated documentation for ConnectCampaignServiceV2 type annotations stubs module mypy-boto3-connectcampaignsv2.
ConnectCampaignServiceV2Client#
Type annotations and code completion for boto3.client("connectcampaignsv2")
.
boto3 documentation
# ConnectCampaignServiceV2Client usage example
from boto3.session import Session
from mypy_boto3_connectcampaignsv2.client import ConnectCampaignServiceV2Client
def get_connectcampaignsv2_client() -> ConnectCampaignServiceV2Client:
return Session().client("connectcampaignsv2")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("connectcampaignsv2").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("connectcampaignsv2")
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_connectcampaignsv2.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("connectcampaignsv2").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("connectcampaignsv2").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("connectcampaignsv2").create_campaign
method.
boto3 documentation
# create_campaign method definition
def create_campaign(
self,
*,
name: str,
connectInstanceId: str,
channelSubtypeConfig: ChannelSubtypeConfigTypeDef, # (1)
source: SourceTypeDef = ..., # (2)
connectCampaignFlowArn: str = ...,
schedule: ScheduleTypeDef = ..., # (3)
communicationTimeConfig: CommunicationTimeConfigTypeDef = ..., # (4)
communicationLimitsOverride: CommunicationLimitsConfigTypeDef = ..., # (5)
tags: Mapping[str, str] = ...,
) -> CreateCampaignResponseTypeDef: # (6)
...
- See ChannelSubtypeConfigTypeDef
- See SourceTypeDef
- See ScheduleTypeDef
- See CommunicationTimeConfigTypeDef
- See CommunicationLimitsConfigTypeDef
- See CreateCampaignResponseTypeDef
# create_campaign method usage example with argument unpacking
kwargs: CreateCampaignRequestRequestTypeDef = { # (1)
"name": ...,
"connectInstanceId": ...,
"channelSubtypeConfig": ...,
}
parent.create_campaign(**kwargs)
delete_campaign#
Deletes a campaign from the specified Amazon Connect account.
Type annotations and code completion for boto3.client("connectcampaignsv2").delete_campaign
method.
boto3 documentation
# delete_campaign method definition
def delete_campaign(
self,
*,
id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_campaign method usage example with argument unpacking
kwargs: DeleteCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_campaign(**kwargs)
delete_campaign_channel_subtype_config#
Deletes the channel subtype config of a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").delete_campaign_channel_subtype_config
method.
boto3 documentation
# delete_campaign_channel_subtype_config method definition
def delete_campaign_channel_subtype_config(
self,
*,
id: str,
channelSubtype: ChannelSubtypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# delete_campaign_channel_subtype_config method usage example with argument unpacking
kwargs: DeleteCampaignChannelSubtypeConfigRequestRequestTypeDef = { # (1)
"id": ...,
"channelSubtype": ...,
}
parent.delete_campaign_channel_subtype_config(**kwargs)
delete_campaign_communication_limits#
Deletes the communication limits config for a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").delete_campaign_communication_limits
method.
boto3 documentation
# delete_campaign_communication_limits method definition
def delete_campaign_communication_limits(
self,
*,
id: str,
config: CommunicationLimitsConfigTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# delete_campaign_communication_limits method usage example with argument unpacking
kwargs: DeleteCampaignCommunicationLimitsRequestRequestTypeDef = { # (1)
"id": ...,
"config": ...,
}
parent.delete_campaign_communication_limits(**kwargs)
delete_campaign_communication_time#
Deletes the communication time config for a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").delete_campaign_communication_time
method.
boto3 documentation
# delete_campaign_communication_time method definition
def delete_campaign_communication_time(
self,
*,
id: str,
config: CommunicationTimeConfigTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# delete_campaign_communication_time method usage example with argument unpacking
kwargs: DeleteCampaignCommunicationTimeRequestRequestTypeDef = { # (1)
"id": ...,
"config": ...,
}
parent.delete_campaign_communication_time(**kwargs)
delete_connect_instance_config#
Deletes a connect instance config from the specified AWS account.
Type annotations and code completion for boto3.client("connectcampaignsv2").delete_connect_instance_config
method.
boto3 documentation
# delete_connect_instance_config method definition
def delete_connect_instance_config(
self,
*,
connectInstanceId: str,
campaignDeletionPolicy: CampaignDeletionPolicyType = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# delete_connect_instance_config method usage example with argument unpacking
kwargs: DeleteConnectInstanceConfigRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
}
parent.delete_connect_instance_config(**kwargs)
delete_connect_instance_integration#
Delete the integration for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connectcampaignsv2").delete_connect_instance_integration
method.
boto3 documentation
# delete_connect_instance_integration method definition
def delete_connect_instance_integration(
self,
*,
connectInstanceId: str,
integrationIdentifier: IntegrationIdentifierTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# delete_connect_instance_integration method usage example with argument unpacking
kwargs: DeleteConnectInstanceIntegrationRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
"integrationIdentifier": ...,
}
parent.delete_connect_instance_integration(**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("connectcampaignsv2").delete_instance_onboarding_job
method.
boto3 documentation
# delete_instance_onboarding_job method definition
def delete_instance_onboarding_job(
self,
*,
connectInstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_instance_onboarding_job method usage example with argument unpacking
kwargs: DeleteInstanceOnboardingJobRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
}
parent.delete_instance_onboarding_job(**kwargs)
describe_campaign#
Describes the specific campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").describe_campaign
method.
boto3 documentation
# describe_campaign method definition
def describe_campaign(
self,
*,
id: str,
) -> DescribeCampaignResponseTypeDef: # (1)
...
# describe_campaign method usage example with argument unpacking
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("connectcampaignsv2").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("connectcampaignsv2").get_campaign_state
method.
boto3 documentation
# get_campaign_state method definition
def get_campaign_state(
self,
*,
id: str,
) -> GetCampaignStateResponseTypeDef: # (1)
...
# get_campaign_state method usage example with argument unpacking
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("connectcampaignsv2").get_campaign_state_batch
method.
boto3 documentation
# get_campaign_state_batch method definition
def get_campaign_state_batch(
self,
*,
campaignIds: Sequence[str],
) -> GetCampaignStateBatchResponseTypeDef: # (1)
...
# get_campaign_state_batch method usage example with argument unpacking
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("connectcampaignsv2").get_connect_instance_config
method.
boto3 documentation
# get_connect_instance_config method definition
def get_connect_instance_config(
self,
*,
connectInstanceId: str,
) -> GetConnectInstanceConfigResponseTypeDef: # (1)
...
# get_connect_instance_config method usage example with argument unpacking
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("connectcampaignsv2").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)
...
# get_instance_onboarding_job_status method usage example with argument unpacking
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("connectcampaignsv2").list_campaigns
method.
boto3 documentation
# list_campaigns method definition
def list_campaigns(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
filters: CampaignFiltersTypeDef = ..., # (1)
) -> ListCampaignsResponseTypeDef: # (2)
...
# list_campaigns method usage example with argument unpacking
kwargs: ListCampaignsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_campaigns(**kwargs)
list_connect_instance_integrations#
Provides summary information about the integration under the specified Connect instance.
Type annotations and code completion for boto3.client("connectcampaignsv2").list_connect_instance_integrations
method.
boto3 documentation
# list_connect_instance_integrations method definition
def list_connect_instance_integrations(
self,
*,
connectInstanceId: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListConnectInstanceIntegrationsResponseTypeDef: # (1)
...
# list_connect_instance_integrations method usage example with argument unpacking
kwargs: ListConnectInstanceIntegrationsRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
}
parent.list_connect_instance_integrations(**kwargs)
list_tags_for_resource#
List tags for a resource.
Type annotations and code completion for boto3.client("connectcampaignsv2").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
arn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
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("connectcampaignsv2").pause_campaign
method.
boto3 documentation
# pause_campaign method definition
def pause_campaign(
self,
*,
id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# pause_campaign method usage example with argument unpacking
kwargs: PauseCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.pause_campaign(**kwargs)
put_connect_instance_integration#
Put or update the integration for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connectcampaignsv2").put_connect_instance_integration
method.
boto3 documentation
# put_connect_instance_integration method definition
def put_connect_instance_integration(
self,
*,
connectInstanceId: str,
integrationConfig: IntegrationConfigTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# put_connect_instance_integration method usage example with argument unpacking
kwargs: PutConnectInstanceIntegrationRequestRequestTypeDef = { # (1)
"connectInstanceId": ...,
"integrationConfig": ...,
}
parent.put_connect_instance_integration(**kwargs)
put_outbound_request_batch#
Creates outbound requests for the specified campaign Amazon Connect account.
Type annotations and code completion for boto3.client("connectcampaignsv2").put_outbound_request_batch
method.
boto3 documentation
# put_outbound_request_batch method definition
def put_outbound_request_batch(
self,
*,
id: str,
outboundRequests: Sequence[OutboundRequestTypeDef], # (1)
) -> PutOutboundRequestBatchResponseTypeDef: # (2)
...
# put_outbound_request_batch method usage example with argument unpacking
kwargs: PutOutboundRequestBatchRequestRequestTypeDef = { # (1)
"id": ...,
"outboundRequests": ...,
}
parent.put_outbound_request_batch(**kwargs)
resume_campaign#
Stops a campaign for the specified Amazon Connect account.
Type annotations and code completion for boto3.client("connectcampaignsv2").resume_campaign
method.
boto3 documentation
# resume_campaign method definition
def resume_campaign(
self,
*,
id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# resume_campaign method usage example with argument unpacking
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("connectcampaignsv2").start_campaign
method.
boto3 documentation
# start_campaign method definition
def start_campaign(
self,
*,
id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# start_campaign method usage example with argument unpacking
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("connectcampaignsv2").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)
...
# start_instance_onboarding_job method usage example with argument unpacking
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("connectcampaignsv2").stop_campaign
method.
boto3 documentation
# stop_campaign method definition
def stop_campaign(
self,
*,
id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# stop_campaign method usage example with argument unpacking
kwargs: StopCampaignRequestRequestTypeDef = { # (1)
"id": ...,
}
parent.stop_campaign(**kwargs)
tag_resource#
Tag a resource.
Type annotations and code completion for boto3.client("connectcampaignsv2").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
arn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"arn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Untag a resource.
Type annotations and code completion for boto3.client("connectcampaignsv2").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
arn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"arn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_campaign_channel_subtype_config#
Updates the channel subtype config of a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").update_campaign_channel_subtype_config
method.
boto3 documentation
# update_campaign_channel_subtype_config method definition
def update_campaign_channel_subtype_config(
self,
*,
id: str,
channelSubtypeConfig: ChannelSubtypeConfigTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_campaign_channel_subtype_config method usage example with argument unpacking
kwargs: UpdateCampaignChannelSubtypeConfigRequestRequestTypeDef = { # (1)
"id": ...,
"channelSubtypeConfig": ...,
}
parent.update_campaign_channel_subtype_config(**kwargs)
update_campaign_communication_limits#
Updates the communication limits config for a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").update_campaign_communication_limits
method.
boto3 documentation
# update_campaign_communication_limits method definition
def update_campaign_communication_limits(
self,
*,
id: str,
communicationLimitsOverride: CommunicationLimitsConfigTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_campaign_communication_limits method usage example with argument unpacking
kwargs: UpdateCampaignCommunicationLimitsRequestRequestTypeDef = { # (1)
"id": ...,
"communicationLimitsOverride": ...,
}
parent.update_campaign_communication_limits(**kwargs)
update_campaign_communication_time#
Updates the communication time config for a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").update_campaign_communication_time
method.
boto3 documentation
# update_campaign_communication_time method definition
def update_campaign_communication_time(
self,
*,
id: str,
communicationTimeConfig: CommunicationTimeConfigTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_campaign_communication_time method usage example with argument unpacking
kwargs: UpdateCampaignCommunicationTimeRequestRequestTypeDef = { # (1)
"id": ...,
"communicationTimeConfig": ...,
}
parent.update_campaign_communication_time(**kwargs)
update_campaign_flow_association#
Updates the campaign flow associated with a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").update_campaign_flow_association
method.
boto3 documentation
# update_campaign_flow_association method definition
def update_campaign_flow_association(
self,
*,
id: str,
connectCampaignFlowArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# update_campaign_flow_association method usage example with argument unpacking
kwargs: UpdateCampaignFlowAssociationRequestRequestTypeDef = { # (1)
"id": ...,
"connectCampaignFlowArn": ...,
}
parent.update_campaign_flow_association(**kwargs)
update_campaign_name#
Updates the name of a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").update_campaign_name
method.
boto3 documentation
# update_campaign_name method definition
def update_campaign_name(
self,
*,
id: str,
name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# update_campaign_name method usage example with argument unpacking
kwargs: UpdateCampaignNameRequestRequestTypeDef = { # (1)
"id": ...,
"name": ...,
}
parent.update_campaign_name(**kwargs)
update_campaign_schedule#
Updates the schedule for a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").update_campaign_schedule
method.
boto3 documentation
# update_campaign_schedule method definition
def update_campaign_schedule(
self,
*,
id: str,
schedule: ScheduleTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_campaign_schedule method usage example with argument unpacking
kwargs: UpdateCampaignScheduleRequestRequestTypeDef = { # (1)
"id": ...,
"schedule": ...,
}
parent.update_campaign_schedule(**kwargs)
update_campaign_source#
Updates the campaign source with a campaign.
Type annotations and code completion for boto3.client("connectcampaignsv2").update_campaign_source
method.
boto3 documentation
# update_campaign_source method definition
def update_campaign_source(
self,
*,
id: str,
source: SourceTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_campaign_source method usage example with argument unpacking
kwargs: UpdateCampaignSourceRequestRequestTypeDef = { # (1)
"id": ...,
"source": ...,
}
parent.update_campaign_source(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("connectcampaignsv2").get_paginator
method with overloads.
client.get_paginator("list_campaigns")
-> ListCampaignsPaginatorclient.get_paginator("list_connect_instance_integrations")
-> ListConnectInstanceIntegrationsPaginator