Add CLI Examples for Application Insights #9006
Conversation
elysahall
added
documentation
There was a problem hiding this comment.
Hi @kocanaog,
Thank you for your example submission! It looks like there are a few issues with all of your examples.
The intro line needs to be fixed on all examples and for more information links need to be added. After you've made your changes, commit and push your updates.
| "Tier": "SQL_SERVER", | ||
| "Configuration": "{\"logs\":[{\"logGroupName\":\"SQL_SERVER-sqlserver\",\"logPath\":\"/var/log/mysql\",\"logType\":\"MYSQL\",\"monitor\":true,\"encoding\":\"utf-16\"}]}" | ||
| } | ||
| } |
There was a problem hiding this comment.
All of your examples need the For more information link at the bottom of examples.
https://aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link
| @@ -0,0 +1,27 @@ | |||
| **To add a workload to a component** | |||
|
|
|||
| This example uses the ``add-workload`` command to add a workload to a component. :: | |||
There was a problem hiding this comment.
| This example uses the ``add-workload`` command to add a workload to a component. :: | |
| The following ``add-workload`` examples adds a workload to a component. :: |
The intro line for the description needs to use the The following ``command-name`` example... format. All of your examples need to be updates to follow this format.
https://aws.github.io/aws-cli/docs_styleguide.html#description
| --component-name mycustomcomp \ | ||
| --resource-list arn:aws:ec2:eu-west-1:123456789012:instance/i-0f6bcd63ce2f03f | ||
|
|
||
| This command returns to the prompt if successful |
There was a problem hiding this comment.
| This command returns to the prompt if successful | |
| This command produces no output. |
| aws application-insights delete-application \ | ||
| --resource-group-name sqlnew | ||
|
|
||
| This command returns to the prompt if successful. |
There was a problem hiding this comment.
| This command returns to the prompt if successful. | |
| This command produces no output. |
| --resource-group-name MYEC2 \ | ||
| --component-name custom_new | ||
|
|
||
| This command returns to the prompt if successful. |
There was a problem hiding this comment.
| This command returns to the prompt if successful. | |
| This command produces no output. |
| }] | ||
| } | ||
|
|
||
| This command returns to the prompt if successful. |
There was a problem hiding this comment.
| This command returns to the prompt if successful. | |
| This command produces no output. |
| --resource-list "arn:aws:ec2:us-east-1:123456789012:instance/i-012abcd34efghi56" \ | ||
| --new-component-name custom_new | ||
|
|
||
| This command returns to the prompt if successful. |
There was a problem hiding this comment.
| This command returns to the prompt if successful. | |
| This command produces no output. |
| --problem-id p-11b78b15-6f5b-40ca-9da7-12d12345c68b \ | ||
| --update-status RESOLVED | ||
|
|
||
| This command returns to the prompt if successful. |
There was a problem hiding this comment.
| This command returns to the prompt if successful. | |
| This command produces no output. |
| @@ -0,0 +1,31 @@ | |||
| **To list all problems identified in an application** | |||
|
|
|||
| This example uses the ``list-problems`` command to list all the identified problems in an applicaiton. :: | |||
There was a problem hiding this comment.
| This example uses the ``list-problems`` command to list all the identified problems in an applicaiton. :: | |
| This example uses the ``list-problems`` command to list all the identified problems in an application. :: |
| @@ -0,0 +1,22 @@ | |||
| **To create an application from a resource group** | |||
|
|
|||
| This example uses the ``create-application command`` to create an application from a resource group. :: | |||
There was a problem hiding this comment.
| This example uses the ``create-application command`` to create an application from a resource group. :: | |
| The following ``create-application`` creates an application from a resource group. :: |
A few of your examples have a typo where the word "command" was in the code formatting. When fixing the formatting in all your intro lines, please check for this fix as well.
kocanaog
force-pushed
the
cloudwatch-application-insights-cli-docs-examples
branch
from
1eefa77 to
3817ecd
Compare
Issue #, if available:
Description of changes:
Add CLI Examples for Application Insights. Link: https://docs.aws.amazon.com/cli/latest/reference/application-insights/
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.