Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

Improve documentation for AWS Batch DescribeJobDefinitions #94

Closed
kdaily opened this issue Jul 1, 2021 · 2 comments
Closed

Improve documentation for AWS Batch DescribeJobDefinitions #94

kdaily opened this issue Jul 1, 2021 · 2 comments
Assignees
Labels
batch closed-for-staleness This issue was closed because it didn't receive updates documentation Improvements or additions to documentation

Comments

@kdaily
Copy link
Member

kdaily commented Jul 1, 2021

Original issue: boto/boto3#2908

Summary: DescribeJobDefinitions can take either a list of jobDefinitions or a jobDefinitionName. In the request, a jobDefinition must include a revision number when using either the job definition name or the ARN. In the response, a field called jobDefinitionName is returned without revisions. This caused confusion over what the appropriate parameter types to pass are. The behavior is as expected, but the documentation should be improved to avoid future confusion.

@kdaily kdaily self-assigned this Jul 1, 2021
@kdaily kdaily added documentation Improvements or additions to documentation service-api This issue pertains to the AWS API labels Jul 1, 2021
@kdaily
Copy link
Member Author

kdaily commented Jul 1, 2021

V389609372

@kdaily kdaily added the batch label Jul 20, 2021
@stobrien89 stobrien89 added service-docs Issue relates to missing information in service documentation and removed service-api This issue pertains to the AWS API service-docs Issue relates to missing information in service documentation labels Jul 21, 2021
@github-actions
Copy link

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

@github-actions github-actions bot added the closing-soon This issue will be closed soon label Aug 11, 2022
@github-actions github-actions bot added closed-for-staleness This issue was closed because it didn't receive updates and removed closing-soon This issue will be closed soon labels Aug 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
batch closed-for-staleness This issue was closed because it didn't receive updates documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants