:doc:`AppSync <../../appsync>` / Paginator / ListChannelNamespaces

*********************
ListChannelNamespaces
*********************



.. py:class:: AppSync.Paginator.ListChannelNamespaces

  ::

    
    paginator = client.get_paginator('list_channel_namespaces')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`AppSync.Client.list_channel_namespaces`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ListChannelNamespaces>`_    


    **Request Syntax**
    ::

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

      The ``Api`` ID.

      

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

      
      ::

        {
            'channelNamespaces': [
                {
                    'apiId': 'string',
                    'name': 'string',
                    'subscribeAuthModes': [
                        {
                            'authType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT'|'AWS_LAMBDA'
                        },
                    ],
                    'publishAuthModes': [
                        {
                            'authType': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT'|'AWS_LAMBDA'
                        },
                    ],
                    'codeHandlers': 'string',
                    'tags': {
                        'string': 'string'
                    },
                    'channelNamespaceArn': 'string',
                    'created': datetime(2015, 1, 1),
                    'lastModified': datetime(2015, 1, 1),
                    'handlerConfigs': {
                        'onPublish': {
                            'behavior': 'CODE'|'DIRECT',
                            'integration': {
                                'dataSourceName': 'string',
                                'lambdaConfig': {
                                    'invokeType': 'REQUEST_RESPONSE'|'EVENT'
                                }
                            }
                        },
                        'onSubscribe': {
                            'behavior': 'CODE'|'DIRECT',
                            'integration': {
                                'dataSourceName': 'string',
                                'lambdaConfig': {
                                    'invokeType': 'REQUEST_RESPONSE'|'EVENT'
                                }
                            }
                        }
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **channelNamespaces** *(list) --* 

          The ``ChannelNamespace`` objects.

          
          

          - *(dict) --* 

            Describes a channel namespace associated with an ``Api``. The ``ChannelNamespace`` contains the definitions for code handlers for the ``Api``.

            
            

            - **apiId** *(string) --* 

              The ``Api`` ID.

              
            

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

              The name of the channel namespace. This name must be unique within the ``Api``.

              
            

            - **subscribeAuthModes** *(list) --* 

              The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default ``Api``authorization configuration.

              
              

              - *(dict) --* 

                Describes an authorization configuration. Use ``AuthMode`` to specify the publishing and subscription authorization configuration for an Event API.

                
                

                - **authType** *(string) --* 

                  The authorization type.

                  
            
          
            

            - **publishAuthModes** *(list) --* 

              The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default ``Api``authorization configuration.

              
              

              - *(dict) --* 

                Describes an authorization configuration. Use ``AuthMode`` to specify the publishing and subscription authorization configuration for an Event API.

                
                

                - **authType** *(string) --* 

                  The authorization type.

                  
            
          
            

            - **codeHandlers** *(string) --* 

              The event handler functions that run custom business logic to process published events and subscribe requests.

              
            

            - **tags** *(dict) --* 

              A map with keys of ``TagKey`` objects and values of ``TagValue`` objects.

              
              

              - *(string) --* 

                The key for the tag.

                
                

                - *(string) --* 

                  The value for the tag.

                  
          
        
            

            - **channelNamespaceArn** *(string) --* 

              The Amazon Resource Name (ARN) for the ``ChannelNamespace``.

              
            

            - **created** *(datetime) --* 

              The date and time that the ``ChannelNamespace`` was created.

              
            

            - **lastModified** *(datetime) --* 

              The date and time that the ``ChannelNamespace`` was last changed.

              
            

            - **handlerConfigs** *(dict) --* 

              The configuration for the ``OnPublish`` and ``OnSubscribe`` handlers.

              
              

              - **onPublish** *(dict) --* 

                The configuration for the ``OnPublish`` handler.

                
                

                - **behavior** *(string) --* 

                  The behavior for the handler.

                  
                

                - **integration** *(dict) --* 

                  The integration data source configuration for the handler.

                  
                  

                  - **dataSourceName** *(string) --* 

                    The unique name of the data source that has been configured on the API.

                    
                  

                  - **lambdaConfig** *(dict) --* 

                    The configuration for a Lambda data source.

                    
                    

                    - **invokeType** *(string) --* 

                      The invocation type for a Lambda data source.

                      
                
              
            
              

              - **onSubscribe** *(dict) --* 

                The configuration for the ``OnSubscribe`` handler.

                
                

                - **behavior** *(string) --* 

                  The behavior for the handler.

                  
                

                - **integration** *(dict) --* 

                  The integration data source configuration for the handler.

                  
                  

                  - **dataSourceName** *(string) --* 

                    The unique name of the data source that has been configured on the API.

                    
                  

                  - **lambdaConfig** *(dict) --* 

                    The configuration for a Lambda data source.

                    
                    

                    - **invokeType** *(string) --* 

                      The invocation type for a Lambda data source.

                      
                
              
            
          
        
      
        

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

          A token to resume pagination.

          
    