Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DescribeObjects Content-Length: 98 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", "objectIds": ["Schedule"], "evaluateExpressions": true} x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef Content-Type: application/x-amz-json-1.1 Content-Length: 1488 Date: Mon, 12 Nov 2012 17:50:53 GMT {"hasMoreResults": false, "pipelineObjects": [ {"fields": [ {"key": "startDateTime", "stringValue": "2012-12-12T00:00:00"}, {"key": "parent", "refValue": "Default"}, {"key": "@sphere", "stringValue": "COMPONENT"}, {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", "stringValue": "2012-12-21T18:00:00"}, {"key": "@version", "stringValue": "1"}, {"key": "@status", "stringValue": "PENDING"}, {"key": "@pipelineId", "stringValue": "df-06372391ZG65EXAMPLE"} ], "id": "Schedule", "name": "Schedule"} ] }
Parameters:
-
pipeline_id
(id)
–
The ID of the pipeline that contains the object definitions.
-
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.
-
evaluate_expressions
(Optional[boolean], default:
None
)
–
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
-
marker
(Optional[string], default:
None
)
–
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.
Raises:
-
InternalServiceError
–
An internal service error occurred.
-
InvalidRequestException
–
The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.
-
PipelineDeletedException
–
The specified pipeline has been deleted.
-
PipelineNotFoundException
–
The specified pipeline was not found. Verify that you used the correct user and account identifiers.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_data_pipeline/_services/data_pipeline.py
| def describe_objects(
self,
pipeline_id: "capo_data_pipeline.types.id.id",
object_ids: "capo_data_pipeline.types.id_list.idList",
*,
config_overrides: Optional[DataPipelineClientConfig] = None,
evaluate_expressions: Optional[
"capo_data_pipeline.types.boolean.boolean"
] = None,
marker: Optional["capo_data_pipeline.types.string.string"] = None,
) -> "capo_data_pipeline.types.describe_objects_output.DescribeObjectsOutput":
"""<p>Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.</p> <examples> <request> POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DescribeObjects Content-Length: 98 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", "objectIds": ["Schedule"], "evaluateExpressions": true} </request> <response> x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef Content-Type: application/x-amz-json-1.1 Content-Length: 1488 Date: Mon, 12 Nov 2012 17:50:53 GMT {"hasMoreResults": false, "pipelineObjects": [ {"fields": [ {"key": "startDateTime", "stringValue": "2012-12-12T00:00:00"}, {"key": "parent", "refValue": "Default"}, {"key": "@sphere", "stringValue": "COMPONENT"}, {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", "stringValue": "2012-12-21T18:00:00"}, {"key": "@version", "stringValue": "1"}, {"key": "@status", "stringValue": "PENDING"}, {"key": "@pipelineId", "stringValue": "df-06372391ZG65EXAMPLE"} ], "id": "Schedule", "name": "Schedule"} ] } </response> </examples>
Args:
pipeline_id: <p>The ID of the pipeline that contains the object definitions.</p>
object_ids: <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: <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>
marker: <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>
Raises:
capo_data_pipeline.errors.internal_service_error.InternalServiceError: <p>An internal service error occurred.</p>
capo_data_pipeline.errors.invalid_request_exception.InvalidRequestException: <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>
capo_data_pipeline.errors.pipeline_deleted_exception.PipelineDeletedException: <p>The specified pipeline has been deleted.</p>
capo_data_pipeline.errors.pipeline_not_found_exception.PipelineNotFoundException: <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>
capo_data_pipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_data_pipeline.types.describe_objects_input.DescribeObjectsInput]",
) -> OperationResponse[
"capo_data_pipeline.types.describe_objects_output.DescribeObjectsOutput"
]:
import capo_data_pipeline._operations.data_pipeline.describe_objects
output, http_response = (
capo_data_pipeline._operations.data_pipeline.describe_objects.describe_objects(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeObjects")
)
input_: capo_data_pipeline.types.describe_objects_input.DescribeObjectsInput = {
"pipeline_id": pipeline_id,
"object_ids": object_ids,
}
if evaluate_expressions is not None:
input_["evaluate_expressions"] = evaluate_expressions
if marker is not None:
input_["marker"] = marker
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|