CLI examples ecs, cognito-idp #9312
Conversation
elysahall
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #9312 +/- ##
=======================================
Coverage 0.08% 0.08%
=======================================
Files 210 210
Lines 16984 16984
=======================================
Hits 14 14
Misses 16970 16970 ☔ View full report in Codecov by Sentry. |
|
|
||
| **To list user pools** | ||
|
|
||
| The following ``list-user-pools`` example lists the available user pools in the AWS account of the current CLI credentials. :: |
There was a problem hiding this comment.
non-blocking nit: should the description mention the fact that it'll list at most 3 results? at face-value I'd expect the command to return all of them based on the descripion
| } | ||
| **Example 1: To list users with a server-side filter** | ||
|
|
||
| The following ``list-users`` example lists all users in the requested user pool whose email addresses begin with "testuser". :: |
There was a problem hiding this comment.
I don't think this lists all users since we specify 3 max items, right?
|
|
||
| **Example 2: To list users with a client-side filter** | ||
|
|
||
| The following ``list-users`` example lists the attributes of those two of the first three users who have an attribute, in this case their email address, that contains the email domain "@example.com". If other attributes contained this string, they would also be displayed. The second user has no attributes that match the query and is excluded from the displayed output, but not from the server response. :: |
There was a problem hiding this comment.
nit: I wouldn't say "of those two of the first three users", I think just "of the three users returned from server" or something similar, since the command doesn't enforce two users in the final result; it just so happens that there are two users that match the query in this case
| --sms-mfa-configuration SmsAuthenticationMessage=\"Your\ OTP\ for\ MFA\ or\ sign-in\:\ use\ \{\#\#\#\#\}\.\",SmsConfiguration=\{SnsCallerArn=arn\:aws\:iam\:\:123456789012\:role\/service\-role\/test\-SMS\-Role,ExternalId=a1b2c3d4\-5678\-90ab\-cdef\-EXAMPLE11111,SnsRegion=us\-west\-2\} \ | ||
| --software-token-mfa-configuration Enabled=true \ | ||
| --email-mfa-configuration Message=\"Your\ OTP\ for\ MFA\ or\ sign\-in\:\ use\ \{\#\#\#\#\}\",Subject=\"OTP\ test\" \ |
There was a problem hiding this comment.
nit: Are these \ escapes necessary / achieving anything?
| { | ||
| "name": "containerInsights", | ||
| "value": "enhanced" | ||
| } |
There was a problem hiding this comment.
Is this indentation correct? I know it doesn't matter as far as JSON is concerned, but double check that CLI doesn't indent these structs within the list.
| **Example 1: To change the task definition used in a service** | ||
| **Example 1: To change the number of my-http-serviceks in a service** |
There was a problem hiding this comment.
Looks like a typo in the title.
Suggestion: change title to "To change the number of instantiations of the task in a service"
|
|
||
| The following ``update-service`` example updates the ``my-http-service`` service to use the ``amazon-ecs-sample`` task definition. :: | ||
| The following ``update-service`` example updates the desired my-http-servicek count of the service ``my-http-service`` to 2. :: |
There was a problem hiding this comment.
typo.
suggestion: "...example updates the desired task count of the service my-http-service to 2."
|
|
||
| aws ecs update-service --service my-http-service --desired-count 3 | ||
| For more information, see `Updating a Service <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service.html>`__ in the *Amazon ECS Developer Guide*. |
There was a problem hiding this comment.
Broken link. As of writing, this link results in a 404 not found followed by a redirect.
| } | ||
|
|
||
| For more information, see `Updating a Service <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service.html>`__ in the *Amazon ECS Developer Guide*. |
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.