OpenSearchIngestion / Client / list_pipeline_endpoints

list_pipeline_endpoints¶

OpenSearchIngestion.Client.list_pipeline_endpoints(**kwargs)¶

Lists all pipeline endpoints in your account.

Request Syntax

response = client.list_pipeline_endpoints(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The maximum number of pipeline endpoints to return in the response.
NextToken (string) – If your initial ListPipelineEndpoints operation returns a NextToken, you can include the returned NextToken in subsequent ListPipelineEndpoints operations, which returns results in the next page.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    '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) –
- NextToken (string) –
  
  When NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
- 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.

Exceptions

OpenSearchIngestion.Client.exceptions.DisabledOperationException
OpenSearchIngestion.Client.exceptions.LimitExceededException
OpenSearchIngestion.Client.exceptions.ValidationException
OpenSearchIngestion.Client.exceptions.InternalException
OpenSearchIngestion.Client.exceptions.AccessDeniedException