:doc:`OpenSearchIngestion <../../osis>` / Paginator / ListPipelineEndpoints

*********************
ListPipelineEndpoints
*********************



.. py:class:: OpenSearchIngestion.Paginator.ListPipelineEndpoints

  ::

    
    paginator = client.get_paginator('list_pipeline_endpoints')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`OpenSearchIngestion.Client.list_pipeline_endpoints`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelineEndpoints>`_    


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

      
      ::

        {
            'PipelineEndpoints': [
                {
                    'PipelineArn': 'string',
                    'EndpointId': 'string',
                    'Status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'REVOKING'|'REVOKED',
                    'VpcId': 'string',
                    'VpcOptions': {
                        'SubnetIds': [
                            'string',
                        ],
                        'SecurityGroupIds': [
                            'string',
                        ]
                    },
                    'IngestEndpointUrl': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **PipelineEndpoints** *(list) --* 

          A list of pipeline endpoints.

          
          

          - *(dict) --* 

            Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private connectivity between your VPC and the pipeline.

            
            

            - **PipelineArn** *(string) --* 

              The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.

              
            

            - **EndpointId** *(string) --* 

              The unique identifier for the pipeline endpoint.

              
            

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

              The current status of the pipeline endpoint.

              
            

            - **VpcId** *(string) --* 

              The ID of the VPC where the pipeline endpoint is created.

              
            

            - **VpcOptions** *(dict) --* 

              Configuration options for the VPC endpoint, including subnet and security group settings.

              
              

              - **SubnetIds** *(list) --* 

                A list of subnet IDs where the pipeline endpoint network interfaces are created.

                
                

                - *(string) --* 
            
              

              - **SecurityGroupIds** *(list) --* 

                A list of security group IDs that control network access to the pipeline endpoint.

                
                

                - *(string) --* 
            
          
            

            - **IngestEndpointUrl** *(string) --* 

              The URL used to ingest data to the pipeline through the VPC endpoint.

              
        
      
    