:doc:`AgentsforBedrockRuntime <../../bedrock-agent-runtime>` / Client / list_invocations

****************
list_invocations
****************



.. py:method:: AgentsforBedrockRuntime.Client.list_invocations(**kwargs)

  

  Lists all invocations associated with a specific session. For more information about sessions, see `Store and retrieve conversation history and context with Amazon Bedrock sessions <https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ListInvocations>`_  


  **Request Syntax**
  ::

    response = client.list_invocations(
        maxResults=123,
        nextToken='string',
        sessionIdentifier='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the ``nextToken`` field when making another request to return the next batch of results.

    

  
  :type nextToken: string
  :param nextToken: 

    If the total number of results is greater than the ``maxResults`` value provided in the request, enter the token returned in the ``nextToken`` field in the response in this field to return the next batch of results.

    

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

    The unique identifier for the session to list invocations for. You can specify either the session's ``sessionId`` or its Amazon Resource Name (ARN).

    

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

    
    ::

      {
          'invocationSummaries': [
              {
                  'createdAt': datetime(2015, 1, 1),
                  'invocationId': 'string',
                  'sessionId': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **invocationSummaries** *(list) --* 

        A list of invocation summaries associated with the session.

        
        

        - *(dict) --* 

          Contains details about an invocation in a session. For more information about sessions, see `Store and retrieve conversation history and context with Amazon Bedrock sessions <https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html>`__.

          
          

          - **createdAt** *(datetime) --* 

            The timestamp for when the invocation was created.

            
          

          - **invocationId** *(string) --* 

            A unique identifier for the invocation in UUID format.

            
          

          - **sessionId** *(string) --* 

            The unique identifier for the session associated with the invocation.

            
      
    
      

      - **nextToken** *(string) --* 

        If the total number of results is greater than the ``maxResults`` value provided in the request, use this token when making another request in the ``nextToken`` field to return the next batch of results.

        
  
  **Exceptions**
  
  *   :py:class:`AgentsforBedrockRuntime.Client.exceptions.ResourceNotFoundException`

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

  
  *   :py:class:`AgentsforBedrockRuntime.Client.exceptions.InternalServerException`

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

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

  