OpenSearchIngestion / Client / list_pipeline_endpoint_connections

list_pipeline_endpoint_connections¶

OpenSearchIngestion.Client.list_pipeline_endpoint_connections(**kwargs)¶

Lists the pipeline endpoints connected to pipelines in your account.

Request Syntax

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

Parameters:

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'PipelineEndpointConnections': [
        {
            'PipelineArn': 'string',
            'EndpointId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'REVOKING'|'REVOKED',
            'VpcEndpointOwner': '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.
- PipelineEndpointConnections (list) –
  
  A list of pipeline endpoint connections.
  - (dict) –
    
    Represents a connection to a pipeline endpoint, containing details about the endpoint association.
    - PipelineArn (string) –
      
      The Amazon Resource Name (ARN) of the pipeline in the endpoint connection.
    - EndpointId (string) –
      
      The unique identifier of the endpoint in the connection.
    - Status (string) –
      
      The current status of the pipeline endpoint connection.
    - VpcEndpointOwner (string) –
      
      The Amazon Web Services account ID that owns the VPC endpoint used in this connection.

Exceptions

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