:doc:`RedshiftDataAPIService <../../redshift-data>` / Paginator / GetStatementResultV2

********************
GetStatementResultV2
********************



.. py:class:: RedshiftDataAPIService.Paginator.GetStatementResultV2

  ::

    
    paginator = client.get_paginator('get_statement_result_v2')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`RedshiftDataAPIService.Client.get_statement_result_v2`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/GetStatementResultV2>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Id='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Id: string
    :param Id: **[REQUIRED]** 

      The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, ``d9b6c0c9-0747-4bf4-b142-e8883122f766:2`` has a suffix of ``:2`` that indicates the second SQL statement of a batch query. This identifier is returned by ``BatchExecuteStatment``, ``ExecuteStatment``, and ``ListStatements``.

      

    
    :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.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Records': [
                {
                    'CSVRecords': 'string'
                },
            ],
            'ColumnMetadata': [
                {
                    'isCaseSensitive': True|False,
                    'isCurrency': True|False,
                    'isSigned': True|False,
                    'label': 'string',
                    'name': 'string',
                    'nullable': 123,
                    'precision': 123,
                    'scale': 123,
                    'schemaName': 'string',
                    'tableName': 'string',
                    'typeName': 'string',
                    'length': 123,
                    'columnDefault': 'string'
                },
            ],
            'TotalNumRows': 123,
            'ResultFormat': 'JSON'|'CSV',
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Records** *(list) --* 

          The results of the SQL statement in CSV format.

          
          

          - *(dict) --* 

            The results of the SQL statement.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``CSVRecords``.     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'}


          
            

            - **CSVRecords** *(string) --* 

              The results of the SQL statement in CSV format.

              
        
      
        

        - **ColumnMetadata** *(list) --* 

          The properties (metadata) of a column.

          
          

          - *(dict) --* 

            The properties (metadata) of a column.

            
            

            - **isCaseSensitive** *(boolean) --* 

              A value that indicates whether the column is case-sensitive.

              
            

            - **isCurrency** *(boolean) --* 

              A value that indicates whether the column contains currency values.

              
            

            - **isSigned** *(boolean) --* 

              A value that indicates whether an integer column is signed.

              
            

            - **label** *(string) --* 

              The label for the column.

              
            

            - **name** *(string) --* 

              The name of the column.

              
            

            - **nullable** *(integer) --* 

              A value that indicates whether the column is nullable.

              
            

            - **precision** *(integer) --* 

              The precision value of a decimal number column.

              
            

            - **scale** *(integer) --* 

              The scale value of a decimal number column.

              
            

            - **schemaName** *(string) --* 

              The name of the schema that contains the table that includes the column.

              
            

            - **tableName** *(string) --* 

              The name of the table that includes the column.

              
            

            - **typeName** *(string) --* 

              The database-specific data type of the column.

              
            

            - **length** *(integer) --* 

              The length of the column.

              
            

            - **columnDefault** *(string) --* 

              The default value of the column.

              
        
      
        

        - **TotalNumRows** *(integer) --* 

          The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the ``GetStatementResultV2`` operation needed to page through the results.

          
        

        - **ResultFormat** *(string) --* 

          The data format of the result of the SQL statement.

          
    