:doc:`Redshift <../../redshift>` / Paginator / DescribeDataSharesForConsumer

*****************************
DescribeDataSharesForConsumer
*****************************



.. py:class:: Redshift.Paginator.DescribeDataSharesForConsumer

  ::

    
    paginator = client.get_paginator('describe_data_shares_for_consumer')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Redshift.Client.describe_data_shares_for_consumer`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDataSharesForConsumer>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ConsumerArn='string',
          Status='ACTIVE'|'AVAILABLE',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ConsumerArn: string
    :param ConsumerArn: 

      The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.

      

    
    :type Status: string
    :param Status: 

      An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

      

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

      
      ::

        {
            'DataShares': [
                {
                    'DataShareArn': 'string',
                    'ProducerArn': 'string',
                    'AllowPubliclyAccessibleConsumers': True|False,
                    'DataShareAssociations': [
                        {
                            'ConsumerIdentifier': 'string',
                            'Status': 'ACTIVE'|'PENDING_AUTHORIZATION'|'AUTHORIZED'|'DEAUTHORIZED'|'REJECTED'|'AVAILABLE',
                            'ConsumerRegion': 'string',
                            'CreatedDate': datetime(2015, 1, 1),
                            'StatusChangeDate': datetime(2015, 1, 1),
                            'ProducerAllowedWrites': True|False,
                            'ConsumerAcceptedWrites': True|False
                        },
                    ],
                    'ManagedBy': 'string',
                    'DataShareType': 'INTERNAL'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **DataShares** *(list) --* 

          Shows the results of datashares available for consumers.

          
          

          - *(dict) --* 
            

            - **DataShareArn** *(string) --* 

              The Amazon Resource Name (ARN) of the datashare that the consumer is to use.

              
            

            - **ProducerArn** *(string) --* 

              The Amazon Resource Name (ARN) of the producer namespace.

              
            

            - **AllowPubliclyAccessibleConsumers** *(boolean) --* 

              A value that specifies whether the datashare can be shared to a publicly accessible cluster.

              
            

            - **DataShareAssociations** *(list) --* 

              A value that specifies when the datashare has an association between producer and data consumers.

              
              

              - *(dict) --* 

                The association of a datashare from a producer account with a data consumer.

                
                

                - **ConsumerIdentifier** *(string) --* 

                  The name of the consumer accounts that have an association with a producer datashare.

                  
                

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

                  The status of the datashare that is associated.

                  
                

                - **ConsumerRegion** *(string) --* 

                  The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare.

                  
                

                - **CreatedDate** *(datetime) --* 

                  The creation date of the datashare that is associated.

                  
                

                - **StatusChangeDate** *(datetime) --* 

                  The status change data of the datashare that is associated.

                  
                

                - **ProducerAllowedWrites** *(boolean) --* 

                  Specifies whether write operations were allowed during data share authorization.

                  
                

                - **ConsumerAcceptedWrites** *(boolean) --* 

                  Specifies whether write operations were allowed during data share association.

                  
            
          
            

            - **ManagedBy** *(string) --* 

              The identifier of a datashare to show its managing entity.

              
            

            - **DataShareType** *(string) --* 

              The type of the datashare created by RegisterNamespace.

              
        
      
        

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

          A token to resume pagination.

          
    