Skip to content

DescribeObjectsInput

Source code in docs_src/capo_data_pipeline/types/describe_objects_input.py 
16
17
18
19
20
21
22
23
24
class DescribeObjectsInput(TypedDict, closed=True):
    pipeline_id: "capo_data_pipeline.types.id.id"
    """<p>The ID of the pipeline that contains the object definitions.</p>"""
    object_ids: "capo_data_pipeline.types.id_list.idList"
    """<p>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 <code>DescribeObjects</code>.</p>"""
    evaluate_expressions: "capo_data_pipeline.types.boolean.boolean"
    """<p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>"""
    marker: NotRequired["capo_data_pipeline.types.string.string"]
    """<p>The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results.</p>"""

evaluate_expressions instance-attribute 

evaluate_expressions: boolean

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

marker instance-attribute 

marker: NotRequired[string]

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

object_ids instance-attribute 

object_ids: idList

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.

pipeline_id instance-attribute 

pipeline_id: id

The ID of the pipeline that contains the object definitions.