:doc:`ConnectCampaignServiceV2 <../../connectcampaignsv2>` / Client / get_campaign_state_batch

************************
get_campaign_state_batch
************************



.. py:method:: ConnectCampaignServiceV2.Client.get_campaign_state_batch(**kwargs)

  

  Get state of campaigns for the specified Amazon Connect account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetCampaignStateBatch>`_  


  **Request Syntax**
  ::

    response = client.get_campaign_state_batch(
        campaignIds=[
            'string',
        ]
    )
    
  :type campaignIds: list
  :param campaignIds: **[REQUIRED]** 

    List of CampaignId

    

  
    - *(string) --* 

      Identifier representing a Campaign

      

    

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

    
    ::

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

    

    - *(dict) --* 

      The response for GetCampaignStateBatch API.

      
      

      - **successfulRequests** *(list) --* 

        List of successful response of campaign state

        
        

        - *(dict) --* 

          Successful response of campaign state

          
          

          - **campaignId** *(string) --* 

            Identifier representing a Campaign

            
          

          - **state** *(string) --* 

            State of a campaign

            
      
    
      

      - **failedRequests** *(list) --* 

        List of failed requests of campaign state

        
        

        - *(dict) --* 

          Failed response of campaign state

          
          

          - **campaignId** *(string) --* 

            Identifier representing a Campaign

            
          

          - **failureCode** *(string) --* 

            A predefined code indicating the error that caused the failure in getting state of campaigns

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ConnectCampaignServiceV2.Client.exceptions.InternalServerException`

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

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

  
  *   :py:class:`ConnectCampaignServiceV2.Client.exceptions.ThrottlingException`

  