AWS API Changes

2022/06/17 - AmazonConnectCampaignService - 22 new api methods

Changes Added Amazon Connect high volume outbound communications SDK.

UpdateCampaignDialerConfig (new)

Link ¶

Updates the dialer config of a campaign. This API is idempotent.

Request Syntax

client.update_campaign_dialer_config(
    dialerConfig={
        'predictiveDialerConfig': {
            'bandwidthAllocation': 123.0
        },
        'progressiveDialerConfig': {
            'bandwidthAllocation': 123.0
        }
    },
    id='string'
)

type dialerConfig:

dict

param dialerConfig:

[REQUIRED]

The possible types of dialer config parameters

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.

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

returns:

None

ResumeCampaign (new)

Link ¶

Stops a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

client.resume_campaign(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

returns:

None

GetConnectInstanceConfig (new)

Link ¶

Get the specific Connect instance config.

See also: AWS API Documentation

Request Syntax

client.get_connect_instance_config(
    connectInstanceId='string'
)

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

rtype:

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

DeleteInstanceOnboardingJob (new)

Link ¶

Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.delete_instance_onboarding_job(
    connectInstanceId='string'
)

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

returns:

None

StopCampaign (new)

Link ¶

Stops a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

client.stop_campaign(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

returns:

None

GetInstanceOnboardingJobStatus (new)

Link ¶

Get the specific instance onboarding job status.

See also: AWS API Documentation

Request Syntax

client.get_instance_onboarding_job_status(
    connectInstanceId='string'
)

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

rtype:

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

PauseCampaign (new)

Link ¶

Pauses a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

client.pause_campaign(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

returns:

None

ListCampaigns (new)

Link ¶

Provides summary information about the campaigns under the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

client.list_campaigns(
    filters={
        'instanceIdFilter': {
            'operator': 'Eq',
            'value': 'string'
        }
    },
    maxResults=123,
    nextToken='string'
)

type filters:

dict

param filters:

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

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

The token for the next set of results.

rtype:

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.

UpdateCampaignOutboundCallConfig (new)

Link ¶

Updates the outbound call config of a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_outbound_call_config(
    answerMachineDetectionConfig={
        'enableAnswerMachineDetection': True|False
    },
    connectContactFlowId='string',
    connectSourcePhoneNumber='string',
    id='string'
)

type answerMachineDetectionConfig:

dict

param answerMachineDetectionConfig:

Answering Machine Detection config

enableAnswerMachineDetection (boolean) -- [REQUIRED]

Enable or disable answering machine detection

type connectContactFlowId:

string

param connectContactFlowId:

The identifier of the contact flow for the outbound call.

type connectSourcePhoneNumber:

string

param connectSourcePhoneNumber:

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.

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

returns:

None

GetCampaignState (new)

Link ¶

Get state of a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

client.get_campaign_state(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --

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

TagResource (new)

Link ¶

Tag a resource.

See also: AWS API Documentation

Request Syntax

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

type arn:

string

param arn:

[REQUIRED]

Arn

type tags:

dict

param tags:

[REQUIRED]

Tag map with key and value.

(string) --

Tag key.
- (string) --
  
  Tag value.

returns:

None

DeleteCampaign (new)

Link ¶

Deletes a campaign from the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

client.delete_campaign(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

returns:

None

UpdateCampaignName (new)

Link ¶

Updates the name of a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_name(
    id='string',
    name='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type name:

string

param name:

[REQUIRED]

The name of an Amazon Connect Campaign name.

returns:

None

ListTagsForResource (new)

Link ¶

List tags for a resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    arn='string'
)

type arn:

string

param arn:

[REQUIRED]

Arn

rtype:

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.

CreateCampaign (new)

Link ¶

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

See also: AWS API Documentation

Request Syntax

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

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

type dialerConfig:

dict

param dialerConfig:

[REQUIRED]

The possible types of dialer config parameters

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.

type name:

string

param name:

[REQUIRED]

The name of an Amazon Connect Campaign name.

type outboundCallConfig:

dict

param outboundCallConfig:

[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.

type tags:

dict

param tags:

Tag map with key and value.

(string) --

Tag key.
- (string) --
  
  Tag value.

rtype:

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.

StartInstanceOnboardingJob (new)

Link ¶

Onboard the specific Amazon Connect instance to Connect Campaigns.

See also: AWS API Documentation

Request Syntax

client.start_instance_onboarding_job(
    connectInstanceId='string',
    encryptionConfig={
        'enabled': True|False,
        'encryptionType': 'KMS',
        'keyArn': 'string'
    }
)

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

type encryptionConfig:

dict

param encryptionConfig:

[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.

rtype:

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

PutDialRequestBatch (new)

Link ¶

Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.put_dial_request_batch(
    dialRequests=[
        {
            'attributes': {
                'string': 'string'
            },
            'clientToken': 'string',
            'expirationTime': datetime(2015, 1, 1),
            'phoneNumber': 'string'
        },
    ],
    id='string'
)

type dialRequests:

list

param dialRequests:

[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.

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

rtype:

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

DeleteConnectInstanceConfig (new)

Link ¶

Deletes a connect instance config from the specified AWS account.

See also: AWS API Documentation

Request Syntax

client.delete_connect_instance_config(
    connectInstanceId='string'
)

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

returns:

None

GetCampaignStateBatch (new)

Link ¶

Get state of campaigns for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

client.get_campaign_state_batch(
    campaignIds=[
        'string',
    ]
)

type campaignIds:

list

param campaignIds:

[REQUIRED]

List of CampaignId

(string) --

Identifier representing a Campaign

rtype:

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

StartCampaign (new)

Link ¶

Starts a campaign for the specified Amazon Connect account.

See also: AWS API Documentation

Request Syntax

client.start_campaign(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

returns:

None

DescribeCampaign (new)

Link ¶

Describes the specific campaign.

See also: AWS API Documentation

Request Syntax

client.describe_campaign(
    id='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

rtype:

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.

UntagResource (new)

Link ¶

Untag a resource.

See also: AWS API Documentation

Request Syntax

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

type arn:

string

param arn:

[REQUIRED]

Arn

type tagKeys:

list

param tagKeys:

[REQUIRED]

List of tag keys.

(string) --

Tag key.

returns:

None