AWS API Changes

2024/11/15 - AmazonConnectCampaignServiceV2 - 32 new api methods

Changes Added Amazon Connect Outbound Campaigns V2 SDK.

ListConnectInstanceIntegrations (new)

Link ¶

Provides summary information about the integration under the specified Connect instance.

Request Syntax

client.list_connect_instance_integrations(
    connectInstanceId='string',
    maxResults=123,
    nextToken='string'
)

type connectInstanceId:

string

param connectInstanceId:

[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

{
    'nextToken': 'string',
    'integrationSummaryList': [
        {
            'customerProfiles': {
                'domainArn': 'string',
                'objectTypeNames': {
                    'string': 'string'
                }
            },
            'qConnect': {
                'knowledgeBaseArn': 'string'
            }
        },
    ]
}

Response Structure

(dict) --

The response for ListConnectInstanceIntegrations API.
- nextToken (string) --
  
  The token for the next set of results.
- integrationSummaryList (list) --
  
  A list of Amazon Connect Instance Integrations.
  - (dict) --
    
    Integration summary for Connect instance.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: customerProfiles, qConnect. 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'}
```
    - customerProfiles (dict) --
      
      Customer Profiles integration summary
      - domainArn (string) --
        
        Amazon Resource Names(ARN)
      - objectTypeNames (dict) --
        
        Object type names map.
        
        (string) --
        
        Enumeration of Customer Profiles event type
        
        (string) --
        
        Object type name
    - qConnect (dict) --
      
      Q Connect integration summary
      - knowledgeBaseArn (string) --
        
        Amazon Resource Names(ARN)

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',
        'serviceLinkedRoleArn': 'string',
        'encryptionConfig': {
            'enabled': True|False,
            'encryptionType': 'KMS',
            'keyArn': 'string'
        }
    }
}

Response Structure

(dict) --

The response for GetConnectInstanceConfig API.
- connectInstanceConfig (dict) --
  
  Instance config object
  - connectInstanceId (string) --
    
    Amazon Connect Instance Id
  - serviceLinkedRoleArn (string) --
    
    Service linked role arn
  - 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.

UpdateCampaignFlowAssociation (new)

Link ¶

Updates the campaign flow associated with a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_flow_association(
    id='string',
    connectCampaignFlowArn='string'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type connectCampaignFlowArn:

string

param connectCampaignFlowArn:

[REQUIRED]

Amazon Resource Names(ARN)

returns:

None

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]

Amazon Resource Names(ARN)

type tagKeys:

list

param tagKeys:

[REQUIRED]

List of tag keys.

(string) --

The key of tag.

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

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

DeleteCampaignCommunicationTime (new)

Link ¶

Deletes the communication time config for a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.delete_campaign_communication_time(
    id='string',
    config='TELEPHONY'|'SMS'|'EMAIL'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type config:

string

param config:

[REQUIRED]

The type of campaign communication time config

returns:

None

UpdateCampaignCommunicationTime (new)

Link ¶

Updates the communication time config for a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_communication_time(
    id='string',
    communicationTimeConfig={
        'localTimeZoneConfig': {
            'defaultTimeZone': 'string',
            'localTimeZoneDetection': [
                'ZIP_CODE'|'AREA_CODE',
            ]
        },
        'telephony': {
            'openHours': {
                'dailyHours': {
                    'string': [
                        {
                            'startTime': 'string',
                            'endTime': 'string'
                        },
                    ]
                }
            },
            'restrictedPeriods': {
                'restrictedPeriodList': [
                    {
                        'name': 'string',
                        'startDate': 'string',
                        'endDate': 'string'
                    },
                ]
            }
        },
        'sms': {
            'openHours': {
                'dailyHours': {
                    'string': [
                        {
                            'startTime': 'string',
                            'endTime': 'string'
                        },
                    ]
                }
            },
            'restrictedPeriods': {
                'restrictedPeriodList': [
                    {
                        'name': 'string',
                        'startDate': 'string',
                        'endDate': 'string'
                    },
                ]
            }
        },
        'email': {
            'openHours': {
                'dailyHours': {
                    'string': [
                        {
                            'startTime': 'string',
                            'endTime': 'string'
                        },
                    ]
                }
            },
            'restrictedPeriods': {
                'restrictedPeriodList': [
                    {
                        'name': 'string',
                        'startDate': 'string',
                        'endDate': 'string'
                    },
                ]
            }
        }
    }
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type communicationTimeConfig:

dict

param communicationTimeConfig:

[REQUIRED]

Campaign communication time config

localTimeZoneConfig (dict) -- [REQUIRED]

Local time zone config
- defaultTimeZone (string) --
  
  Time Zone Id in the IANA format
- localTimeZoneDetection (list) --
  
  Local TimeZone Detection method list
  - (string) --
    
    Local TimeZone Detection method.
telephony (dict) --

Time window config
- openHours (dict) -- [REQUIRED]
  
  Open Hours config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: dailyHours.
  - dailyHours (dict) --
    
    Daily Hours map
    - (string) --
      
      Day of week enum
      - (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
- restrictedPeriods (dict) --
  
  Restricted period config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: restrictedPeriodList.
  - restrictedPeriodList (list) --
    
    List of restricted period
    - (dict) --
      
      Restricted period
      - name (string) --
        
        The name of a restricted period.
      - startDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
      - endDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
sms (dict) --

Time window config
- openHours (dict) -- [REQUIRED]
  
  Open Hours config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: dailyHours.
  - dailyHours (dict) --
    
    Daily Hours map
    - (string) --
      
      Day of week enum
      - (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
- restrictedPeriods (dict) --
  
  Restricted period config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: restrictedPeriodList.
  - restrictedPeriodList (list) --
    
    List of restricted period
    - (dict) --
      
      Restricted period
      - name (string) --
        
        The name of a restricted period.
      - startDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
      - endDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
email (dict) --

Time window config
- openHours (dict) -- [REQUIRED]
  
  Open Hours config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: dailyHours.
  - dailyHours (dict) --
    
    Daily Hours map
    - (string) --
      
      Day of week enum
      - (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
- restrictedPeriods (dict) --
  
  Restricted period config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: restrictedPeriodList.
  - restrictedPeriodList (list) --
    
    List of restricted period
    - (dict) --
      
      Restricted period
      - name (string) --
        
        The name of a restricted period.
      - startDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
      - endDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01

returns:

None

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(
    name='string',
    connectInstanceId='string',
    channelSubtypeConfig={
        'telephony': {
            'capacity': 123.0,
            'connectQueueId': 'string',
            'outboundMode': {
                'progressive': {
                    'bandwidthAllocation': 123.0
                },
                'predictive': {
                    'bandwidthAllocation': 123.0
                },
                'agentless': {}

            },
            'defaultOutboundConfig': {
                'connectContactFlowId': 'string',
                'connectSourcePhoneNumber': 'string',
                'answerMachineDetectionConfig': {
                    'enableAnswerMachineDetection': True|False,
                    'awaitAnswerMachinePrompt': True|False
                }
            }
        },
        'sms': {
            'capacity': 123.0,
            'outboundMode': {
                'agentless': {}

            },
            'defaultOutboundConfig': {
                'connectSourcePhoneNumberArn': 'string',
                'wisdomTemplateArn': 'string'
            }
        },
        'email': {
            'capacity': 123.0,
            'outboundMode': {
                'agentless': {}

            },
            'defaultOutboundConfig': {
                'connectSourceEmailAddress': 'string',
                'sourceEmailAddressDisplayName': 'string',
                'wisdomTemplateArn': 'string'
            }
        }
    },
    source={
        'customerProfilesSegmentArn': 'string'
    },
    connectCampaignFlowArn='string',
    schedule={
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'refreshFrequency': 'string'
    },
    communicationTimeConfig={
        'localTimeZoneConfig': {
            'defaultTimeZone': 'string',
            'localTimeZoneDetection': [
                'ZIP_CODE'|'AREA_CODE',
            ]
        },
        'telephony': {
            'openHours': {
                'dailyHours': {
                    'string': [
                        {
                            'startTime': 'string',
                            'endTime': 'string'
                        },
                    ]
                }
            },
            'restrictedPeriods': {
                'restrictedPeriodList': [
                    {
                        'name': 'string',
                        'startDate': 'string',
                        'endDate': 'string'
                    },
                ]
            }
        },
        'sms': {
            'openHours': {
                'dailyHours': {
                    'string': [
                        {
                            'startTime': 'string',
                            'endTime': 'string'
                        },
                    ]
                }
            },
            'restrictedPeriods': {
                'restrictedPeriodList': [
                    {
                        'name': 'string',
                        'startDate': 'string',
                        'endDate': 'string'
                    },
                ]
            }
        },
        'email': {
            'openHours': {
                'dailyHours': {
                    'string': [
                        {
                            'startTime': 'string',
                            'endTime': 'string'
                        },
                    ]
                }
            },
            'restrictedPeriods': {
                'restrictedPeriodList': [
                    {
                        'name': 'string',
                        'startDate': 'string',
                        'endDate': 'string'
                    },
                ]
            }
        }
    },
    communicationLimitsOverride={
        'allChannelSubtypes': {
            'communicationLimitsList': [
                {
                    'maxCountPerRecipient': 123,
                    'frequency': 123,
                    'unit': 'DAY'
                },
            ]
        }
    },
    tags={
        'string': 'string'
    }
)

type name:

string

param name:

[REQUIRED]

The name of an Amazon Connect Campaign name.

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

type channelSubtypeConfig:

dict

param channelSubtypeConfig:

[REQUIRED]

Campaign Channel Subtype config

telephony (dict) --

Telephony Channel Subtype config
- capacity (float) --
  
  Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
- 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.
- outboundMode (dict) -- [REQUIRED]
  
  Telephony Outbound Mode
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: progressive, predictive, agentless.
  - progressive (dict) --
    
    Progressive config
    - bandwidthAllocation (float) -- [REQUIRED]
      
      The bandwidth allocation of a queue resource.
  - predictive (dict) --
    
    Predictive config
    - bandwidthAllocation (float) -- [REQUIRED]
      
      The bandwidth allocation of a queue resource.
  - agentless (dict) --
    
    Agentless config
- defaultOutboundConfig (dict) -- [REQUIRED]
  
  Default Telephony Outbound config
  - connectContactFlowId (string) -- [REQUIRED]
    
    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.
  - answerMachineDetectionConfig (dict) --
    
    Answering Machine Detection config
    - enableAnswerMachineDetection (boolean) -- [REQUIRED]
      
      Enable or disable answering machine detection
    - awaitAnswerMachinePrompt (boolean) --
      
      Enable or disable await answer machine prompt
sms (dict) --

SMS Channel Subtype config
- capacity (float) --
  
  Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
- outboundMode (dict) -- [REQUIRED]
  
  SMS Outbound Mode
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: agentless.
  - agentless (dict) --
    
    Agentless config
- defaultOutboundConfig (dict) -- [REQUIRED]
  
  Default SMS Outbound config
  - connectSourcePhoneNumberArn (string) -- [REQUIRED]
    
    Amazon Resource Names(ARN)
  - wisdomTemplateArn (string) -- [REQUIRED]
    
    Amazon Resource Names(ARN)
email (dict) --

Email Channel Subtype config
- capacity (float) --
  
  Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
- outboundMode (dict) -- [REQUIRED]
  
  Email Outbound Mode
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: agentless.
  - agentless (dict) --
    
    Agentless config
- defaultOutboundConfig (dict) -- [REQUIRED]
  
  Default Email Outbound config
  - connectSourceEmailAddress (string) -- [REQUIRED]
    
    Source/Destination Email address used for Email messages
  - sourceEmailAddressDisplayName (string) --
    
    Display name for Email Address
  - wisdomTemplateArn (string) -- [REQUIRED]
    
    Amazon Resource Names(ARN)

type source:

dict

param source:

Source of the campaign

customerProfilesSegmentArn (string) --

Amazon Resource Names(ARN)

type connectCampaignFlowArn:

string

param connectCampaignFlowArn:

Amazon Resource Names(ARN)

type schedule:

dict

param schedule:

Campaign schedule

startTime (datetime) -- [REQUIRED]

Timestamp with no UTC offset or timezone
endTime (datetime) -- [REQUIRED]

Timestamp with no UTC offset or timezone
refreshFrequency (string) --

Time duration in ISO 8601 format

type communicationTimeConfig:

dict

param communicationTimeConfig:

Campaign communication time config

localTimeZoneConfig (dict) -- [REQUIRED]

Local time zone config
- defaultTimeZone (string) --
  
  Time Zone Id in the IANA format
- localTimeZoneDetection (list) --
  
  Local TimeZone Detection method list
  - (string) --
    
    Local TimeZone Detection method.
telephony (dict) --

Time window config
- openHours (dict) -- [REQUIRED]
  
  Open Hours config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: dailyHours.
  - dailyHours (dict) --
    
    Daily Hours map
    - (string) --
      
      Day of week enum
      - (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
- restrictedPeriods (dict) --
  
  Restricted period config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: restrictedPeriodList.
  - restrictedPeriodList (list) --
    
    List of restricted period
    - (dict) --
      
      Restricted period
      - name (string) --
        
        The name of a restricted period.
      - startDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
      - endDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
sms (dict) --

Time window config
- openHours (dict) -- [REQUIRED]
  
  Open Hours config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: dailyHours.
  - dailyHours (dict) --
    
    Daily Hours map
    - (string) --
      
      Day of week enum
      - (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
- restrictedPeriods (dict) --
  
  Restricted period config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: restrictedPeriodList.
  - restrictedPeriodList (list) --
    
    List of restricted period
    - (dict) --
      
      Restricted period
      - name (string) --
        
        The name of a restricted period.
      - startDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
      - endDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
email (dict) --

Time window config
- openHours (dict) -- [REQUIRED]
  
  Open Hours config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: dailyHours.
  - dailyHours (dict) --
    
    Daily Hours map
    - (string) --
      
      Day of week enum
      - (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) -- [REQUIRED]
        
        Time in ISO 8601 format, e.g. T23:11
- restrictedPeriods (dict) --
  
  Restricted period config
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: restrictedPeriodList.
  - restrictedPeriodList (list) --
    
    List of restricted period
    - (dict) --
      
      Restricted period
      - name (string) --
        
        The name of a restricted period.
      - startDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01
      - endDate (string) -- [REQUIRED]
        
        Date in ISO 8601 format, e.g. 2024-01-01

type communicationLimitsOverride:

dict

param communicationLimitsOverride:

Communication limits config

allChannelSubtypes (dict) --

Communication limits

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: communicationLimitsList.
- communicationLimitsList (list) --
  
  List of communication limit
  - (dict) --
    
    Communication Limit
    - maxCountPerRecipient (integer) -- [REQUIRED]
      
      Maximum number of contacts allowed for a given target within the given frequency.
    - frequency (integer) -- [REQUIRED]
      
      The number of days to consider with regards to this limit.
    - unit (string) -- [REQUIRED]
      
      The communication limit time unit.

type tags:

dict

param tags:

Tag map with key and value.

(string) --

The key of tag.
- (string) --
  
  The value of tag.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --

The response for Create Campaign API
- id (string) --
  
  Identifier representing a Campaign
- arn (string) --
  
  The resource name of an Amazon Connect campaign.
- tags (dict) --
  
  Tag map with key and value.
  - (string) --
    
    The key of tag.
    - (string) --
      
      The value of tag.

DeleteConnectInstanceIntegration (new)

Link ¶

Delete the integration for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.delete_connect_instance_integration(
    connectInstanceId='string',
    integrationIdentifier={
        'customerProfiles': {
            'domainArn': 'string'
        },
        'qConnect': {
            'knowledgeBaseArn': 'string'
        }
    }
)

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

type integrationIdentifier:

dict

param integrationIdentifier:

[REQUIRED]

Integration identifier for Connect instance

customerProfiles (dict) --

Customer Profiles integration identifier
- domainArn (string) -- [REQUIRED]
  
  Amazon Resource Names(ARN)
qConnect (dict) --

Q Connect integration identifier
- knowledgeBaseArn (string) -- [REQUIRED]
  
  Amazon Resource Names(ARN)

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

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

Response Structure

(dict) --

The response for GetCampaignStateBatch API.
- 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
- 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

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

DeleteCampaignChannelSubtypeConfig (new)

Link ¶

Deletes the channel subtype config of a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.delete_campaign_channel_subtype_config(
    id='string',
    channelSubtype='TELEPHONY'|'SMS'|'EMAIL'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type channelSubtype:

string

param channelSubtype:

[REQUIRED]

The type of campaign channel subtype.

returns:

None

UpdateCampaignSource (new)

Link ¶

Updates the campaign source with a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_source(
    id='string',
    source={
        'customerProfilesSegmentArn': 'string'
    }
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type source:

dict

param source:

[REQUIRED]

Source of the campaign

customerProfilesSegmentArn (string) --

Amazon Resource Names(ARN)

returns:

None

PutConnectInstanceIntegration (new)

Link ¶

Put or update the integration for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.put_connect_instance_integration(
    connectInstanceId='string',
    integrationConfig={
        'customerProfiles': {
            'domainArn': 'string',
            'objectTypeNames': {
                'string': 'string'
            }
        },
        'qConnect': {
            'knowledgeBaseArn': 'string'
        }
    }
)

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

type integrationConfig:

dict

param integrationConfig:

[REQUIRED]

Integration config for Connect Instance

customerProfiles (dict) --

Customer Profiles integration config
- domainArn (string) -- [REQUIRED]
  
  Amazon Resource Names(ARN)
- objectTypeNames (dict) -- [REQUIRED]
  
  Object type names map.
  - (string) --
    
    Enumeration of Customer Profiles event type
    - (string) --
      
      Object type name
qConnect (dict) --

Q Connect integration config
- knowledgeBaseArn (string) -- [REQUIRED]
  
  Amazon Resource Names(ARN)

returns:

None

UpdateCampaignChannelSubtypeConfig (new)

Link ¶

Updates the channel subtype config of a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_channel_subtype_config(
    id='string',
    channelSubtypeConfig={
        'telephony': {
            'capacity': 123.0,
            'connectQueueId': 'string',
            'outboundMode': {
                'progressive': {
                    'bandwidthAllocation': 123.0
                },
                'predictive': {
                    'bandwidthAllocation': 123.0
                },
                'agentless': {}

            },
            'defaultOutboundConfig': {
                'connectContactFlowId': 'string',
                'connectSourcePhoneNumber': 'string',
                'answerMachineDetectionConfig': {
                    'enableAnswerMachineDetection': True|False,
                    'awaitAnswerMachinePrompt': True|False
                }
            }
        },
        'sms': {
            'capacity': 123.0,
            'outboundMode': {
                'agentless': {}

            },
            'defaultOutboundConfig': {
                'connectSourcePhoneNumberArn': 'string',
                'wisdomTemplateArn': 'string'
            }
        },
        'email': {
            'capacity': 123.0,
            'outboundMode': {
                'agentless': {}

            },
            'defaultOutboundConfig': {
                'connectSourceEmailAddress': 'string',
                'sourceEmailAddressDisplayName': 'string',
                'wisdomTemplateArn': 'string'
            }
        }
    }
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type channelSubtypeConfig:

dict

param channelSubtypeConfig:

[REQUIRED]

Campaign Channel Subtype config

telephony (dict) --

Telephony Channel Subtype config
- capacity (float) --
  
  Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
- 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.
- outboundMode (dict) -- [REQUIRED]
  
  Telephony Outbound Mode
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: progressive, predictive, agentless.
  - progressive (dict) --
    
    Progressive config
    - bandwidthAllocation (float) -- [REQUIRED]
      
      The bandwidth allocation of a queue resource.
  - predictive (dict) --
    
    Predictive config
    - bandwidthAllocation (float) -- [REQUIRED]
      
      The bandwidth allocation of a queue resource.
  - agentless (dict) --
    
    Agentless config
- defaultOutboundConfig (dict) -- [REQUIRED]
  
  Default Telephony Outbound config
  - connectContactFlowId (string) -- [REQUIRED]
    
    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.
  - answerMachineDetectionConfig (dict) --
    
    Answering Machine Detection config
    - enableAnswerMachineDetection (boolean) -- [REQUIRED]
      
      Enable or disable answering machine detection
    - awaitAnswerMachinePrompt (boolean) --
      
      Enable or disable await answer machine prompt
sms (dict) --

SMS Channel Subtype config
- capacity (float) --
  
  Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
- outboundMode (dict) -- [REQUIRED]
  
  SMS Outbound Mode
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: agentless.
  - agentless (dict) --
    
    Agentless config
- defaultOutboundConfig (dict) -- [REQUIRED]
  
  Default SMS Outbound config
  - connectSourcePhoneNumberArn (string) -- [REQUIRED]
    
    Amazon Resource Names(ARN)
  - wisdomTemplateArn (string) -- [REQUIRED]
    
    Amazon Resource Names(ARN)
email (dict) --

Email Channel Subtype config
- capacity (float) --
  
  Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
- outboundMode (dict) -- [REQUIRED]
  
  Email Outbound Mode
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: agentless.
  - agentless (dict) --
    
    Agentless config
- defaultOutboundConfig (dict) -- [REQUIRED]
  
  Default Email Outbound config
  - connectSourceEmailAddress (string) -- [REQUIRED]
    
    Source/Destination Email address used for Email messages
  - sourceEmailAddressDisplayName (string) --
    
    Display name for Email Address
  - wisdomTemplateArn (string) -- [REQUIRED]
    
    Amazon Resource Names(ARN)

returns:

None

DeleteCampaignCommunicationLimits (new)

Link ¶

Deletes the communication limits config for a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.delete_campaign_communication_limits(
    id='string',
    config='ALL_CHANNEL_SUBTYPES'
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type config:

string

param config:

[REQUIRED]

The type of campaign communication limits config.

returns:

None

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

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]

Amazon Resource Names(ARN)

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --

The request for ListTagsForResource API.
- tags (dict) --
  
  Tag map with key and value.
  - (string) --
    
    The key of tag.
    - (string) --
      
      The value of tag.

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',
        'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'failureCode': 'EVENT_BRIDGE_ACCESS_DENIED'|'EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED'|'IAM_ACCESS_DENIED'|'KMS_ACCESS_DENIED'|'KMS_KEY_NOT_FOUND'|'INTERNAL_FAILURE'
    }
}

Response Structure

(dict) --

The response for StartInstanceOnboardingJob API.
- connectInstanceOnboardingJobStatus (dict) --
  
  Instance onboarding job status object
  - connectInstanceId (string) --
    
    Amazon Connect Instance Id
  - status (string) --
    
    Enumeration of the possible states for instance onboarding job
  - failureCode (string) --
    
    Enumeration of the possible failure codes for instance onboarding job

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]

Amazon Resource Names(ARN)

type tags:

dict

param tags:

[REQUIRED]

Tag map with key and value.

(string) --

The key of tag.
- (string) --
  
  The value of tag.

returns:

None

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',
    campaignDeletionPolicy='RETAIN_ALL'|'DELETE_ALL'
)

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

type campaignDeletionPolicy:

string

param campaignDeletionPolicy:

Enumeration of the policies to enact on existing campaigns during instance config deletion

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(
    maxResults=123,
    nextToken='string',
    filters={
        'instanceIdFilter': {
            'value': 'string',
            'operator': 'Eq'
        }
    }
)

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.

type filters:

dict

param filters:

Filter model by type

instanceIdFilter (dict) --

Connect instance identifier filter
- value (string) -- [REQUIRED]
  
  Amazon Connect Instance Id
- operator (string) -- [REQUIRED]
  
  Operators for Connect instance identifier filter

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'campaignSummaryList': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'connectInstanceId': 'string',
            'channelSubtypes': [
                'TELEPHONY'|'SMS'|'EMAIL',
            ],
            'schedule': {
                'startTime': datetime(2015, 1, 1),
                'endTime': datetime(2015, 1, 1),
                'refreshFrequency': 'string'
            },
            'connectCampaignFlowArn': 'string'
        },
    ]
}

Response Structure

(dict) --

The response for ListCampaigns API.
- nextToken (string) --
  
  The token for the next set of results.
- campaignSummaryList (list) --
  
  A list of Amazon Connect campaigns.
  - (dict) --
    
    An Amazon Connect campaign summary.
    - id (string) --
      
      Identifier representing a Campaign
    - arn (string) --
      
      The resource name of an Amazon Connect campaign.
    - name (string) --
      
      The name of an Amazon Connect Campaign name.
    - connectInstanceId (string) --
      
      Amazon Connect Instance Id
    - channelSubtypes (list) --
      
      Channel subtype list
      - (string) --
        
        The type of campaign channel subtype.
    - schedule (dict) --
      
      Campaign schedule
      - startTime (datetime) --
        
        Timestamp with no UTC offset or timezone
      - endTime (datetime) --
        
        Timestamp with no UTC offset or timezone
      - refreshFrequency (string) --
        
        Time duration in ISO 8601 format
    - connectCampaignFlowArn (string) --
      
      Amazon Resource Names(ARN)

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

Response Structure

(dict) --

The response for GetCampaignState API.
- state (string) --
  
  State of a campaign

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

PutOutboundRequestBatch (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.put_outbound_request_batch(
    id='string',
    outboundRequests=[
        {
            'clientToken': 'string',
            'expirationTime': datetime(2015, 1, 1),
            'channelSubtypeParameters': {
                'telephony': {
                    'destinationPhoneNumber': 'string',
                    'attributes': {
                        'string': 'string'
                    },
                    'connectSourcePhoneNumber': 'string',
                    'answerMachineDetectionConfig': {
                        'enableAnswerMachineDetection': True|False,
                        'awaitAnswerMachinePrompt': True|False
                    }
                },
                'sms': {
                    'destinationPhoneNumber': 'string',
                    'connectSourcePhoneNumberArn': 'string',
                    'templateArn': 'string',
                    'templateParameters': {
                        'string': 'string'
                    }
                },
                'email': {
                    'destinationEmailAddress': 'string',
                    'connectSourceEmailAddress': 'string',
                    'templateArn': 'string',
                    'templateParameters': {
                        'string': 'string'
                    }
                }
            }
        },
    ]
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type outboundRequests:

list

param outboundRequests:

[REQUIRED]

A list of outbound requests.

(dict) --

An outbound request for a campaign.
- 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
- channelSubtypeParameters (dict) -- [REQUIRED]
  
  ChannelSubtypeParameters for an outbound request
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: telephony, sms, email.
  - telephony (dict) --
    
    Parameters for the Telephony Channel Subtype
    - destinationPhoneNumber (string) -- [REQUIRED]
      
      The phone number of the customer, in E.164 format.
    - 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.
    - 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.
    - answerMachineDetectionConfig (dict) --
      
      Answering Machine Detection config
      - enableAnswerMachineDetection (boolean) -- [REQUIRED]
        
        Enable or disable answering machine detection
      - awaitAnswerMachinePrompt (boolean) --
        
        Enable or disable await answer machine prompt
  - sms (dict) --
    
    Parameters for the SMS Channel Subtype
    - destinationPhoneNumber (string) -- [REQUIRED]
      
      The phone number of the customer, in E.164 format.
    - connectSourcePhoneNumberArn (string) --
      
      Amazon Resource Names(ARN)
    - templateArn (string) --
      
      Amazon Resource Names(ARN)
    - templateParameters (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.
  - email (dict) --
    
    Parameters for the Email Channel Subtype
    - destinationEmailAddress (string) -- [REQUIRED]
      
      Source/Destination Email address used for Email messages
    - connectSourceEmailAddress (string) --
      
      Source/Destination Email address used for Email messages
    - templateArn (string) --
      
      Amazon Resource Names(ARN)
    - templateParameters (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.

rtype:

dict

returns:

Response Syntax

{
    'successfulRequests': [
        {
            'clientToken': 'string',
            'id': 'string'
        },
    ],
    'failedRequests': [
        {
            'clientToken': 'string',
            'id': 'string',
            'failureCode': 'InvalidInput'|'RequestThrottled'|'UnknownError'|'BufferLimitExceeded'
        },
    ]
}

Response Structure

(dict) --

The response for PutOutboundRequestBatch API.
- 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
- 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.
    - id (string) --
      
      Identifier representing a Dial request
    - failureCode (string) --
      
      A predefined code indicating the error that caused the failure.

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',
        'status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'failureCode': 'EVENT_BRIDGE_ACCESS_DENIED'|'EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED'|'IAM_ACCESS_DENIED'|'KMS_ACCESS_DENIED'|'KMS_KEY_NOT_FOUND'|'INTERNAL_FAILURE'
    }
}

Response Structure

(dict) --

The response for GetInstanceOnboardingJobStatus API.
- connectInstanceOnboardingJobStatus (dict) --
  
  Instance onboarding job status object
  - connectInstanceId (string) --
    
    Amazon Connect Instance Id
  - status (string) --
    
    Enumeration of the possible states for instance onboarding job
  - failureCode (string) --
    
    Enumeration of the possible failure codes for instance onboarding job

UpdateCampaignCommunicationLimits (new)

Link ¶

Updates the communication limits config for a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_communication_limits(
    id='string',
    communicationLimitsOverride={
        'allChannelSubtypes': {
            'communicationLimitsList': [
                {
                    'maxCountPerRecipient': 123,
                    'frequency': 123,
                    'unit': 'DAY'
                },
            ]
        }
    }
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type communicationLimitsOverride:

dict

param communicationLimitsOverride:

[REQUIRED]

Communication limits config

allChannelSubtypes (dict) --

Communication limits

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: communicationLimitsList.
- communicationLimitsList (list) --
  
  List of communication limit
  - (dict) --
    
    Communication Limit
    - maxCountPerRecipient (integer) -- [REQUIRED]
      
      Maximum number of contacts allowed for a given target within the given frequency.
    - frequency (integer) -- [REQUIRED]
      
      The number of days to consider with regards to this limit.
    - unit (string) -- [REQUIRED]
      
      The communication limit time unit.

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

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': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'connectInstanceId': 'string',
        'channelSubtypeConfig': {
            'telephony': {
                'capacity': 123.0,
                'connectQueueId': 'string',
                'outboundMode': {
                    'progressive': {
                        'bandwidthAllocation': 123.0
                    },
                    'predictive': {
                        'bandwidthAllocation': 123.0
                    },
                    'agentless': {}
                },
                'defaultOutboundConfig': {
                    'connectContactFlowId': 'string',
                    'connectSourcePhoneNumber': 'string',
                    'answerMachineDetectionConfig': {
                        'enableAnswerMachineDetection': True|False,
                        'awaitAnswerMachinePrompt': True|False
                    }
                }
            },
            'sms': {
                'capacity': 123.0,
                'outboundMode': {
                    'agentless': {}
                },
                'defaultOutboundConfig': {
                    'connectSourcePhoneNumberArn': 'string',
                    'wisdomTemplateArn': 'string'
                }
            },
            'email': {
                'capacity': 123.0,
                'outboundMode': {
                    'agentless': {}
                },
                'defaultOutboundConfig': {
                    'connectSourceEmailAddress': 'string',
                    'sourceEmailAddressDisplayName': 'string',
                    'wisdomTemplateArn': 'string'
                }
            }
        },
        'source': {
            'customerProfilesSegmentArn': 'string'
        },
        'connectCampaignFlowArn': 'string',
        'schedule': {
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'refreshFrequency': 'string'
        },
        'communicationTimeConfig': {
            'localTimeZoneConfig': {
                'defaultTimeZone': 'string',
                'localTimeZoneDetection': [
                    'ZIP_CODE'|'AREA_CODE',
                ]
            },
            'telephony': {
                'openHours': {
                    'dailyHours': {
                        'string': [
                            {
                                'startTime': 'string',
                                'endTime': 'string'
                            },
                        ]
                    }
                },
                'restrictedPeriods': {
                    'restrictedPeriodList': [
                        {
                            'name': 'string',
                            'startDate': 'string',
                            'endDate': 'string'
                        },
                    ]
                }
            },
            'sms': {
                'openHours': {
                    'dailyHours': {
                        'string': [
                            {
                                'startTime': 'string',
                                'endTime': 'string'
                            },
                        ]
                    }
                },
                'restrictedPeriods': {
                    'restrictedPeriodList': [
                        {
                            'name': 'string',
                            'startDate': 'string',
                            'endDate': 'string'
                        },
                    ]
                }
            },
            'email': {
                'openHours': {
                    'dailyHours': {
                        'string': [
                            {
                                'startTime': 'string',
                                'endTime': 'string'
                            },
                        ]
                    }
                },
                'restrictedPeriods': {
                    'restrictedPeriodList': [
                        {
                            'name': 'string',
                            'startDate': 'string',
                            'endDate': 'string'
                        },
                    ]
                }
            }
        },
        'communicationLimitsOverride': {
            'allChannelSubtypes': {
                'communicationLimitsList': [
                    {
                        'maxCountPerRecipient': 123,
                        'frequency': 123,
                        'unit': 'DAY'
                    },
                ]
            }
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --

The response for DescribeCampaign API.
- campaign (dict) --
  
  An Amazon Connect campaign.
  - id (string) --
    
    Identifier representing a Campaign
  - arn (string) --
    
    The resource name of an Amazon Connect campaign.
  - name (string) --
    
    The name of an Amazon Connect Campaign name.
  - connectInstanceId (string) --
    
    Amazon Connect Instance Id
  - channelSubtypeConfig (dict) --
    
    Campaign Channel Subtype config
    - telephony (dict) --
      
      Telephony Channel Subtype config
      - capacity (float) --
        
        Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
      - 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.
      - outboundMode (dict) --
        
        Telephony Outbound Mode
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: progressive, predictive, agentless. 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'}
        
        progressive (dict) --
        
        Progressive config
        
        bandwidthAllocation (float) --
        
        The bandwidth allocation of a queue resource.
        
        predictive (dict) --
        
        Predictive config
        
        bandwidthAllocation (float) --
        
        The bandwidth allocation of a queue resource.
        
        agentless (dict) --
        
        Agentless config
      - defaultOutboundConfig (dict) --
        
        Default Telephony Outbound config
        
        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.
        
        answerMachineDetectionConfig (dict) --
        
        Answering Machine Detection config
        
        enableAnswerMachineDetection (boolean) --
        
        Enable or disable answering machine detection
        
        awaitAnswerMachinePrompt (boolean) --
        
        Enable or disable await answer machine prompt
    - sms (dict) --
      
      SMS Channel Subtype config
      - capacity (float) --
        
        Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
      - outboundMode (dict) --
        
        SMS Outbound Mode
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: agentless. 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'}
        
        agentless (dict) --
        
        Agentless config
      - defaultOutboundConfig (dict) --
        
        Default SMS Outbound config
        
        connectSourcePhoneNumberArn (string) --
        
        Amazon Resource Names(ARN)
        
        wisdomTemplateArn (string) --
        
        Amazon Resource Names(ARN)
    - email (dict) --
      
      Email Channel Subtype config
      - capacity (float) --
        
        Allocates outbound capacity for the specific channel subtype of this campaign between multiple active campaigns
      - outboundMode (dict) --
        
        Email Outbound Mode
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: agentless. 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'}
        
        agentless (dict) --
        
        Agentless config
      - defaultOutboundConfig (dict) --
        
        Default Email Outbound config
        
        connectSourceEmailAddress (string) --
        
        Source/Destination Email address used for Email messages
        
        sourceEmailAddressDisplayName (string) --
        
        Display name for Email Address
        
        wisdomTemplateArn (string) --
        
        Amazon Resource Names(ARN)
  - source (dict) --
    
    Source of the campaign
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: customerProfilesSegmentArn. 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'}
```
    - customerProfilesSegmentArn (string) --
      
      Amazon Resource Names(ARN)
  - connectCampaignFlowArn (string) --
    
    Amazon Resource Names(ARN)
  - schedule (dict) --
    
    Campaign schedule
    - startTime (datetime) --
      
      Timestamp with no UTC offset or timezone
    - endTime (datetime) --
      
      Timestamp with no UTC offset or timezone
    - refreshFrequency (string) --
      
      Time duration in ISO 8601 format
  - communicationTimeConfig (dict) --
    
    Campaign communication time config
    - localTimeZoneConfig (dict) --
      
      Local time zone config
      - defaultTimeZone (string) --
        
        Time Zone Id in the IANA format
      - localTimeZoneDetection (list) --
        
        Local TimeZone Detection method list
        
        (string) --
        
        Local TimeZone Detection method.
    - telephony (dict) --
      
      Time window config
      - openHours (dict) --
        
        Open Hours config
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: dailyHours. 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'}
        
        dailyHours (dict) --
        
        Daily Hours map
        
        (string) --
        
        Day of week enum
        
        (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) --
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) --
        
        Time in ISO 8601 format, e.g. T23:11
      - restrictedPeriods (dict) --
        
        Restricted period config
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: restrictedPeriodList. 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'}
        
        restrictedPeriodList (list) --
        
        List of restricted period
        
        (dict) --
        
        Restricted period
        
        name (string) --
        
        The name of a restricted period.
        
        startDate (string) --
        
        Date in ISO 8601 format, e.g. 2024-01-01
        
        endDate (string) --
        
        Date in ISO 8601 format, e.g. 2024-01-01
    - sms (dict) --
      
      Time window config
      - openHours (dict) --
        
        Open Hours config
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: dailyHours. 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'}
        
        dailyHours (dict) --
        
        Daily Hours map
        
        (string) --
        
        Day of week enum
        
        (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) --
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) --
        
        Time in ISO 8601 format, e.g. T23:11
      - restrictedPeriods (dict) --
        
        Restricted period config
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: restrictedPeriodList. 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'}
        
        restrictedPeriodList (list) --
        
        List of restricted period
        
        (dict) --
        
        Restricted period
        
        name (string) --
        
        The name of a restricted period.
        
        startDate (string) --
        
        Date in ISO 8601 format, e.g. 2024-01-01
        
        endDate (string) --
        
        Date in ISO 8601 format, e.g. 2024-01-01
    - email (dict) --
      
      Time window config
      - openHours (dict) --
        
        Open Hours config
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: dailyHours. 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'}
        
        dailyHours (dict) --
        
        Daily Hours map
        
        (string) --
        
        Day of week enum
        
        (list) --
        
        List of time range
        
        (dict) --
        
        Time range in 24 hour format
        
        startTime (string) --
        
        Time in ISO 8601 format, e.g. T23:11
        
        endTime (string) --
        
        Time in ISO 8601 format, e.g. T23:11
      - restrictedPeriods (dict) --
        
        Restricted period config
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: restrictedPeriodList. 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'}
        
        restrictedPeriodList (list) --
        
        List of restricted period
        
        (dict) --
        
        Restricted period
        
        name (string) --
        
        The name of a restricted period.
        
        startDate (string) --
        
        Date in ISO 8601 format, e.g. 2024-01-01
        
        endDate (string) --
        
        Date in ISO 8601 format, e.g. 2024-01-01
  - communicationLimitsOverride (dict) --
    
    Communication limits config
    - allChannelSubtypes (dict) --
      
      Communication limits
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: communicationLimitsList. 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'}
      - communicationLimitsList (list) --
        
        List of communication limit
        
        (dict) --
        
        Communication Limit
        
        maxCountPerRecipient (integer) --
        
        Maximum number of contacts allowed for a given target within the given frequency.
        
        frequency (integer) --
        
        The number of days to consider with regards to this limit.
        
        unit (string) --
        
        The communication limit time unit.
  - tags (dict) --
    
    Tag map with key and value.
    - (string) --
      
      The key of tag.
      - (string) --
        
        The value of tag.

UpdateCampaignSchedule (new)

Link ¶

Updates the schedule for a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_schedule(
    id='string',
    schedule={
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'refreshFrequency': 'string'
    }
)

type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type schedule:

dict

param schedule:

[REQUIRED]

Campaign schedule

startTime (datetime) -- [REQUIRED]

Timestamp with no UTC offset or timezone
endTime (datetime) -- [REQUIRED]

Timestamp with no UTC offset or timezone
refreshFrequency (string) --

Time duration in ISO 8601 format

returns:

None