Skip to content

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region

Description

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

Usage

opensearchingestion_list_pipelines(MaxResults, NextToken)

Arguments

  • MaxResults

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • NextToken

    If your initial list_pipelines operation returns a nextToken, you can include the returned nextToken in subsequent list_pipelines operations, which returns results in the next page.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Pipelines = list(
    list(
      Status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"STARTING"|"START_FAILED"|"STOPPING"|"STOPPED",
      StatusReason = list(
        Description = "string"
      ),
      PipelineName = "string",
      PipelineArn = "string",
      MinUnits = 123,
      MaxUnits = 123,
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Destinations = list(
        list(
          ServiceName = "string",
          Endpoint = "string"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)

Request syntax

svc$list_pipelines(
  MaxResults = 123,
  NextToken = "string"
)