:doc:`Pinpoint <../../pinpoint>` / Client / get_journey_runs

****************
get_journey_runs
****************



.. py:method:: Pinpoint.Client.get_journey_runs(**kwargs)

  

  Provides information about the runs of a journey.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/GetJourneyRuns>`_  


  **Request Syntax**
  ::

    response = client.get_journey_runs(
        ApplicationId='string',
        JourneyId='string',
        PageSize='string',
        Token='string'
    )
    
  :type ApplicationId: string
  :param ApplicationId: **[REQUIRED]** 

    The unique identifier for the application. This identifier is displayed as the **Project ID** on the Amazon Pinpoint console.

    

  
  :type JourneyId: string
  :param JourneyId: **[REQUIRED]** 

    The unique identifier for the journey.

    

  
  :type PageSize: string
  :param PageSize: 

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

    

  
  :type Token: string
  :param Token: 

    The NextToken string that specifies which page of results to return in a paginated response.

    

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

    
    ::

      {
          'JourneyRunsResponse': {
              'Item': [
                  {
                      'CreationTime': 'string',
                      'LastUpdateTime': 'string',
                      'RunId': 'string',
                      'Status': 'SCHEDULED'|'RUNNING'|'COMPLETED'|'CANCELLED'
                  },
              ],
              'NextToken': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The request succeeded.

      
      

      - **JourneyRunsResponse** *(dict) --* 

        Provides information from all runs of a journey.

        
        

        - **Item** *(list) --* 

          An array of responses, one for each run of the journey

          
          

          - *(dict) --* 

            Provides information from a specified run of a journey.

            
            

            - **CreationTime** *(string) --* 

              The time when the journey run was created or scheduled, in ISO 8601 format.

              
            

            - **LastUpdateTime** *(string) --* 

              The last time the journey run was updated, in ISO 8601 format..

              
            

            - **RunId** *(string) --* 

              The unique identifier for the run.

              
            

            - **Status** *(string) --* 

              The current status of the journey run.

              
        
      
        

        - **NextToken** *(string) --* 

          The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

          
    
  
  **Exceptions**
  
  *   :py:class:`Pinpoint.Client.exceptions.BadRequestException`

  
  *   :py:class:`Pinpoint.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`Pinpoint.Client.exceptions.PayloadTooLargeException`

  
  *   :py:class:`Pinpoint.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Pinpoint.Client.exceptions.NotFoundException`

  
  *   :py:class:`Pinpoint.Client.exceptions.MethodNotAllowedException`

  
  *   :py:class:`Pinpoint.Client.exceptions.TooManyRequestsException`

  