PipelineDescription
Contains pipeline metadata.
Contents
- fields
-
A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
Type: Array of Field objects
Required: Yes
- name
-
The name of the pipeline.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*Required: Yes
- pipelineId
-
The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form
df-297EG78HU43EEXAMPLE.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*Required: Yes
- description
-
Description of the pipeline.
Type: String
Required: No
-
A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
