Skip to content

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline

Description

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.

For more information, see Tracking the status of pipeline creation.

Usage

opensearchingestion_get_pipeline_change_progress(PipelineName)

Arguments

  • PipelineName

    [required] The name of the pipeline.

Value

A list with the following syntax:

list(
  ChangeProgressStatuses = list(
    list(
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      Status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED",
      TotalNumberOfStages = 123,
      ChangeProgressStages = list(
        list(
          Name = "string",
          Status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED",
          Description = "string",
          LastUpdatedAt = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  )
)

Request syntax

svc$get_pipeline_change_progress(
  PipelineName = "string"
)