validate_pipeline_definition ¶

def validate_pipeline_definition(
    self,
    pipeline_id: "capo_data_pipeline.types.id.id",
    pipeline_objects: "capo_data_pipeline.types.pipeline_object_list.PipelineObjectList",
    *,
    config_overrides: Optional[DataPipelineClientConfig] = None,
    parameter_objects: Optional[
        "capo_data_pipeline.types.parameter_object_list.ParameterObjectList"
    ] = None,
    parameter_values: Optional[
        "capo_data_pipeline.types.parameter_value_list.ParameterValueList"
    ] = None,
) -> "capo_data_pipeline.types.validate_pipeline_definition_output.ValidatePipelineDefinitionOutput":
    """<p>Validates the specified pipeline definition to ensure that it is well formed and can be run without error.</p> <examples> <example> <name>Example 1</name> <description> This example sets an valid pipeline configuration and returns success. </description> <request> POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ValidatePipelineDefinition Content-Length: 936 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", "pipelineObjects": [ {"id": "Default", "name": "Default", "fields": [ {"key": "workerGroup", "stringValue": "MyworkerGroup"} ] }, {"id": "Schedule", "name": "Schedule", "fields": [ {"key": "startDateTime", "stringValue": "2012-09-25T17:00:00"}, {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", "stringValue": "2012-09-25T18:00:00"} ] }, {"id": "SayHello", "name": "SayHello", "fields": [ {"key": "type", "stringValue": "ShellCommandActivity"}, {"key": "command", "stringValue": "echo hello"}, {"key": "parent", "refValue": "Default"}, {"key": "schedule", "refValue": "Schedule"} ] } ] } </request> <response> x-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef Content-Type: application/x-amz-json-1.1 Content-Length: 18 Date: Mon, 12 Nov 2012 17:50:53 GMT {"errored": false} </response> </example> <example> <name>Example 2</name> <description> This example sets an invalid pipeline configuration and returns the associated set of validation errors. </description> <request> POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ValidatePipelineDefinition Content-Length: 903 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", "pipelineObjects": [ {"id": "Default", "name": "Default", "fields": [ {"key": "workerGroup", "stringValue": "MyworkerGroup"} ] }, {"id": "Schedule", "name": "Schedule", "fields": [ {"key": "startDateTime", "stringValue": "bad-time"}, {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", "stringValue": "2012-09-25T18:00:00"} ] }, {"id": "SayHello", "name": "SayHello", "fields": [ {"key": "type", "stringValue": "ShellCommandActivity"}, {"key": "command", "stringValue": "echo hello"}, {"key": "parent", "refValue": "Default"}, {"key": "schedule", "refValue": "Schedule"} ] } ] } </request> <response> x-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd Content-Type: application/x-amz-json-1.1 Content-Length: 278 Date: Mon, 12 Nov 2012 17:50:53 GMT {"errored": true, "validationErrors": [ {"errors": ["INVALID_FIELD_VALUE: 'startDateTime' value must be a literal datetime value."], "id": "Schedule"} ] } </response> </example> </examples>

    Args:
        pipeline_id: <p>The ID of the pipeline.</p>
        pipeline_objects: <p>The objects that define the pipeline changes to validate against the pipeline.</p>
        parameter_objects: <p>The parameter objects used with the pipeline.</p>
        parameter_values: <p>The parameter values used with the pipeline.</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.validate_pipeline_definition_input.ValidatePipelineDefinitionInput]",
    ) -> OperationResponse[
        "capo_data_pipeline.types.validate_pipeline_definition_output.ValidatePipelineDefinitionOutput"
    ]:
        import capo_data_pipeline._operations.data_pipeline.validate_pipeline_definition

        output, http_response = (
            capo_data_pipeline._operations.data_pipeline.validate_pipeline_definition.validate_pipeline_definition(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ValidatePipelineDefinition")
    )
    input_: capo_data_pipeline.types.validate_pipeline_definition_input.ValidatePipelineDefinitionInput = {
        "pipeline_id": pipeline_id,
        "pipeline_objects": pipeline_objects,
    }
    if parameter_objects is not None:
        input_["parameter_objects"] = parameter_objects
    if parameter_values is not None:
        input_["parameter_values"] = parameter_values

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output