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

The AppRunner Service Status lacks sufficient explanation. #4569

Open
koya1616 opened this issue Jan 6, 2024 · 2 comments
Open

The AppRunner Service Status lacks sufficient explanation. #4569

koya1616 opened this issue Jan 6, 2024 · 2 comments
Assignees
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue

Comments

@koya1616
Copy link

koya1616 commented Jan 6, 2024

Describe the issue

  • DELETED
  • DELETE_FAILED
  • PAUSED
  • CREATE_FAILED

Please add explanations for the above statuses in the code below

* The current state of the App Runner service. These particular values mean the following. CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService. DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

Links

https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/describe-service.html#output
https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/AppRunner.html#describeService-property

@koya1616 koya1616 added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jan 6, 2024
@aBurmeseDev aBurmeseDev self-assigned this Jan 10, 2024
@aBurmeseDev
Copy link
Member

Hi @koya1616 - thanks for reaching out and sharing this feedback.

Upon checking the Status output in the docs, I see that both CREATE_FAILED and DELETE_FAILED has descriptive explanation but missing for DELETED and PAUSED. Can you please confirm that's what you're referring to?

Please note that these SDK docs are generated upstream by the service docs which I also checked and confirmed that it reflects our current SDK docs. With that said, I might have to reach out to service team to update the docs to add the explanation for the rest of the status values.

Status
The current state of the App Runner service. These particular values mean the following.

CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

Type: String

Valid Values: CREATE_FAILED | RUNNING | DELETED | DELETE_FAILED | PAUSED | OPERATION_IN_PROGRESS

Thanks again for reaching out with the feedback on our docs!
John

@aBurmeseDev aBurmeseDev added response-requested Waiting on additional info and feedback. Will move to \"closing-soon\" in 7 days. p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Jan 10, 2024
@koya1616
Copy link
Author

@aBurmeseDev
Oh, I'm sorry I didn't check service docs

aws apprunner describe-service help

I run above command. And I read following description.
I thought "There is Only two types of status?".

          Status -> (string)
             The current state of the App Runner service. These particular
             values mean the following.

             o CREATE_FAILED - The service failed to create. To troubleshoot
               this failure, read the failure events and logs, change any
               parameters that need to be fixed, and retry the call to create
               the service. The failed service isn't usable, and still counts
               towards your service quota. When you're done analyzing the
               failure, delete the service.

             o DELETE_FAILED - The service failed to delete and can't be
               successfully recovered. Retry the service deletion call to
               ensure that all related resources are removed.

Is this not relevant?

@github-actions github-actions bot removed the response-requested Waiting on additional info and feedback. Will move to \"closing-soon\" in 7 days. label Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

2 participants