ConnectCampaignService ¶

Table of Contents

ConnectCampaignService
- Client
- Paginators

Client ¶

class 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(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Returns: 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'
    }
)

Parameters

connectInstanceId (string) --
[REQUIRED]

Amazon Connect Instance Id
dialerConfig (dict) --
[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.
- predictiveDialerConfig (dict) --
  Predictive Dialer config
  - bandwidthAllocation (float) -- [REQUIRED]
    The bandwidth allocation of a queue resource.
- progressiveDialerConfig (dict) --
  Progressive Dialer config
  - bandwidthAllocation (float) -- [REQUIRED]
    The bandwidth allocation of a queue resource.
name (string) --
[REQUIRED]

The name of an Amazon Connect Campaign name.
outboundCallConfig (dict) --
[REQUIRED]

The configuration used for outbound calls.
- answerMachineDetectionConfig (dict) --
  Answering Machine Detection config
  - enableAnswerMachineDetection (boolean) -- [REQUIRED]
    Enable or disable answering machine detection
- connectContactFlowId (string) -- [REQUIRED]
  The identifier of the contact flow for the outbound call.
- connectQueueId (string) -- [REQUIRED]
  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.
- connectSourcePhoneNumber (string) --
  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.
tags (dict) --
Tag map with key and value.
- (string) --
  Tag key.
  - (string) --
    Tag value.

Return type

dict

Returns

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.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ServiceQuotaExceededException
ConnectCampaignService.Client.exceptions.ThrottlingException

delete_campaign(**kwargs)¶

Deletes a campaign from the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

response = client.delete_campaign(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

Identifier representing a Campaign

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException

delete_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'
)

Parameters

connectInstanceId (string) --

[REQUIRED]

Amazon Connect Instance Id

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.InvalidStateException
ConnectCampaignService.Client.exceptions.ThrottlingException

delete_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'
)

Parameters

connectInstanceId (string) --

[REQUIRED]

Amazon Connect Instance Id

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.InvalidStateException

describe_campaign(**kwargs)¶

Describes the specific campaign.

See also: AWS API Documentation

Request Syntax

response = client.describe_campaign(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

Identifier representing a Campaign

Return type

dict

Returns

Response Syntax

{
    '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

(dict) --
DescribeCampaignResponse
- campaign (dict) --
  An Amazon Connect campaign.
  - arn (string) --
    The resource name of an Amazon Connect campaign.
  - connectInstanceId (string) --
    Amazon Connect Instance Id
  - dialerConfig (dict) --
    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'}
    - predictiveDialerConfig (dict) --
      Predictive Dialer config
      - bandwidthAllocation (float) --
        The bandwidth allocation of a queue resource.
    - progressiveDialerConfig (dict) --
      Progressive Dialer config
      - bandwidthAllocation (float) --
        The bandwidth allocation of a queue resource.
  - id (string) --
    Identifier representing a Campaign
  - name (string) --
    The name of an Amazon Connect Campaign name.
  - outboundCallConfig (dict) --
    The configuration used for outbound calls.
    - answerMachineDetectionConfig (dict) --
      Answering Machine Detection config
      - enableAnswerMachineDetection (boolean) --
        Enable or disable answering machine detection
    - connectContactFlowId (string) --
      The identifier of the contact flow for the outbound call.
    - connectQueueId (string) --
      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.
    - connectSourcePhoneNumber (string) --
      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.
  - tags (dict) --
    Tag map with key and value.
    - (string) --
      Tag key.
      - (string) --
        Tag value.

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException

get_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'
)

Parameters

id (string) --

[REQUIRED]

Identifier representing a Campaign

Return type

dict

Returns

Response Syntax

{
    'state': 'Initialized'|'Running'|'Paused'|'Stopped'|'Failed'
}

Response Structure

(dict) --
GetCampaignStateResponse
- state (string) --
  State of a campaign

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

get_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',
    ]
)

Parameters

campaignIds (list) --

[REQUIRED]

List of CampaignId

(string) --
Identifier representing a Campaign

Return type

dict

Returns

Response Syntax

{
    'failedRequests': [
        {
            'campaignId': 'string',
            'failureCode': 'ResourceNotFound'|'UnknownError'
        },
    ],
    'successfulRequests': [
        {
            'campaignId': 'string',
            'state': 'Initialized'|'Running'|'Paused'|'Stopped'|'Failed'
        },
    ]
}

Response Structure

(dict) --
GetCampaignStateBatchResponse
- failedRequests (list) --
  List of failed requests of campaign state
  - (dict) --
    Failed response of campaign state
    - campaignId (string) --
      Identifier representing a Campaign
    - failureCode (string) --
      A predefined code indicating the error that caused the failure in getting state of campaigns
- successfulRequests (list) --
  List of successful response of campaign state
  - (dict) --
    Successful response of campaign state
    - campaignId (string) --
      Identifier representing a Campaign
    - state (string) --
      State of a campaign

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

get_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'
)

Parameters

connectInstanceId (string) --

[REQUIRED]

Amazon Connect Instance Id

Return type

dict

Returns

Response Syntax

{
    'connectInstanceConfig': {
        'connectInstanceId': 'string',
        'encryptionConfig': {
            'enabled': True|False,
            'encryptionType': 'KMS',
            'keyArn': 'string'
        },
        'serviceLinkedRoleArn': 'string'
    }
}

Response Structure

(dict) --
GetConnectInstanceConfigResponse
- connectInstanceConfig (dict) --
  Instance config object
  - connectInstanceId (string) --
    Amazon Connect Instance Id
  - encryptionConfig (dict) --
    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
    - enabled (boolean) --
      Boolean to indicate if custom encryption has been enabled.
    - encryptionType (string) --
      Server-side encryption type.
    - keyArn (string) --
      KMS key id/arn for encryption config.
  - serviceLinkedRoleArn (string) --
    Service linked role arn

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException

get_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'
)

Parameters

connectInstanceId (string) --

[REQUIRED]

Amazon Connect Instance Id

Return type

dict

Returns

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) --
GetInstanceOnboardingJobStatusResponse
- 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.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is 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").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

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'
)

Parameters

filters (dict) --
Filter model by type
- instanceIdFilter (dict) --
  Connect instance identifier filter
  - operator (string) -- [REQUIRED]
    Operators for Connect instance identifier filter
  - value (string) -- [REQUIRED]
    Amazon Connect Instance Id
maxResults (integer) -- The maximum number of results to return per page.
nextToken (string) -- The token for the next set of results.

Return type

dict

Returns

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.InternalServerException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException

list_tags_for_resource(**kwargs)¶

List tags for a resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    arn='string'
)

Parameters

arn (string) --

[REQUIRED]

Arn

Return type

dict

Returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
ListTagsForResponse
- tags (dict) --
  Tag map with key and value.
  - (string) --
    Tag key.
    - (string) --
      Tag value.

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

pause_campaign(**kwargs)¶

Pauses a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

response = client.pause_campaign(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

Identifier representing a Campaign

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.InvalidCampaignStateException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

put_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'
)

Parameters

dialRequests (list) --
[REQUIRED]

A list of dial requests.
- (dict) --
  A dial request for a campaign.
  - attributes (dict) -- [REQUIRED]
    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.
    - (string) --
      The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.
      - (string) --
        The value of the attribute.
  - clientToken (string) -- [REQUIRED]
    Client provided parameter used for idempotency. Its value must be unique for each request.
  - expirationTime (datetime) -- [REQUIRED]
    Timestamp with no UTC offset or timezone
  - phoneNumber (string) -- [REQUIRED]
    The phone number of the customer, in E.164 format.
id (string) --
[REQUIRED]

Identifier representing a Campaign

Return type

dict

Returns

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.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.InvalidCampaignStateException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

resume_campaign(**kwargs)¶

Stops a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

response = client.resume_campaign(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

Identifier representing a Campaign

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.InvalidCampaignStateException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

start_campaign(**kwargs)¶

Starts a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

response = client.start_campaign(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

Identifier representing a Campaign

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.InvalidCampaignStateException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

start_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'
    }
)

Parameters

connectInstanceId (string) --
[REQUIRED]

Amazon Connect Instance Id
encryptionConfig (dict) --
[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
- enabled (boolean) -- [REQUIRED]
  Boolean to indicate if custom encryption has been enabled.
- encryptionType (string) --
  Server-side encryption type.
- keyArn (string) --
  KMS key id/arn for encryption config.

Return type

dict

Returns

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.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

stop_campaign(**kwargs)¶

Stops a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

response = client.stop_campaign(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

Identifier representing a Campaign

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.InvalidCampaignStateException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

tag_resource(**kwargs)¶

Tag a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    arn='string',
    tags={
        'string': 'string'
    }
)

Parameters

arn (string) --
[REQUIRED]

Arn
tags (dict) --
[REQUIRED]

Tag map with key and value.
- (string) --
  Tag key.
  - (string) --
    Tag value.

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

untag_resource(**kwargs)¶

Untag a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    arn='string',
    tagKeys=[
        'string',
    ]
)

Parameters

arn (string) --
[REQUIRED]

Arn
tagKeys (list) --
[REQUIRED]

List of tag keys.
- (string) --
  Tag key.

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

update_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'
)

Parameters

dialerConfig (dict) --
[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.
- predictiveDialerConfig (dict) --
  Predictive Dialer config
  - bandwidthAllocation (float) -- [REQUIRED]
    The bandwidth allocation of a queue resource.
- progressiveDialerConfig (dict) --
  Progressive Dialer config
  - bandwidthAllocation (float) -- [REQUIRED]
    The bandwidth allocation of a queue resource.
id (string) --
[REQUIRED]

Identifier representing a Campaign

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.AccessDeniedException

update_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'
)

Parameters

id (string) --
[REQUIRED]

Identifier representing a Campaign
name (string) --
[REQUIRED]

The name of an Amazon Connect Campaign name.

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.AccessDeniedException

update_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'
)

Parameters

answerMachineDetectionConfig (dict) --
Answering Machine Detection config
- enableAnswerMachineDetection (boolean) -- [REQUIRED]
  Enable or disable answering machine detection
connectContactFlowId (string) -- The identifier of the contact flow for the outbound call.
connectSourcePhoneNumber (string) -- 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.
id (string) --
[REQUIRED]

Identifier representing a Campaign

Returns

None

Exceptions

ConnectCampaignService.Client.exceptions.InternalServerException
ConnectCampaignService.Client.exceptions.ResourceNotFoundException
ConnectCampaignService.Client.exceptions.ValidationException
ConnectCampaignService.Client.exceptions.ConflictException
ConnectCampaignService.Client.exceptions.AccessDeniedException
ConnectCampaignService.Client.exceptions.ThrottlingException

Paginators ¶

The available paginators are:

ConnectCampaignService.Paginator.ListCampaigns

class 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'
    }
)

Parameters

filters (dict) --
Filter model by type
- instanceIdFilter (dict) --
  Connect instance identifier filter
  - operator (string) -- [REQUIRED]
    Operators for Connect instance identifier filter
  - value (string) -- [REQUIRED]
    Amazon Connect Instance Id
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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.

Table Of Contents

ConnectCampaignService¶

Client¶

Paginators¶

ConnectCampaignService ¶

Client ¶

Paginators ¶