:doc:`ConnectCampaignService <../../connectcampaigns>` / Client / describe_campaign

*****************
describe_campaign
*****************



.. py:method:: ConnectCampaignService.Client.describe_campaign(**kwargs)

  

  Describes the specific campaign.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/DescribeCampaign>`_  


  **Request Syntax**
  ::

    response = client.describe_campaign(
        id='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    Identifier representing a Campaign

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'campaign': {
              'id': 'string',
              'arn': 'string',
              'name': 'string',
              'connectInstanceId': 'string',
              '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**
  
  *   :py:class:`ConnectCampaignService.Client.exceptions.InternalServerException`

  
  *   :py:class:`ConnectCampaignService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ConnectCampaignService.Client.exceptions.ValidationException`

  
  *   :py:class:`ConnectCampaignService.Client.exceptions.AccessDeniedException`

  