Start Pipeline

opensearchingestion_start_pipeline

R Documentation

Starts an OpenSearch Ingestion pipeline

Description

Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.

Usage

opensearchingestion_start_pipeline(PipelineName)

Arguments

PipelineName

[required] The name of the pipeline to start.

Value

A list with the following syntax:

list(
  Pipeline = list(
    PipelineName = "string",
    PipelineArn = "string",
    MinUnits = 123,
    MaxUnits = 123,
    Status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"STARTING"|"START_FAILED"|"STOPPING"|"STOPPED",
    StatusReason = list(
      Description = "string"
    ),
    PipelineConfigurationBody = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    IngestEndpointUrls = list(
      "string"
    ),
    LogPublishingOptions = list(
      IsLoggingEnabled = TRUE|FALSE,
      CloudWatchLogDestination = list(
        LogGroup = "string"
      )
    ),
    VpcEndpoints = list(
      list(
        VpcEndpointId = "string",
        VpcId = "string",
        VpcOptions = list(
          SubnetIds = list(
            "string"
          ),
          SecurityGroupIds = list(
            "string"
          ),
          VpcAttachmentOptions = list(
            AttachToVpc = TRUE|FALSE,
            CidrBlock = "string"
          ),
          VpcEndpointManagement = "CUSTOMER"|"SERVICE"
        )
      )
    ),
    BufferOptions = list(
      PersistentBufferEnabled = TRUE|FALSE
    ),
    EncryptionAtRestOptions = list(
      KmsKeyArn = "string"
    ),
    VpcEndpointService = "string",
    ServiceVpcEndpoints = list(
      list(
        ServiceName = "OPENSEARCH_SERVERLESS",
        VpcEndpointId = "string"
      )
    ),
    Destinations = list(
      list(
        ServiceName = "string",
        Endpoint = "string"
      )
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$start_pipeline(
  PipelineName = "string"
)