OpenSearchIngestion / Client / list_pipelines

list_pipelines

OpenSearchIngestion.Client.list_pipelines(**kwargs)

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• MaxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

• NextToken (string) – If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Pipelines': [
        {
            'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'STARTING'|'START_FAILED'|'STOPPING'|'STOPPED',
            'StatusReason': {
                'Description': 'string'
            },
            'PipelineName': 'string',
            'PipelineArn': 'string',
            'MinUnits': 123,
            'MaxUnits': 123,
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'Destinations': [
                {
                    'ServiceName': 'string',
                    'Endpoint': 'string'
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': '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.

  • Pipelines (list) –

    A list of all existing Data Prepper pipelines.

    • (dict) –

      Summary information for an OpenSearch Ingestion pipeline.

      • Status (string) –

        The current status of the pipeline.

      • StatusReason (dict) –

        Information about a pipeline’s current status.

        • Description (string) –

          A description of why a pipeline has a certain status.

      • PipelineName (string) –

        The name of the pipeline.

      • PipelineArn (string) –

        The Amazon Resource Name (ARN) of the pipeline.

      • MinUnits (integer) –

        The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

      • MaxUnits (integer) –

        The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

      • CreatedAt (datetime) –

        The date and time when the pipeline was created.

      • LastUpdatedAt (datetime) –

        The date and time when the pipeline was last updated.

      • Destinations (list) –

        A list of destinations to which the pipeline writes data.

        • (dict) –

          An object representing the destination of a pipeline.

          • ServiceName (string) –

            The name of the service receiving data from the pipeline.

          • Endpoint (string) –

            The endpoint receiving data from the pipeline.

      • Tags (list) –

        A list of tags associated with the given pipeline.

        • (dict) –

          A tag (key-value pair) for an OpenSearch Ingestion pipeline.

          • Key (string) –

            The tag key. Tag keys must be unique for the pipeline to which they are attached.

          • Value (string) –

            The value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Exceptions

• OpenSearchIngestion.Client.exceptions.DisabledOperationException

• OpenSearchIngestion.Client.exceptions.ValidationException

• OpenSearchIngestion.Client.exceptions.InternalException

• OpenSearchIngestion.Client.exceptions.AccessDeniedException

• OpenSearchIngestion.Client.exceptions.InvalidPaginationTokenException