Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

DescribeObjects

class DataPipeline.Paginator.DescribeObjects
paginator = client.get_paginator('describe_objects')
paginate(**kwargs)

Creates an iterator that will paginate through responses from DataPipeline.Client.describe_objects().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    pipelineId='string',
    objectIds=[
        'string',
    ],
    evaluateExpressions=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • pipelineId (string) --

    [REQUIRED]

    The ID of the pipeline that contains the object definitions.

  • objectIds (list) --

    [REQUIRED]

    The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects .

    • (string) --
  • evaluateExpressions (boolean) -- Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'pipelineObjects': [
        {
            'id': 'string',
            'name': 'string',
            'fields': [
                {
                    'key': 'string',
                    'stringValue': 'string',
                    'refValue': 'string'
                },
            ]
        },
    ],
    'hasMoreResults': True|False,
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Contains the output of DescribeObjects.

    • pipelineObjects (list) --

      An array of object definitions.

      • (dict) --

        Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

        • id (string) --

          The ID of the object.

        • name (string) --

          The name of the object.

        • fields (list) --

          Key-value pairs that define the properties of the object.

          • (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.

    • hasMoreResults (boolean) --

      Indicates whether there are more results to return.

    • NextToken (string) --

      A token to resume pagination.