:doc:`SecurityIncidentResponse <../../security-ir>` / Paginator / ListCases

*********
ListCases
*********



.. py:class:: SecurityIncidentResponse.Paginator.ListCases

  ::

    
    paginator = client.get_paginator('list_cases')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SecurityIncidentResponse.Client.list_cases`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListCases>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

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

      
      ::

        {
            'items': [
                {
                    'caseId': 'string',
                    'lastUpdatedDate': datetime(2015, 1, 1),
                    'title': 'string',
                    'caseArn': 'string',
                    'engagementType': 'Security Incident'|'Investigation',
                    'caseStatus': 'Submitted'|'Acknowledged'|'Detection and Analysis'|'Containment, Eradication and Recovery'|'Post-incident Activities'|'Ready to Close'|'Closed',
                    'createdDate': datetime(2015, 1, 1),
                    'closedDate': datetime(2015, 1, 1),
                    'resolverType': 'AWS'|'Self',
                    'pendingAction': 'Customer'|'None'
                },
            ],
            'total': 123,
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          Response element for ListCases that includes caseARN, caseID, caseStatus, closedDate, createdDate, engagementType, lastUpdatedDate, pendingAction, resolverType, and title for each response.

          
          

          - *(dict) --* 
            

            - **caseId** *(string) --* 
            

            - **lastUpdatedDate** *(datetime) --* 
            

            - **title** *(string) --* 
            

            - **caseArn** *(string) --* 
            

            - **engagementType** *(string) --* 
            

            - **caseStatus** *(string) --* 
            

            - **createdDate** *(datetime) --* 
            

            - **closedDate** *(datetime) --* 
            

            - **resolverType** *(string) --* 
            

            - **pendingAction** *(string) --* 
        
      
        

        - **total** *(integer) --* 

          Response element for ListCases providing the total number of responses.

          
        

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

          A token to resume pagination.

          
    