ConnectCampaignServiceV2 ************************ Client ====== class ConnectCampaignServiceV2.Client A low-level client representing AmazonConnectCampaignServiceV2 Provide APIs to create and manage Amazon Connect Campaigns. import boto3 client = boto3.client('connectcampaignsv2') These are the available methods: * can_paginate * close * create_campaign * delete_campaign * delete_campaign_channel_subtype_config * delete_campaign_communication_limits * delete_campaign_communication_time * delete_connect_instance_config * delete_connect_instance_integration * delete_instance_onboarding_job * describe_campaign * get_campaign_state * get_campaign_state_batch * get_connect_instance_config * get_instance_communication_limits * get_instance_onboarding_job_status * get_paginator * get_waiter * list_campaigns * list_connect_instance_integrations * list_tags_for_resource * pause_campaign * put_connect_instance_integration * put_instance_communication_limits * put_outbound_request_batch * put_profile_outbound_request_batch * resume_campaign * start_campaign * start_instance_onboarding_job * stop_campaign * tag_resource * untag_resource * update_campaign_channel_subtype_config * update_campaign_communication_limits * update_campaign_communication_time * update_campaign_flow_association * update_campaign_name * update_campaign_schedule * update_campaign_source Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListCampaigns * ListConnectInstanceIntegrations ConnectCampaignServiceV2 / Paginator / ListCampaigns ListCampaigns ************* class ConnectCampaignServiceV2.Paginator.ListCampaigns paginator = client.get_paginator('list_campaigns') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectCampaignServiceV2.Client.list_campaigns()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters={ 'instanceIdFilter': { 'value': 'string', 'operator': 'Eq' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **filters** (*dict*) -- 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 * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'campaignSummaryList': [ { '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' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response for ListCampaigns API. * **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) * **NextToken** *(string) --* A token to resume pagination. ConnectCampaignServiceV2 / Paginator / ListConnectInstanceIntegrations ListConnectInstanceIntegrations ******************************* class ConnectCampaignServiceV2.Paginator.ListConnectInstanceIntegrations paginator = client.get_paginator('list_connect_instance_integrations') paginate(**kwargs) Creates an iterator that will paginate through responses from " ConnectCampaignServiceV2.Client.list_connect_instance_integrati ons()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( connectInstanceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'integrationSummaryList': [ { 'customerProfiles': { 'domainArn': 'string', 'objectTypeNames': { 'string': 'string' } }, 'qConnect': { 'knowledgeBaseArn': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response for ListConnectInstanceIntegrations API. * **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) * **NextToken** *(string) --* A token to resume pagination. ConnectCampaignServiceV2 / Client / delete_instance_onboarding_job delete_instance_onboarding_job ****************************** ConnectCampaignServiceV2.Client.delete_instance_onboarding_job(**kwargs) Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.delete_instance_onboarding_job( connectInstanceId='string' ) Parameters: **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.InvalidStateExceptio n" ConnectCampaignServiceV2 / Client / pause_campaign pause_campaign ************** ConnectCampaignServiceV2.Client.pause_campaign(**kwargs) Pauses a campaign for the specified Amazon Connect account. See also: AWS API Documentation **Request Syntax** response = client.pause_campaign( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / get_paginator get_paginator ************* ConnectCampaignServiceV2.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. ConnectCampaignServiceV2 / Client / put_instance_communication_limits put_instance_communication_limits ********************************* ConnectCampaignServiceV2.Client.put_instance_communication_limits(**kwargs) Put the instance communication limits. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.put_instance_communication_limits( connectInstanceId='string', communicationLimitsConfig={ 'allChannelSubtypes': { 'communicationLimitsList': [ { 'maxCountPerRecipient': 123, 'frequency': 123, 'unit': 'DAY' }, ] } } ) Parameters: * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **communicationLimitsConfig** (*dict*) -- **[REQUIRED]** Instance 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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / can_paginate can_paginate ************ ConnectCampaignServiceV2.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. ConnectCampaignServiceV2 / Client / update_campaign_communication_time update_campaign_communication_time ********************************** ConnectCampaignServiceV2.Client.update_campaign_communication_time(**kwargs) Updates the communication time config for a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = 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' }, ] } } } ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **communicationTimeConfig** (*dict*) -- **[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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / update_campaign_flow_association update_campaign_flow_association ******************************** ConnectCampaignServiceV2.Client.update_campaign_flow_association(**kwargs) Updates the campaign flow associated with a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.update_campaign_flow_association( id='string', connectCampaignFlowArn='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **connectCampaignFlowArn** (*string*) -- **[REQUIRED]** Amazon Resource Names(ARN) Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / get_campaign_state get_campaign_state ****************** ConnectCampaignServiceV2.Client.get_campaign_state(**kwargs) Get state of a campaign for the specified Amazon Connect account. See also: AWS API Documentation **Request Syntax** response = client.get_campaign_state( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign Return type: dict Returns: **Response Syntax** { 'state': 'Initialized'|'Running'|'Paused'|'Stopped'|'Failed'|'Completed' } **Response Structure** * *(dict) --* The response for GetCampaignState API. * **state** *(string) --* State of a campaign **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / get_connect_instance_config get_connect_instance_config *************************** ConnectCampaignServiceV2.Client.get_connect_instance_config(**kwargs) Get the specific Connect instance config. See also: AWS API Documentation **Request Syntax** response = client.get_connect_instance_config( connectInstanceId='string' ) Parameters: **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id Return type: dict Returns: **Response Syntax** { 'connectInstanceConfig': { 'connectInstanceId': 'string', '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. **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / describe_campaign describe_campaign ***************** ConnectCampaignServiceV2.Client.describe_campaign(**kwargs) Describes the specific campaign. See also: AWS API Documentation **Request Syntax** response = client.describe_campaign( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign Return type: dict Returns: **Response Syntax** { 'campaign': { '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', 'eventTrigger': { 'customerProfilesDomainArn': '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' }, ] }, 'instanceLimitsHandling': 'OPT_IN'|'OPT_OUT' }, '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", "eventTrigger". 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) * **eventTrigger** *(dict) --* Event trigger of the campaign * **customerProfilesDomainArn** *(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. * **instanceLimitsHandling** *(string) --* Instance limits handling * **tags** *(dict) --* Tag map with key and value. * *(string) --* The key of tag. * *(string) --* The value of tag. **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / delete_campaign_channel_subtype_config delete_campaign_channel_subtype_config ************************************** ConnectCampaignServiceV2.Client.delete_campaign_channel_subtype_config(**kwargs) Deletes the channel subtype config of a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.delete_campaign_channel_subtype_config( id='string', channelSubtype='TELEPHONY'|'SMS'|'EMAIL' ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **channelSubtype** (*string*) -- **[REQUIRED]** The type of campaign channel subtype. Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / delete_campaign_communication_limits delete_campaign_communication_limits ************************************ ConnectCampaignServiceV2.Client.delete_campaign_communication_limits(**kwargs) Deletes the communication limits config for a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.delete_campaign_communication_limits( id='string', config='ALL_CHANNEL_SUBTYPES' ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **config** (*string*) -- **[REQUIRED]** The type of campaign communication limits config. Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / update_campaign_name update_campaign_name ******************** ConnectCampaignServiceV2.Client.update_campaign_name(**kwargs) Updates the name of a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.update_campaign_name( id='string', name='string' ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **name** (*string*) -- **[REQUIRED]** The name of an Amazon Connect Campaign name. Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / get_instance_communication_limits get_instance_communication_limits ********************************* ConnectCampaignServiceV2.Client.get_instance_communication_limits(**kwargs) Get the instance communication limits. See also: AWS API Documentation **Request Syntax** response = client.get_instance_communication_limits( connectInstanceId='string' ) Parameters: **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id Return type: dict Returns: **Response Syntax** { 'communicationLimitsConfig': { 'allChannelSubtypes': { 'communicationLimitsList': [ { 'maxCountPerRecipient': 123, 'frequency': 123, 'unit': 'DAY' }, ] } } } **Response Structure** * *(dict) --* The response for GetInstanceCommunicationLimits API. * **communicationLimitsConfig** *(dict) --* Instance 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. **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / list_tags_for_resource list_tags_for_resource ********************** ConnectCampaignServiceV2.Client.list_tags_for_resource(**kwargs) List tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** Amazon Resource Names(ARN) Return type: 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. **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / get_campaign_state_batch get_campaign_state_batch ************************ ConnectCampaignServiceV2.Client.get_campaign_state_batch(**kwargs) Get state of campaigns for the specified Amazon Connect account. See also: AWS API Documentation **Request Syntax** response = client.get_campaign_state_batch( campaignIds=[ 'string', ] ) Parameters: **campaignIds** (*list*) -- **[REQUIRED]** List of CampaignId * *(string) --* Identifier representing a Campaign Return type: dict Returns: **Response Syntax** { '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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / put_connect_instance_integration put_connect_instance_integration ******************************** ConnectCampaignServiceV2.Client.put_connect_instance_integration(**kwargs) Put or update the integration for the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.put_connect_instance_integration( connectInstanceId='string', integrationConfig={ 'customerProfiles': { 'domainArn': 'string', 'objectTypeNames': { 'string': 'string' } }, 'qConnect': { 'knowledgeBaseArn': 'string' } } ) Parameters: * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **integrationConfig** (*dict*) -- **[REQUIRED]** Integration config for Connect Instance Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customerProfiles", "qConnect". * **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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / start_instance_onboarding_job start_instance_onboarding_job ***************************** ConnectCampaignServiceV2.Client.start_instance_onboarding_job(**kwargs) Onboard the specific Amazon Connect instance to Connect Campaigns. See also: AWS API Documentation **Request Syntax** response = client.start_instance_onboarding_job( connectInstanceId='string', encryptionConfig={ 'enabled': True|False, 'encryptionType': 'KMS', 'keyArn': 'string' } ) Parameters: * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **encryptionConfig** (*dict*) -- **[REQUIRED]** Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported * **enabled** *(boolean) --* **[REQUIRED]** Boolean to indicate if custom encryption has been enabled. * **encryptionType** *(string) --* Server-side encryption type. * **keyArn** *(string) --* KMS key id/arn for encryption config. Return type: dict Returns: **Response Syntax** { 'connectInstanceOnboardingJobStatus': { 'connectInstanceId': 'string', '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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / untag_resource untag_resource ************** ConnectCampaignServiceV2.Client.untag_resource(**kwargs) Untag a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( arn='string', tagKeys=[ 'string', ] ) Parameters: * **arn** (*string*) -- **[REQUIRED]** Amazon Resource Names(ARN) * **tagKeys** (*list*) -- **[REQUIRED]** List of tag keys. * *(string) --* The key of tag. Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / create_campaign create_campaign *************** ConnectCampaignServiceV2.Client.create_campaign(**kwargs) Creates a campaign for the specified Amazon Connect account. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.create_campaign( 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', 'eventTrigger': { 'customerProfilesDomainArn': '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' }, ] }, 'instanceLimitsHandling': 'OPT_IN'|'OPT_OUT' }, tags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of an Amazon Connect Campaign name. * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **channelSubtypeConfig** (*dict*) -- **[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) * **source** (*dict*) -- Source of the campaign Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customerProfilesSegmentArn", "eventTrigger". * **customerProfilesSegmentArn** *(string) --* Amazon Resource Names(ARN) * **eventTrigger** *(dict) --* Event trigger of the campaign * **customerProfilesDomainArn** *(string) --* Amazon Resource Names(ARN) * **connectCampaignFlowArn** (*string*) -- Amazon Resource Names(ARN) * **schedule** (*dict*) -- 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 * **communicationTimeConfig** (*dict*) -- 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 * **communicationLimitsOverride** (*dict*) -- 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. * **instanceLimitsHandling** *(string) --* Instance limits handling * **tags** (*dict*) -- Tag map with key and value. * *(string) --* The key of tag. * *(string) --* The value of tag. Return type: 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. **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ServiceQuotaExceeded Exception" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / get_waiter get_waiter ********** ConnectCampaignServiceV2.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" ConnectCampaignServiceV2 / Client / start_campaign start_campaign ************** ConnectCampaignServiceV2.Client.start_campaign(**kwargs) Starts a campaign for the specified Amazon Connect account. See also: AWS API Documentation **Request Syntax** response = client.start_campaign( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / put_outbound_request_batch put_outbound_request_batch ************************** ConnectCampaignServiceV2.Client.put_outbound_request_batch(**kwargs) Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = 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' } } } }, ] ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **outboundRequests** (*list*) -- **[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. Return type: 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. **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / delete_connect_instance_integration delete_connect_instance_integration *********************************** ConnectCampaignServiceV2.Client.delete_connect_instance_integration(**kwargs) Delete the integration for the specified Amazon Connect instance. See also: AWS API Documentation **Request Syntax** response = client.delete_connect_instance_integration( connectInstanceId='string', integrationIdentifier={ 'customerProfiles': { 'domainArn': 'string' }, 'qConnect': { 'knowledgeBaseArn': 'string' } } ) Parameters: * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **integrationIdentifier** (*dict*) -- **[REQUIRED]** Integration identifier for Connect instance Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customerProfiles", "qConnect". * **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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / update_campaign_communication_limits update_campaign_communication_limits ************************************ ConnectCampaignServiceV2.Client.update_campaign_communication_limits(**kwargs) Updates the communication limits config for a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.update_campaign_communication_limits( id='string', communicationLimitsOverride={ 'allChannelSubtypes': { 'communicationLimitsList': [ { 'maxCountPerRecipient': 123, 'frequency': 123, 'unit': 'DAY' }, ] }, 'instanceLimitsHandling': 'OPT_IN'|'OPT_OUT' } ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **communicationLimitsOverride** (*dict*) -- **[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. * **instanceLimitsHandling** *(string) --* Instance limits handling Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / update_campaign_source update_campaign_source ********************** ConnectCampaignServiceV2.Client.update_campaign_source(**kwargs) Updates the campaign source with a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.update_campaign_source( id='string', source={ 'customerProfilesSegmentArn': 'string', 'eventTrigger': { 'customerProfilesDomainArn': 'string' } } ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **source** (*dict*) -- **[REQUIRED]** Source of the campaign Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customerProfilesSegmentArn", "eventTrigger". * **customerProfilesSegmentArn** *(string) --* Amazon Resource Names(ARN) * **eventTrigger** *(dict) --* Event trigger of the campaign * **customerProfilesDomainArn** *(string) --* Amazon Resource Names(ARN) Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / put_profile_outbound_request_batch put_profile_outbound_request_batch ********************************** ConnectCampaignServiceV2.Client.put_profile_outbound_request_batch(**kwargs) Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.put_profile_outbound_request_batch( id='string', profileOutboundRequests=[ { 'clientToken': 'string', 'profileId': 'string', 'expirationTime': datetime(2015, 1, 1) }, ] ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **profileOutboundRequests** (*list*) -- **[REQUIRED]** List of profile outbound requests * *(dict) --* Information about a profile outbound request * **clientToken** *(string) --* **[REQUIRED]** Client provided parameter used for idempotency. Its value must be unique for each request. * **profileId** *(string) --* **[REQUIRED]** Identifier of the customer profile * **expirationTime** *(datetime) --* Timestamp with no UTC offset or timezone Return type: dict Returns: **Response Syntax** { 'successfulRequests': [ { 'clientToken': 'string', 'id': 'string' }, ], 'failedRequests': [ { 'clientToken': 'string', 'id': 'string', 'failureCode': 'UnknownError'|'ResourceNotFound'|'Conflict'|'RequestThrottled'|'InvalidInput' }, ] } **Response Structure** * *(dict) --* The response for PutProfileOutboundRequestBatch API * **successfulRequests** *(list) --* List of successful profile outbound requests * *(dict) --* Success details for a profile outbound request * **clientToken** *(string) --* Client provided parameter used for idempotency. Its value must be unique for each request. * **id** *(string) --* Identifier of the profile outbound request * **failedRequests** *(list) --* List of failed profile outbound requests * *(dict) --* Failure details for a profile outbound request * **clientToken** *(string) --* Client provided parameter used for idempotency. Its value must be unique for each request. * **id** *(string) --* Identifier of the profile outbound request * **failureCode** *(string) --* Predefined code indicating the error that caused the failure **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / delete_connect_instance_config delete_connect_instance_config ****************************** ConnectCampaignServiceV2.Client.delete_connect_instance_config(**kwargs) Deletes a connect instance config from the specified AWS account. See also: AWS API Documentation **Request Syntax** response = client.delete_connect_instance_config( connectInstanceId='string', campaignDeletionPolicy='RETAIN_ALL'|'DELETE_ALL' ) Parameters: * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **campaignDeletionPolicy** (*string*) -- Enumeration of the policies to enact on existing campaigns during instance config deletion Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.InvalidStateExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / close close ***** ConnectCampaignServiceV2.Client.close() Closes underlying endpoint connections. ConnectCampaignServiceV2 / Client / get_instance_onboarding_job_status get_instance_onboarding_job_status ********************************** ConnectCampaignServiceV2.Client.get_instance_onboarding_job_status(**kwargs) Get the specific instance onboarding job status. See also: AWS API Documentation **Request Syntax** response = client.get_instance_onboarding_job_status( connectInstanceId='string' ) Parameters: **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id Return type: dict Returns: **Response Syntax** { 'connectInstanceOnboardingJobStatus': { 'connectInstanceId': 'string', '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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / list_campaigns list_campaigns ************** ConnectCampaignServiceV2.Client.list_campaigns(**kwargs) Provides summary information about the campaigns under the specified Amazon Connect account. See also: AWS API Documentation **Request Syntax** response = client.list_campaigns( maxResults=123, nextToken='string', filters={ 'instanceIdFilter': { 'value': 'string', 'operator': 'Eq' } } ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*string*) -- The token for the next set of results. * **filters** (*dict*) -- 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 Return type: 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) **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / update_campaign_channel_subtype_config update_campaign_channel_subtype_config ************************************** ConnectCampaignServiceV2.Client.update_campaign_channel_subtype_config(**kwargs) Updates the channel subtype config of a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = 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' } } } ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **channelSubtypeConfig** (*dict*) -- **[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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / list_connect_instance_integrations list_connect_instance_integrations ********************************** ConnectCampaignServiceV2.Client.list_connect_instance_integrations(**kwargs) Provides summary information about the integration under the specified Connect instance. See also: AWS API Documentation **Request Syntax** response = client.list_connect_instance_integrations( connectInstanceId='string', maxResults=123, nextToken='string' ) Parameters: * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*string*) -- The token for the next set of results. Return type: dict Returns: **Response Syntax** { '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) **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / resume_campaign resume_campaign *************** ConnectCampaignServiceV2.Client.resume_campaign(**kwargs) Stops a campaign for the specified Amazon Connect account. See also: AWS API Documentation **Request Syntax** response = client.resume_campaign( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / update_campaign_schedule update_campaign_schedule ************************ ConnectCampaignServiceV2.Client.update_campaign_schedule(**kwargs) Updates the schedule for a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.update_campaign_schedule( id='string', schedule={ 'startTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'refreshFrequency': 'string' } ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **schedule** (*dict*) -- **[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 **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / tag_resource tag_resource ************ ConnectCampaignServiceV2.Client.tag_resource(**kwargs) Tag a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( arn='string', tags={ 'string': 'string' } ) Parameters: * **arn** (*string*) -- **[REQUIRED]** Amazon Resource Names(ARN) * **tags** (*dict*) -- **[REQUIRED]** Tag map with key and value. * *(string) --* The key of tag. * *(string) --* The value of tag. Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / delete_campaign_communication_time delete_campaign_communication_time ********************************** ConnectCampaignServiceV2.Client.delete_campaign_communication_time(**kwargs) Deletes the communication time config for a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.delete_campaign_communication_time( id='string', config='TELEPHONY'|'SMS'|'EMAIL' ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **config** (*string*) -- **[REQUIRED]** The type of campaign communication time config Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" ConnectCampaignServiceV2 / Client / stop_campaign stop_campaign ************* ConnectCampaignServiceV2.Client.stop_campaign(**kwargs) Stops a campaign for the specified Amazon Connect account. See also: AWS API Documentation **Request Syntax** response = client.stop_campaign( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.ConflictException" * "ConnectCampaignServiceV2.Client.exceptions.InvalidCampaignState Exception" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n" * "ConnectCampaignServiceV2.Client.exceptions.ThrottlingException" ConnectCampaignServiceV2 / Client / delete_campaign delete_campaign *************** ConnectCampaignServiceV2.Client.delete_campaign(**kwargs) Deletes a campaign from the specified Amazon Connect account. See also: AWS API Documentation **Request Syntax** response = client.delete_campaign( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign Returns: None **Exceptions** * "ConnectCampaignServiceV2.Client.exceptions.InternalServerExcept ion" * "ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundExce ption" * "ConnectCampaignServiceV2.Client.exceptions.ValidationException" * "ConnectCampaignServiceV2.Client.exceptions.AccessDeniedExceptio n"