Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cloudfront.delete_origin_access_control() API requires both Id and IfMatch as arguments #3813

Closed
diningPhilosopher64 opened this issue Aug 8, 2023 · 1 comment
Assignees

Comments

@diningPhilosopher64
Copy link

Describe the issue

The delete_access_control() API suggests that the IfMatch argument is optional.

But when this function is used without the argument as :

cloudfront = boto3.client("cloudfront")

cloudfront.delete_origin_access_control(Id="my-oac-id")

It will throw the error:

An error occurred (InvalidIfMatchVersion) when calling the DeleteOriginAccessControl operation: The If-Match version is missing or not valid for the resource.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudfront/client/delete_origin_access_control.html

@diningPhilosopher64 diningPhilosopher64 added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Aug 8, 2023
@tim-finnigan tim-finnigan self-assigned this Aug 8, 2023
@tim-finnigan
Copy link
Contributor

Hi @diningPhilosopher64 thanks for reaching out. This documentation is generated upstream by the service team, so we'll need to contact the CloudFront team about addressing this in the DeleteOriginAccessControl API documentation.

I found several other reports of the IfMatch parameter being documented as optional even though it is required. You can see here in the service API model definitions where IfMatch is used in various CloudFront APIs: https://github.com/boto/botocore/blob/develop/botocore/data/cloudfront/2020-05-31/service-2.json

The service API documentation should get updated to clarify where this parameter required. I'll escalate this to the CloudFront team. And I created this issue in our cross-SDK repository for tracking going forward: aws/aws-sdk#576. Please refer to that issue for updates.

@tim-finnigan tim-finnigan added api-documentation and removed documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants