Table of Contents
ConnectCampaignService.Client¶A low-level client representing AmazonConnectCampaignService
Provide APIs to create and manage Amazon Connect Campaigns.
import boto3
client = boto3.client('connectcampaigns')
These are the available methods:
can_paginate()close()create_campaign()delete_campaign()delete_connect_instance_config()delete_instance_onboarding_job()describe_campaign()get_campaign_state()get_campaign_state_batch()get_connect_instance_config()get_instance_onboarding_job_status()get_paginator()get_waiter()list_campaigns()list_tags_for_resource()pause_campaign()put_dial_request_batch()resume_campaign()start_campaign()start_instance_onboarding_job()stop_campaign()tag_resource()untag_resource()update_campaign_dialer_config()update_campaign_name()update_campaign_outbound_call_config()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_campaign(**kwargs)¶Creates a campaign for the specified Amazon Connect account. This API is idempotent.
See also: AWS API Documentation
Request Syntax
response = client.create_campaign(
connectInstanceId='string',
dialerConfig={
'predictiveDialerConfig': {
'bandwidthAllocation': 123.0
},
'progressiveDialerConfig': {
'bandwidthAllocation': 123.0
}
},
name='string',
outboundCallConfig={
'answerMachineDetectionConfig': {
'enableAnswerMachineDetection': True|False
},
'connectContactFlowId': 'string',
'connectQueueId': 'string',
'connectSourcePhoneNumber': 'string'
},
tags={
'string': 'string'
}
)
[REQUIRED]
Amazon Connect Instance Id
[REQUIRED]
The possible types of dialer config parameters
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: predictiveDialerConfig, progressiveDialerConfig.
Predictive Dialer config
The bandwidth allocation of a queue resource.
Progressive Dialer config
The bandwidth allocation of a queue resource.
[REQUIRED]
The name of an Amazon Connect Campaign name.
[REQUIRED]
The configuration used for outbound calls.
Answering Machine Detection config
Enable or disable answering machine detection
The identifier of the contact flow for the outbound call.
The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
Tag map with key and value.
Tag key.
Tag value.
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
The response for Create Campaign API
arn (string) --
The resource name of an Amazon Connect campaign.
id (string) --
Identifier representing a Campaign
tags (dict) --
Tag map with key and value.
(string) --
Tag key.
(string) --
Tag value.
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ServiceQuotaExceededExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptiondelete_campaign(**kwargs)¶Deletes a campaign from the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.delete_campaign(
id='string'
)
[REQUIRED]
Identifier representing a Campaign
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptiondelete_connect_instance_config(**kwargs)¶Deletes a connect instance config from the specified AWS account.
See also: AWS API Documentation
Request Syntax
response = client.delete_connect_instance_config(
connectInstanceId='string'
)
[REQUIRED]
Amazon Connect Instance Id
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.InvalidStateExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptiondelete_instance_onboarding_job(**kwargs)¶Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.delete_instance_onboarding_job(
connectInstanceId='string'
)
[REQUIRED]
Amazon Connect Instance Id
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.InvalidStateExceptiondescribe_campaign(**kwargs)¶Describes the specific campaign.
See also: AWS API Documentation
Request Syntax
response = client.describe_campaign(
id='string'
)
[REQUIRED]
Identifier representing a Campaign
{
'campaign': {
'arn': 'string',
'connectInstanceId': 'string',
'dialerConfig': {
'predictiveDialerConfig': {
'bandwidthAllocation': 123.0
},
'progressiveDialerConfig': {
'bandwidthAllocation': 123.0
}
},
'id': 'string',
'name': 'string',
'outboundCallConfig': {
'answerMachineDetectionConfig': {
'enableAnswerMachineDetection': True|False
},
'connectContactFlowId': 'string',
'connectQueueId': 'string',
'connectSourcePhoneNumber': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
DescribeCampaignResponse
An Amazon Connect campaign.
The resource name of an Amazon Connect campaign.
Amazon Connect Instance Id
The possible types of dialer config parameters
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: predictiveDialerConfig, progressiveDialerConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
Predictive Dialer config
The bandwidth allocation of a queue resource.
Progressive Dialer config
The bandwidth allocation of a queue resource.
Identifier representing a Campaign
The name of an Amazon Connect Campaign name.
The configuration used for outbound calls.
Answering Machine Detection config
Enable or disable answering machine detection
The identifier of the contact flow for the outbound call.
The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
Tag map with key and value.
Tag key.
Tag value.
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionget_campaign_state(**kwargs)¶Get state of a campaign for the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_state(
id='string'
)
[REQUIRED]
Identifier representing a Campaign
{
'state': 'Initialized'|'Running'|'Paused'|'Stopped'|'Failed'
}
Response Structure
GetCampaignStateResponse
State of a campaign
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionget_campaign_state_batch(**kwargs)¶Get state of campaigns for the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.get_campaign_state_batch(
campaignIds=[
'string',
]
)
[REQUIRED]
List of CampaignId
Identifier representing a Campaign
{
'failedRequests': [
{
'campaignId': 'string',
'failureCode': 'ResourceNotFound'|'UnknownError'
},
],
'successfulRequests': [
{
'campaignId': 'string',
'state': 'Initialized'|'Running'|'Paused'|'Stopped'|'Failed'
},
]
}
Response Structure
GetCampaignStateBatchResponse
List of failed requests of campaign state
Failed response of campaign state
Identifier representing a Campaign
A predefined code indicating the error that caused the failure in getting state of campaigns
List of successful response of campaign state
Successful response of campaign state
Identifier representing a Campaign
State of a campaign
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionget_connect_instance_config(**kwargs)¶Get the specific Connect instance config.
See also: AWS API Documentation
Request Syntax
response = client.get_connect_instance_config(
connectInstanceId='string'
)
[REQUIRED]
Amazon Connect Instance Id
{
'connectInstanceConfig': {
'connectInstanceId': 'string',
'encryptionConfig': {
'enabled': True|False,
'encryptionType': 'KMS',
'keyArn': 'string'
},
'serviceLinkedRoleArn': 'string'
}
}
Response Structure
GetConnectInstanceConfigResponse
Instance config object
Amazon Connect Instance Id
Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported
Boolean to indicate if custom encryption has been enabled.
Server-side encryption type.
KMS key id/arn for encryption config.
Service linked role arn
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionget_instance_onboarding_job_status(**kwargs)¶Get the specific instance onboarding job status.
See also: AWS API Documentation
Request Syntax
response = client.get_instance_onboarding_job_status(
connectInstanceId='string'
)
[REQUIRED]
Amazon Connect Instance Id
{
'connectInstanceOnboardingJobStatus': {
'connectInstanceId': 'string',
'failureCode': 'EVENT_BRIDGE_ACCESS_DENIED'|'EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED'|'IAM_ACCESS_DENIED'|'KMS_ACCESS_DENIED'|'KMS_KEY_NOT_FOUND'|'INTERNAL_FAILURE',
'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
}
}
Response Structure
GetInstanceOnboardingJobStatusResponse
Instance onboarding job status object
Amazon Connect Instance Id
Enumeration of the possible failure codes for instance onboarding job
Enumeration of the possible states for instance onboarding job
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_campaigns(**kwargs)¶Provides summary information about the campaigns under the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.list_campaigns(
filters={
'instanceIdFilter': {
'operator': 'Eq',
'value': 'string'
}
},
maxResults=123,
nextToken='string'
)
Filter model by type
Connect instance identifier filter
Operators for Connect instance identifier filter
Amazon Connect Instance Id
dict
Response Syntax
{
'campaignSummaryList': [
{
'arn': 'string',
'connectInstanceId': 'string',
'id': 'string',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
ListCampaignsResponse
campaignSummaryList (list) --
A list of Amazon Connect campaigns.
(dict) --
An Amazon Connect campaign summary.
arn (string) --
The resource name of an Amazon Connect campaign.
connectInstanceId (string) --
Amazon Connect Instance Id
id (string) --
Identifier representing a Campaign
name (string) --
The name of an Amazon Connect Campaign name.
nextToken (string) --
The token for the next set of results.
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionList tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
arn='string'
)
[REQUIRED]
Arn
{
'tags': {
'string': 'string'
}
}
Response Structure
ListTagsForResponse
Tag map with key and value.
Tag key.
Tag value.
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionpause_campaign(**kwargs)¶Pauses a campaign for the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.pause_campaign(
id='string'
)
[REQUIRED]
Identifier representing a Campaign
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.InvalidCampaignStateExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionput_dial_request_batch(**kwargs)¶Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.
See also: AWS API Documentation
Request Syntax
response = client.put_dial_request_batch(
dialRequests=[
{
'attributes': {
'string': 'string'
},
'clientToken': 'string',
'expirationTime': datetime(2015, 1, 1),
'phoneNumber': 'string'
},
],
id='string'
)
[REQUIRED]
A list of dial requests.
A dial request for a campaign.
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.
The value of the attribute.
Client provided parameter used for idempotency. Its value must be unique for each request.
Timestamp with no UTC offset or timezone
The phone number of the customer, in E.164 format.
[REQUIRED]
Identifier representing a Campaign
dict
Response Syntax
{
'failedRequests': [
{
'clientToken': 'string',
'failureCode': 'InvalidInput'|'RequestThrottled'|'UnknownError',
'id': 'string'
},
],
'successfulRequests': [
{
'clientToken': 'string',
'id': 'string'
},
]
}
Response Structure
(dict) --
PutDialRequestBatchResponse
failedRequests (list) --
A list of failed requests.
(dict) --
A failed request identified by the unique client token.
clientToken (string) --
Client provided parameter used for idempotency. Its value must be unique for each request.
failureCode (string) --
A predefined code indicating the error that caused the failure.
id (string) --
Identifier representing a Dial request
successfulRequests (list) --
A list of successful requests identified by the unique client token.
(dict) --
A successful request identified by the unique client token.
clientToken (string) --
Client provided parameter used for idempotency. Its value must be unique for each request.
id (string) --
Identifier representing a Dial request
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.InvalidCampaignStateExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionresume_campaign(**kwargs)¶Stops a campaign for the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.resume_campaign(
id='string'
)
[REQUIRED]
Identifier representing a Campaign
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.InvalidCampaignStateExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionstart_campaign(**kwargs)¶Starts a campaign for the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.start_campaign(
id='string'
)
[REQUIRED]
Identifier representing a Campaign
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.InvalidCampaignStateExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionstart_instance_onboarding_job(**kwargs)¶Onboard the specific Amazon Connect instance to Connect Campaigns.
See also: AWS API Documentation
Request Syntax
response = client.start_instance_onboarding_job(
connectInstanceId='string',
encryptionConfig={
'enabled': True|False,
'encryptionType': 'KMS',
'keyArn': 'string'
}
)
[REQUIRED]
Amazon Connect Instance Id
[REQUIRED]
Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported
Boolean to indicate if custom encryption has been enabled.
Server-side encryption type.
KMS key id/arn for encryption config.
dict
Response Syntax
{
'connectInstanceOnboardingJobStatus': {
'connectInstanceId': 'string',
'failureCode': 'EVENT_BRIDGE_ACCESS_DENIED'|'EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED'|'IAM_ACCESS_DENIED'|'KMS_ACCESS_DENIED'|'KMS_KEY_NOT_FOUND'|'INTERNAL_FAILURE',
'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
}
}
Response Structure
(dict) --
The response for StartInstanceOnboardingJob API.
connectInstanceOnboardingJobStatus (dict) --
Instance onboarding job status object
connectInstanceId (string) --
Amazon Connect Instance Id
failureCode (string) --
Enumeration of the possible failure codes for instance onboarding job
status (string) --
Enumeration of the possible states for instance onboarding job
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionstop_campaign(**kwargs)¶Stops a campaign for the specified Amazon Connect account.
See also: AWS API Documentation
Request Syntax
response = client.stop_campaign(
id='string'
)
[REQUIRED]
Identifier representing a Campaign
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.InvalidCampaignStateExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptiontag_resource(**kwargs)¶Tag a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
arn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
Arn
[REQUIRED]
Tag map with key and value.
Tag key.
Tag value.
None
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionuntag_resource(**kwargs)¶Untag a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
arn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
Arn
[REQUIRED]
List of tag keys.
Tag key.
None
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionupdate_campaign_dialer_config(**kwargs)¶Updates the dialer config of a campaign. This API is idempotent.
See also: AWS API Documentation
Request Syntax
response = client.update_campaign_dialer_config(
dialerConfig={
'predictiveDialerConfig': {
'bandwidthAllocation': 123.0
},
'progressiveDialerConfig': {
'bandwidthAllocation': 123.0
}
},
id='string'
)
[REQUIRED]
The possible types of dialer config parameters
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: predictiveDialerConfig, progressiveDialerConfig.
Predictive Dialer config
The bandwidth allocation of a queue resource.
Progressive Dialer config
The bandwidth allocation of a queue resource.
[REQUIRED]
Identifier representing a Campaign
None
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionupdate_campaign_name(**kwargs)¶Updates the name of a campaign. This API is idempotent.
See also: AWS API Documentation
Request Syntax
response = client.update_campaign_name(
id='string',
name='string'
)
[REQUIRED]
Identifier representing a Campaign
[REQUIRED]
The name of an Amazon Connect Campaign name.
None
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionupdate_campaign_outbound_call_config(**kwargs)¶Updates the outbound call config of a campaign. This API is idempotent.
See also: AWS API Documentation
Request Syntax
response = client.update_campaign_outbound_call_config(
answerMachineDetectionConfig={
'enableAnswerMachineDetection': True|False
},
connectContactFlowId='string',
connectSourcePhoneNumber='string',
id='string'
)
Answering Machine Detection config
Enable or disable answering machine detection
[REQUIRED]
Identifier representing a Campaign
None
Exceptions
ConnectCampaignService.Client.exceptions.InternalServerExceptionConnectCampaignService.Client.exceptions.ResourceNotFoundExceptionConnectCampaignService.Client.exceptions.ValidationExceptionConnectCampaignService.Client.exceptions.ConflictExceptionConnectCampaignService.Client.exceptions.AccessDeniedExceptionConnectCampaignService.Client.exceptions.ThrottlingExceptionThe available paginators are:
ConnectCampaignService.Paginator.ListCampaigns¶paginator = client.get_paginator('list_campaigns')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ConnectCampaignService.Client.list_campaigns().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'instanceIdFilter': {
'operator': 'Eq',
'value': 'string'
}
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filter model by type
Connect instance identifier filter
Operators for Connect instance identifier filter
Amazon Connect Instance Id
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'campaignSummaryList': [
{
'arn': 'string',
'connectInstanceId': 'string',
'id': 'string',
'name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ListCampaignsResponse
campaignSummaryList (list) --
A list of Amazon Connect campaigns.
(dict) --
An Amazon Connect campaign summary.
arn (string) --
The resource name of an Amazon Connect campaign.
connectInstanceId (string) --
Amazon Connect Instance Id
id (string) --
Identifier representing a Campaign
name (string) --
The name of an Amazon Connect Campaign name.
NextToken (string) --
A token to resume pagination.