PipelineSummary
Summary information for an OpenSearch Ingestion pipeline.
Contents
- CreatedAt
-
The date and time when the pipeline was created.
Type: Timestamp
Required: No
- Destinations
-
A list of destinations to which the pipeline writes data.
Type: Array of PipelineDestination objects
Required: No
- LastUpdatedAt
-
The date and time when the pipeline was last updated.
Type: Timestamp
Required: No
- MaxUnits
-
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- MinUnits
-
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- PipelineArn
-
The Amazon Resource Name (ARN) of the pipeline.
Type: String
Length Constraints: Minimum length of 46. Maximum length of 76.
Pattern:
^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$Required: No
- PipelineName
-
The name of the pipeline.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 28.
Pattern:
[a-z][a-z0-9\-]+Required: No
- Status
-
The current status of the pipeline.
Type: String
Valid Values:
CREATING | ACTIVE | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | STARTING | START_FAILED | STOPPING | STOPPEDRequired: No
- StatusReason
-
Information about a pipeline's current status.
Type: PipelineStatusReason object
Required: No
- Tags
-
A list of tags associated with the given pipeline.
Type: Array of Tag objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
