describe_pipelines¶

describe_pipelines(**kwargs)¶

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

See also: AWS API Documentation

Request Syntax

response = client.describe_pipelines(
    pipelineIds=[
        'string',
    ]
)

Parameters

pipelineIds (list) --

[REQUIRED]

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

(string) --

Return type

dict

Returns

Response Syntax

{
    'pipelineDescriptionList': [
        {
            'pipelineId': 'string',
            'name': 'string',
            'fields': [
                {
                    'key': 'string',
                    'stringValue': 'string',
                    'refValue': 'string'
                },
            ],
            'description': 'string',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
Contains the output of DescribePipelines.
- pipelineDescriptionList (list) --
  An array of descriptions for the specified pipelines.
  - (dict) --
    Contains pipeline metadata.
    - pipelineId (string) --
      The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE .
    - name (string) --
      The name of the pipeline.
    - fields (list) --
      A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
      - (dict) --
        A key-value pair that describes a property of a pipeline object. The value is specified as either a string value ( StringValue ) or a reference to another object ( RefValue ) but not as both.
        
        key (string) --
        The field identifier.
        
        stringValue (string) --
        The field value, expressed as a String.
        
        refValue (string) --
        The field value, expressed as the identifier of another object.
    - description (string) --
      Description of the pipeline.
    - tags (list) --
      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 .
      - (dict) --
        Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
        
        key (string) --
        The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .
        
        value (string) --
        The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide .

Exceptions

DataPipeline.Client.exceptions.PipelineNotFoundException
DataPipeline.Client.exceptions.PipelineDeletedException
DataPipeline.Client.exceptions.InternalServiceError
DataPipeline.Client.exceptions.InvalidRequestException

Table Of Contents

describe_pipelines¶