ConnectCampaignService ********************** Client ====== class ConnectCampaignService.Client A low-level client representing AmazonConnectCampaignService Provide APIs to create and manage Amazon Connect Campaigns. import boto3 client = boto3.client('connectcampaigns') These are the available methods: * can_paginate * close * create_campaign * delete_campaign * delete_connect_instance_config * delete_instance_onboarding_job * describe_campaign * get_campaign_state * get_campaign_state_batch * get_connect_instance_config * get_instance_onboarding_job_status * get_paginator * get_waiter * list_campaigns * list_tags_for_resource * pause_campaign * put_dial_request_batch * resume_campaign * start_campaign * start_instance_onboarding_job * stop_campaign * tag_resource * untag_resource * update_campaign_dialer_config * update_campaign_name * update_campaign_outbound_call_config 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 ConnectCampaignService / Paginator / ListCampaigns ListCampaigns ************* class ConnectCampaignService.Paginator.ListCampaigns paginator = client.get_paginator('list_campaigns') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectCampaignService.Client.list_campaigns()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( filters={ 'instanceIdFilter': { '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' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* ListCampaignsResponse * **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 * **NextToken** *(string) --* A token to resume pagination. ConnectCampaignService / Client / delete_instance_onboarding_job delete_instance_onboarding_job ****************************** ConnectCampaignService.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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.InvalidStateException" ConnectCampaignService / Client / pause_campaign pause_campaign ************** ConnectCampaignService.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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.InvalidCampaignStateEx ception" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / get_paginator get_paginator ************* ConnectCampaignService.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. ConnectCampaignService / Client / update_campaign_outbound_call_config update_campaign_outbound_call_config ************************************ ConnectCampaignService.Client.update_campaign_outbound_call_config(**kwargs) Updates the outbound call config of a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.update_campaign_outbound_call_config( id='string', connectContactFlowId='string', connectSourcePhoneNumber='string', answerMachineDetectionConfig={ 'enableAnswerMachineDetection': True|False, 'awaitAnswerMachinePrompt': True|False } ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **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) --* **[REQUIRED]** Enable or disable answering machine detection * **awaitAnswerMachinePrompt** *(boolean) --* Enable or disable await answer machine prompt Returns: None **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / can_paginate can_paginate ************ ConnectCampaignService.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. ConnectCampaignService / Client / get_campaign_state get_campaign_state ****************** ConnectCampaignService.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' } **Response Structure** * *(dict) --* GetCampaignStateResponse * **state** *(string) --* State of a campaign **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / get_connect_instance_config get_connect_instance_config *************************** ConnectCampaignService.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) --* GetConnectInstanceConfigResponse * **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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" ConnectCampaignService / Client / describe_campaign describe_campaign ***************** ConnectCampaignService.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', 'dialerConfig': { 'progressiveDialerConfig': { 'bandwidthAllocation': 123.0, 'dialingCapacity': 123.0 }, 'predictiveDialerConfig': { 'bandwidthAllocation': 123.0, 'dialingCapacity': 123.0 }, 'agentlessDialerConfig': { 'dialingCapacity': 123.0 } }, 'outboundCallConfig': { 'connectContactFlowId': 'string', 'connectSourcePhoneNumber': 'string', 'connectQueueId': 'string', 'answerMachineDetectionConfig': { 'enableAnswerMachineDetection': True|False, 'awaitAnswerMachinePrompt': True|False } }, 'tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* DescribeCampaignResponse * **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 * **dialerConfig** *(dict) --* The possible types of dialer config parameters Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "progressiveDialerConfig", "predictiveDialerConfig", "agentlessDialerConfig". 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'} * **progressiveDialerConfig** *(dict) --* Progressive Dialer config * **bandwidthAllocation** *(float) --* The bandwidth allocation of a queue resource. * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns * **predictiveDialerConfig** *(dict) --* Predictive Dialer config * **bandwidthAllocation** *(float) --* The bandwidth allocation of a queue resource. * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns * **agentlessDialerConfig** *(dict) --* Agentless Dialer config * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns * **outboundCallConfig** *(dict) --* The configuration used for outbound calls. * **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. * **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. * **answerMachineDetectionConfig** *(dict) --* Answering Machine Detection config * **enableAnswerMachineDetection** *(boolean) --* Enable or disable answering machine detection * **awaitAnswerMachinePrompt** *(boolean) --* Enable or disable await answer machine prompt * **tags** *(dict) --* Tag map with key and value. * *(string) --* Tag key. * *(string) --* Tag value. **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" ConnectCampaignService / Client / update_campaign_name update_campaign_name ******************** ConnectCampaignService.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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" ConnectCampaignService / Client / list_tags_for_resource list_tags_for_resource ********************** ConnectCampaignService.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]** Arn Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* ListTagsForResponse * **tags** *(dict) --* Tag map with key and value. * *(string) --* Tag key. * *(string) --* Tag value. **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / get_campaign_state_batch get_campaign_state_batch ************************ ConnectCampaignService.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' }, ], 'failedRequests': [ { 'campaignId': 'string', 'failureCode': 'ResourceNotFound'|'UnknownError' }, ] } **Response Structure** * *(dict) --* GetCampaignStateBatchResponse * **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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / start_instance_onboarding_job start_instance_onboarding_job ***************************** ConnectCampaignService.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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / untag_resource untag_resource ************** ConnectCampaignService.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]** Arn * **tagKeys** (*list*) -- **[REQUIRED]** List of tag keys. * *(string) --* Tag key. Returns: None **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / create_campaign create_campaign *************** ConnectCampaignService.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', dialerConfig={ 'progressiveDialerConfig': { 'bandwidthAllocation': 123.0, 'dialingCapacity': 123.0 }, 'predictiveDialerConfig': { 'bandwidthAllocation': 123.0, 'dialingCapacity': 123.0 }, 'agentlessDialerConfig': { 'dialingCapacity': 123.0 } }, outboundCallConfig={ 'connectContactFlowId': 'string', 'connectSourcePhoneNumber': 'string', 'connectQueueId': 'string', 'answerMachineDetectionConfig': { 'enableAnswerMachineDetection': True|False, 'awaitAnswerMachinePrompt': True|False } }, tags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of an Amazon Connect Campaign name. * **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id * **dialerConfig** (*dict*) -- **[REQUIRED]** The possible types of dialer config parameters Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "progressiveDialerConfig", "predictiveDialerConfig", "agentlessDialerConfig". * **progressiveDialerConfig** *(dict) --* Progressive Dialer config * **bandwidthAllocation** *(float) --* **[REQUIRED]** The bandwidth allocation of a queue resource. * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns * **predictiveDialerConfig** *(dict) --* Predictive Dialer config * **bandwidthAllocation** *(float) --* **[REQUIRED]** The bandwidth allocation of a queue resource. * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns * **agentlessDialerConfig** *(dict) --* Agentless Dialer config * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns * **outboundCallConfig** (*dict*) -- **[REQUIRED]** The configuration used for outbound calls. * **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. * **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. * **answerMachineDetectionConfig** *(dict) --* Answering Machine Detection config * **enableAnswerMachineDetection** *(boolean) --* **[REQUIRED]** Enable or disable answering machine detection * **awaitAnswerMachinePrompt** *(boolean) --* Enable or disable await answer machine prompt * **tags** (*dict*) -- Tag map with key and value. * *(string) --* Tag key. * *(string) --* Tag value. 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) --* Tag key. * *(string) --* Tag value. **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ServiceQuotaExceededEx ception" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / get_waiter get_waiter ********** ConnectCampaignService.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" ConnectCampaignService / Client / start_campaign start_campaign ************** ConnectCampaignService.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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.InvalidCampaignStateEx ception" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / delete_connect_instance_config delete_connect_instance_config ****************************** ConnectCampaignService.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' ) Parameters: **connectInstanceId** (*string*) -- **[REQUIRED]** Amazon Connect Instance Id Returns: None **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.InvalidStateException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / close close ***** ConnectCampaignService.Client.close() Closes underlying endpoint connections. ConnectCampaignService / Client / update_campaign_dialer_config update_campaign_dialer_config ***************************** ConnectCampaignService.Client.update_campaign_dialer_config(**kwargs) Updates the dialer config of a campaign. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.update_campaign_dialer_config( id='string', dialerConfig={ 'progressiveDialerConfig': { 'bandwidthAllocation': 123.0, 'dialingCapacity': 123.0 }, 'predictiveDialerConfig': { 'bandwidthAllocation': 123.0, 'dialingCapacity': 123.0 }, 'agentlessDialerConfig': { 'dialingCapacity': 123.0 } } ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **dialerConfig** (*dict*) -- **[REQUIRED]** The possible types of dialer config parameters Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "progressiveDialerConfig", "predictiveDialerConfig", "agentlessDialerConfig". * **progressiveDialerConfig** *(dict) --* Progressive Dialer config * **bandwidthAllocation** *(float) --* **[REQUIRED]** The bandwidth allocation of a queue resource. * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns * **predictiveDialerConfig** *(dict) --* Predictive Dialer config * **bandwidthAllocation** *(float) --* **[REQUIRED]** The bandwidth allocation of a queue resource. * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns * **agentlessDialerConfig** *(dict) --* Agentless Dialer config * **dialingCapacity** *(float) --* Allocates dialing capacity for this campaign between multiple active campaigns Returns: None **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" ConnectCampaignService / Client / get_instance_onboarding_job_status get_instance_onboarding_job_status ********************************** ConnectCampaignService.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) --* GetInstanceOnboardingJobStatusResponse * **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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" ConnectCampaignService / Client / list_campaigns list_campaigns ************** ConnectCampaignService.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' }, ] } **Response Structure** * *(dict) --* ListCampaignsResponse * **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 **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" ConnectCampaignService / Client / resume_campaign resume_campaign *************** ConnectCampaignService.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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.InvalidCampaignStateEx ception" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / tag_resource tag_resource ************ ConnectCampaignService.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]** Arn * **tags** (*dict*) -- **[REQUIRED]** Tag map with key and value. * *(string) --* Tag key. * *(string) --* Tag value. Returns: None **Exceptions** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / put_dial_request_batch put_dial_request_batch ********************** ConnectCampaignService.Client.put_dial_request_batch(**kwargs) Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent. See also: AWS API Documentation **Request Syntax** response = client.put_dial_request_batch( id='string', dialRequests=[ { 'clientToken': 'string', 'phoneNumber': 'string', 'expirationTime': datetime(2015, 1, 1), 'attributes': { 'string': 'string' } }, ] ) Parameters: * **id** (*string*) -- **[REQUIRED]** Identifier representing a Campaign * **dialRequests** (*list*) -- **[REQUIRED]** A list of dial requests. * *(dict) --* A dial request for a campaign. * **clientToken** *(string) --* **[REQUIRED]** Client provided parameter used for idempotency. Its value must be unique for each request. * **phoneNumber** *(string) --* **[REQUIRED]** The phone number of the customer, in E.164 format. * **expirationTime** *(datetime) --* **[REQUIRED]** Timestamp with no UTC offset or timezone * **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. Return type: dict Returns: **Response Syntax** { 'successfulRequests': [ { 'clientToken': 'string', 'id': 'string' }, ], 'failedRequests': [ { 'clientToken': 'string', 'id': 'string', 'failureCode': 'InvalidInput'|'RequestThrottled'|'UnknownError' }, ] } **Response Structure** * *(dict) --* PutDialRequestBatchResponse * **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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.InvalidCampaignStateEx ception" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / stop_campaign stop_campaign ************* ConnectCampaignService.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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.ConflictException" * "ConnectCampaignService.Client.exceptions.InvalidCampaignStateEx ception" * "ConnectCampaignService.Client.exceptions.AccessDeniedException" * "ConnectCampaignService.Client.exceptions.ThrottlingException" ConnectCampaignService / Client / delete_campaign delete_campaign *************** ConnectCampaignService.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** * "ConnectCampaignService.Client.exceptions.InternalServerExceptio n" * "ConnectCampaignService.Client.exceptions.ResourceNotFoundExcept ion" * "ConnectCampaignService.Client.exceptions.ValidationException" * "ConnectCampaignService.Client.exceptions.AccessDeniedException"