start_pipeline_execution ¶

def start_pipeline_execution(
    self,
    name: "capo_codepipeline.types.pipeline_name.PipelineName",
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
    variables: Optional[
        "capo_codepipeline.types.pipeline_variable_list.PipelineVariableList"
    ] = None,
    client_request_token: Optional[
        "capo_codepipeline.types.client_request_token.ClientRequestToken"
    ] = None,
    source_revisions: Optional[
        "capo_codepipeline.types.source_revision_override_list.SourceRevisionOverrideList"
    ] = None,
) -> "capo_codepipeline.types.start_pipeline_execution_output.StartPipelineExecutionOutput":
    r"""<p>Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.</p>

    Args:
        name: <p>The name of the pipeline to start.</p>
        variables: <p>A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match <code>[A-Za-z0-9@\-_]+</code>, and the values can be anything except an empty string.</p>
        client_request_token: <p>The system-generated unique ID used to identify a unique execution request.</p>
        source_revisions: <p>A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.</p>

    Raises:
        capo_codepipeline.errors.concurrent_pipeline_executions_limit_exceeded_exception.ConcurrentPipelineExecutionsLimitExceededException: <p>The pipeline has reached the limit for concurrent pipeline executions.</p>
        capo_codepipeline.errors.conflict_exception.ConflictException: <p>Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.</p>
        capo_codepipeline.errors.pipeline_not_found_exception.PipelineNotFoundException: <p>The pipeline was specified in an invalid format or cannot be found.</p>
        capo_codepipeline.errors.validation_exception.ValidationException: <p>The validation was specified in an invalid format.</p>
        capo_codepipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codepipeline.types.start_pipeline_execution_input.StartPipelineExecutionInput]",
    ) -> OperationResponse[
        "capo_codepipeline.types.start_pipeline_execution_output.StartPipelineExecutionOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.start_pipeline_execution

        output, http_response = (
            capo_codepipeline._operations.code_pipeline_20150709.start_pipeline_execution.start_pipeline_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartPipelineExecution")
    )
    input_: capo_codepipeline.types.start_pipeline_execution_input.StartPipelineExecutionInput = {
        "name": name
    }
    if variables is not None:
        input_["variables"] = variables
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if source_revisions is not None:
        input_["source_revisions"] = source_revisions

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