boto3 start_codepipeline doesn't recognize the variables parameter.

Question

I'm trying to pass pipeline-level parameters into codepipeline from a python lambda, but it looks like Boto3 is not recognizing the 'variables' named parameter.

I'd appreciate some help if anyone has been able to make this work. - Thank you

Here's the code:

cp = boto3.client('codepipeline')
cp.start_pipeline_execution(name='ci-cd-pipeline', variables=[{'name': 'RepositoryName', 'value': repository}])

I get this response:
Response
{
  "errorMessage": "Parameter validation failed:
Unknown parameter in input: "variables", must be one of: name, clientRequestToken",
  "errorType": "ParamValidationError",
  "requestId": "fc44dcbe-e368-44fc-acc4-f1d5afc5dfd0",
  "stackTrace": [
    "  File "/opt/python/aws_lambda_powertools/logging/logger.py", line 354, in decorate
    return lambda_handler(event, context, *args, **kwargs)
",
    "  File "/var/task/index.py", line 17, in lambda_handler
    start_codepipeline(repository)
",
    "  File "/var/task/index.py", line 20, in start_codepipeline
    cp.start_pipeline_execution(name='ci-cd-pipeline', variables=[{'name': 'RepositoryName', 'value': repository}])
",
    "  File "/opt/python/botocore/client.py", line 569, in _api_call
    return self._make_api_call(operation_name, kwargs)
",
    "  File "/opt/python/botocore/client.py", line 980, in _make_api_call
    request_dict = self._convert_to_request_dict(
",
    "  File "/opt/python/botocore/client.py", line 1047, in _convert_to_request_dict
    request_dict = self._serializer.serialize_to_request(
",
    "  File "/opt/python/botocore/validate.py", line 381, in serialize_to_request
    raise ParamValidationError(report=report.generate_report())
"
  ]
}

Function Logs
START RequestId: fc44dcbe-e368-44fc-acc4-f1d5afc5dfd0 Version: $LATEST
{"level":"INFO","location":"lambda_handler:12","message":{"Boto3":"1.35.34"},"timestamp":"2024-10-06 01:23:00,832+0000","service":"service_undefined","cold_start":true,"function_name":"ci-cd-trigger","function_memory_size":"128","function_arn":"arn:aws:lambda:us-west-2:471112899453:function:ci-cd-trigger","function_request_id":"fc44dcbe-e368-44fc-acc4-f1d5afc5dfd0","xray_trace_id":"1-6701e673-251782775cc583745b6c929a"}

I've used a layer to upgrade Boto3 to version 1.35.34 as shown in the log above.

The documentation shows a named parameter 'variables':
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/codepipeline/client/start_pipeline_execution.html

I've found that someone else has run into this as well:
https://stackoverflow.com/questions/78482656/boto3-v1-34-104-in-aws-lambda-wont-allow-passing-variables-parameter-in-codepipe

re:Post Agent · Answer

It appears that you're encountering an issue with the `start_pipeline_execution` method in Boto3 not recognizing the `variables` parameter. This is likely due to a discrepancy between the Boto3 documentation and the actual implementation.

The `variables` parameter is indeed mentioned in the Boto3 documentation for `start_pipeline_execution`, but it seems that the current implementation of the method does not support this parameter. This could be due to a lag between the API documentation and the actual implementation in the Boto3 library.

To work around this issue, you have a couple of options:

1. Use pipeline-level variables: Instead of trying to pass variables at execution time, you can define pipeline-level variables when creating or updating the pipeline. These variables can then be referenced within your pipeline actions.

2. Use the AWS CLI or SDK to start the pipeline execution: If you need to pass variables at runtime, you might need to use the AWS CLI or a different SDK that supports this feature.

For the pipeline-level variables approach, you would first need to update your pipeline configuration to include the variables. This can be done using the `update_pipeline` method. Here's an example of how you might do this:

```python
pipeline_data = cp.get_pipeline(name='ci-cd-pipeline')
pipeline_data['pipeline']['variables'] = [
{
'name': 'RepositoryName',
'defaultValue': 'default_repo_name',
'description': 'The name of the repository'
}
]
cp.update_pipeline(pipeline=pipeline_data['pipeline'])
```

After setting up the pipeline-level variables, you can start the pipeline execution without specifying variables:

```python
cp.start_pipeline_execution(name='ci-cd-pipeline')
```

The pipeline will use the default value for the variable unless overridden elsewhere in your pipeline configuration.

If you absolutely need to pass variables at runtime, you might need to explore other options like using the AWS CLI or a different SDK until Boto3 fully supports this feature for the `start_pipeline_execution` method.  
**Sources**  
[PipelineVariable - CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_PipelineVariable.html)  
[Variables reference - AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-variables.html)

boto3 start_codepipeline doesn't recognize the variables parameter.

Add your answer

Relevant content