awscli 1.38.8__py3-none-any.whl → 1.38.9__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of awscli might be problematic. Click here for more details.

Files changed (46) hide show
  1. awscli/__init__.py +1 -1
  2. awscli/examples/codecommit/get-merge-commit.rst +1 -2
  3. awscli/examples/cognito-idp/get-identity-provider-by-identifier.rst +35 -0
  4. awscli/examples/cognito-idp/get-log-delivery-configuration.rst +32 -0
  5. awscli/examples/cognito-idp/get-signing-certificate.rst +14 -13
  6. awscli/examples/cognito-idp/get-ui-customization.rst +22 -19
  7. awscli/examples/cognito-idp/get-user-attribute-verification-code.rst +19 -0
  8. awscli/examples/cognito-idp/get-user-auth-factors.rst +20 -0
  9. awscli/examples/cognito-idp/get-user-pool-mfa-config.rst +33 -0
  10. awscli/examples/cognito-idp/get-user.rst +56 -0
  11. awscli/examples/cognito-idp/global-sign-out.rst +10 -0
  12. awscli/examples/cognito-idp/initiate-auth.rst +27 -0
  13. awscli/examples/cognito-idp/list-devices.rst +23 -25
  14. awscli/examples/cognito-idp/list-groups.rst +32 -0
  15. awscli/examples/cognito-idp/list-identity-providers.rst +29 -0
  16. awscli/examples/cognito-idp/list-resource-servers.rst +43 -0
  17. awscli/examples/cognito-idp/list-tags-for-resource.rst +17 -0
  18. awscli/examples/cognito-idp/list-user-import-jobs.rst +61 -57
  19. awscli/examples/cognito-idp/list-user-pool-clients.rst +32 -0
  20. awscli/examples/cognito-idp/list-user-pools.rst +48 -22
  21. awscli/examples/cognito-idp/list-users.rst +98 -35
  22. awscli/examples/cognito-idp/list-web-authn-credentials.rst +22 -0
  23. awscli/examples/cognito-idp/respond-to-auth-challenge.rst +78 -27
  24. awscli/examples/cognito-idp/revoke-token.rst +11 -0
  25. awscli/examples/cognito-idp/set-log-delivery-configuration.rst +33 -0
  26. awscli/examples/cognito-idp/set-risk-configuration.rst +136 -23
  27. awscli/examples/cognito-idp/set-ui-customization.rst +45 -18
  28. awscli/examples/cognito-idp/set-user-mfa-preference.rst +6 -5
  29. awscli/examples/cognito-idp/set-user-pool-mfa-config.rst +38 -0
  30. awscli/examples/cognito-idp/start-user-import-job.rst +27 -29
  31. awscli/examples/cognito-idp/start-web-authn-registration.rst +47 -0
  32. awscli/examples/cognito-idp/stop-user-import-job.rst +29 -31
  33. awscli/examples/ecs/create-cluster.rst +46 -42
  34. awscli/examples/ecs/put-account-setting.rst +8 -5
  35. awscli/examples/ecs/update-cluster-settings.rst +6 -6
  36. awscli/examples/ecs/update-service.rst +235 -7
  37. {awscli-1.38.8.dist-info → awscli-1.38.9.dist-info}/METADATA +2 -2
  38. {awscli-1.38.8.dist-info → awscli-1.38.9.dist-info}/RECORD +46 -28
  39. {awscli-1.38.8.data → awscli-1.38.9.data}/scripts/aws +0 -0
  40. {awscli-1.38.8.data → awscli-1.38.9.data}/scripts/aws.cmd +0 -0
  41. {awscli-1.38.8.data → awscli-1.38.9.data}/scripts/aws_bash_completer +0 -0
  42. {awscli-1.38.8.data → awscli-1.38.9.data}/scripts/aws_completer +0 -0
  43. {awscli-1.38.8.data → awscli-1.38.9.data}/scripts/aws_zsh_completer.sh +0 -0
  44. {awscli-1.38.8.dist-info → awscli-1.38.9.dist-info}/LICENSE.txt +0 -0
  45. {awscli-1.38.8.dist-info → awscli-1.38.9.dist-info}/WHEEL +0 -0
  46. {awscli-1.38.8.dist-info → awscli-1.38.9.dist-info}/top_level.txt +0 -0
@@ -1,23 +1,136 @@
1
- **To set risk configuration**
2
-
3
- This example sets the risk configuration for a user pool. It sets the sign-up event action to NO_ACTION.
4
-
5
- Command::
6
-
7
- aws cognito-idp set-risk-configuration --user-pool-id us-west-2_aaaaaaaaa --compromised-credentials-risk-configuration EventFilter=SIGN_UP,Actions={EventAction=NO_ACTION}
8
-
9
- Output::
10
-
11
- {
12
- "RiskConfiguration": {
13
- "UserPoolId": "us-west-2_aaaaaaaaa",
14
- "CompromisedCredentialsRiskConfiguration": {
15
- "EventFilter": [
16
- "SIGN_UP"
17
- ],
18
- "Actions": {
19
- "EventAction": "NO_ACTION"
20
- }
21
- }
22
- }
23
- }
1
+ **To set the threat protection risk configuration**
2
+
3
+ The following ``set-risk-configuration`` example configures threat protection messages and actions, compromised credentials, and IP address exceptions in the requested app client. Because of the complexity of the NotifyConfiguration object, JSON input is a best practice for this command. ::
4
+
5
+ aws cognito-idp set-risk-configuration \
6
+ --cli-input-json file://set-risk-configuration.json
7
+
8
+ Contents of ``set-risk-configuration.json``::
9
+
10
+ {
11
+ "AccountTakeoverRiskConfiguration": {
12
+ "Actions": {
13
+ "HighAction": {
14
+ "EventAction": "MFA_REQUIRED",
15
+ "Notify": true
16
+ },
17
+ "LowAction": {
18
+ "EventAction": "NO_ACTION",
19
+ "Notify": true
20
+ },
21
+ "MediumAction": {
22
+ "EventAction": "MFA_IF_CONFIGURED",
23
+ "Notify": true
24
+ }
25
+ },
26
+ "NotifyConfiguration": {
27
+ "BlockEmail": {
28
+ "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
29
+ "Subject": "Blocked sign-in attempt",
30
+ "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
31
+ },
32
+ "From": "admin@example.com",
33
+ "MfaEmail": {
34
+ "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
35
+ "Subject": "New sign-in attempt",
36
+ "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
37
+ },
38
+ "NoActionEmail": {
39
+ "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
40
+ "Subject": "New sign-in attempt",
41
+ "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
42
+ },
43
+ "ReplyTo": "admin@example.com",
44
+ "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com"
45
+ }
46
+ },
47
+ "ClientId": "1example23456789",
48
+ "CompromisedCredentialsRiskConfiguration": {
49
+ "Actions": {
50
+ "EventAction": "BLOCK"
51
+ },
52
+ "EventFilter": [
53
+ "PASSWORD_CHANGE",
54
+ "SIGN_UP",
55
+ "SIGN_IN"
56
+ ]
57
+ },
58
+ "RiskExceptionConfiguration": {
59
+ "BlockedIPRangeList": [
60
+ "192.0.2.1/32",
61
+ "192.0.2.2/32"
62
+ ],
63
+ "SkippedIPRangeList": [
64
+ "203.0.113.1/32",
65
+ "203.0.113.2/32"
66
+ ]
67
+ },
68
+ "UserPoolId": "us-west-2_EXAMPLE"
69
+ }
70
+
71
+ Output::
72
+
73
+ {
74
+ "RiskConfiguration": {
75
+ "AccountTakeoverRiskConfiguration": {
76
+ "Actions": {
77
+ "HighAction": {
78
+ "EventAction": "MFA_REQUIRED",
79
+ "Notify": true
80
+ },
81
+ "LowAction": {
82
+ "EventAction": "NO_ACTION",
83
+ "Notify": true
84
+ },
85
+ "MediumAction": {
86
+ "EventAction": "MFA_IF_CONFIGURED",
87
+ "Notify": true
88
+ }
89
+ },
90
+ "NotifyConfiguration": {
91
+ "BlockEmail": {
92
+ "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
93
+ "Subject": "Blocked sign-in attempt",
94
+ "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
95
+ },
96
+ "From": "admin@example.com",
97
+ "MfaEmail": {
98
+ "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
99
+ "Subject": "New sign-in attempt",
100
+ "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
101
+ },
102
+ "NoActionEmail": {
103
+ "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
104
+ "Subject": "New sign-in attempt",
105
+ "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
106
+ },
107
+ "ReplyTo": "admin@example.com",
108
+ "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com"
109
+ }
110
+ },
111
+ "ClientId": "1example23456789",
112
+ "CompromisedCredentialsRiskConfiguration": {
113
+ "Actions": {
114
+ "EventAction": "BLOCK"
115
+ },
116
+ "EventFilter": [
117
+ "PASSWORD_CHANGE",
118
+ "SIGN_UP",
119
+ "SIGN_IN"
120
+ ]
121
+ },
122
+ "RiskExceptionConfiguration": {
123
+ "BlockedIPRangeList": [
124
+ "192.0.2.1/32",
125
+ "192.0.2.2/32"
126
+ ],
127
+ "SkippedIPRangeList": [
128
+ "203.0.113.1/32",
129
+ "203.0.113.2/32"
130
+ ]
131
+ },
132
+ "UserPoolId": "us-west-2_EXAMPLE"
133
+ }
134
+ }
135
+
136
+ For more information, see `Threat protection <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html>`__ in the *Amazon Cognito Developer Guide*.
@@ -1,18 +1,45 @@
1
- **To set UI customization**
2
-
3
- This example customizes the CSS setting for a user pool.
4
-
5
- Command::
6
-
7
- aws cognito-idp set-ui-customization --user-pool-id us-west-2_aaaaaaaaa --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n"
8
-
9
- Output::
10
-
11
- {
12
- "UICustomization": {
13
- "UserPoolId": "us-west-2_aaaaaaaaa",
14
- "ClientId": "ALL",
15
- "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n",
16
- "CSSVersion": "20190129172214"
17
- }
18
- }
1
+ **Example 1: To customize the classic hosted UI for an app client**
2
+
3
+ The following ``set-ui-customization`` example configures the requested app client with some custom CSS and with the Amazon Cognito logo as the application logo. ::
4
+
5
+ aws cognito-idp set-ui-customization \
6
+ --user-pool-id us-west-2_ywDJHlIfU \
7
+ --client-id 14pq32c5q2uq2q7keorloqvb23 \
8
+ --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n" \
9
+ --image-file iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCC
10
+
11
+ Output::
12
+
13
+ {
14
+ "UICustomization": {
15
+ "UserPoolId": "us-west-2_ywDJHlIfU",
16
+ "ClientId": "14pq32c5q2uq2q7keorloqvb23",
17
+ "ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg",
18
+ "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n",
19
+ "CSSVersion": "20250117005911"
20
+ }
21
+ }
22
+
23
+ **Example 2: To set the default UI customization for all app clients**
24
+
25
+ The following ``set-ui-customization`` example configures the requested user pool for all app clients that don't have a client-specific configuration. The command applies some custom CSS and with the Amazon Cognito logo as the application logo. ::
26
+
27
+ aws cognito-idp set-ui-customization \
28
+ --user-pool-id us-west-2_ywDJHlIfU \
29
+ --client-id ALL \
30
+ --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n" \
31
+ --image-file iVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCC
32
+
33
+ Output::
34
+
35
+ {
36
+ "UICustomization": {
37
+ "UserPoolId": "us-west-2_ywDJHlIfU",
38
+ "ClientId": "14pq32c5q2uq2q7keorloqvb23",
39
+ "ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg",
40
+ "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n",
41
+ "CSSVersion": "20250117005911"
42
+ }
43
+ }
44
+
45
+ For more information, see `Hosted UI (classic) branding <https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html>`__ in the *Amazon Cognito Developer Guide*.
@@ -1,12 +1,13 @@
1
- **To set user MFA settings**
1
+ **To set a user's MFA preference**
2
2
 
3
- The following ``set-user-mfa-preference`` example modifies the MFA delivery options. It changes the MFA delivery medium to SMS. ::
3
+ The following ``set-user-mfa-preference`` example configures the current user to use TOTP MFA and disables all other MFA factors. ::
4
4
 
5
5
  aws cognito-idp set-user-mfa-preference \
6
- --access-token "eyJra12345EXAMPLE" \
6
+ --access-token eyJra456defEXAMPLE \
7
7
  --software-token-mfa-settings Enabled=true,PreferredMfa=true \
8
- --sms-mfa-settings Enabled=false,PreferredMfa=false
8
+ --sms-mfa-settings Enabled=false,PreferredMfa=false \
9
+ --email-mfa-settings Enabled=false,PreferredMfa=false
9
10
 
10
11
  This command produces no output.
11
12
 
12
- For more information, see `Adding MFA to a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html>`__ in the *Amazon Cognito Developer Guide*.
13
+ For more information, see `Adding MFA <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html>`__ in the *Amazon Cognito Developer Guide*.
@@ -0,0 +1,38 @@
1
+ **To configure user pool MFA and WebAuthn**
2
+
3
+ The following ``set-user-pool-mfa-config`` example configures the requested user pool with optional MFA with all available MFA methods, and sets the WebAuthn configuration. ::
4
+
5
+ aws cognito-idp set-user-pool-mfa-config \
6
+ --user-pool-id us-west-2_EXAMPLE \
7
+ --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}" \
8
+ --software-token-mfa-configuration Enabled=true \
9
+ --email-mfa-configuration "Message=\"Your OTP for MFA or sign-in: use {####}\",Subject=\"OTP test\"" \
10
+ --mfa-configuration OPTIONAL \
11
+ --web-authn-configuration RelyingPartyId=auth.example.com,UserVerification=preferred
12
+
13
+ Output::
14
+
15
+ {
16
+ "EmailMfaConfiguration": {
17
+ "Message": "Your OTP for MFA or sign-in: use {####}",
18
+ "Subject": "OTP test"
19
+ },
20
+ "MfaConfiguration": "OPTIONAL",
21
+ "SmsMfaConfiguration": {
22
+ "SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.",
23
+ "SmsConfiguration": {
24
+ "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
25
+ "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-SMS-Role",
26
+ "SnsRegion": "us-west-2"
27
+ }
28
+ },
29
+ "SoftwareTokenMfaConfiguration": {
30
+ "Enabled": true
31
+ },
32
+ "WebAuthnConfiguration": {
33
+ "RelyingPartyId": "auth.example.com",
34
+ "UserVerification": "preferred"
35
+ }
36
+ }
37
+
38
+ For more information, see `Adding MFA <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html>`__ and `Passkey sign-in <https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey>`__ in the *Amazon Cognito Developer Guide*.
@@ -1,29 +1,27 @@
1
- **To start a user import job**
2
-
3
- This example starts a user input job.
4
-
5
- For more information about importing users, see `Importing Users into User Pools From a CSV File`_.
6
-
7
- Command::
8
-
9
- aws cognito-idp start-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW
10
-
11
- Output::
12
-
13
- {
14
- "UserImportJob": {
15
- "JobName": "import-Test10",
16
- "JobId": "import-lmpxSOuIzH",
17
- "UserPoolId": "us-west-2_aaaaaaaaa",
18
- "PreSignedUrl": "PRE_SIGNED_URL",
19
- "CreationDate": 1548278378.928,
20
- "StartDate": 1548278397.334,
21
- "Status": "Pending",
22
- "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
23
- "ImportedUsers": 0,
24
- "SkippedUsers": 0,
25
- "FailedUsers": 0
26
- }
27
- }
28
-
29
- .. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html
1
+ **To start an import job**
2
+
3
+ The following ``start-user-import-job`` example starts the requested import job in the requested user pool. ::
4
+
5
+ aws cognito-idp start-user-import-job \
6
+ --user-pool-id us-west-2_EXAMPLE \
7
+ --job-id import-mAgUtd8PMm
8
+
9
+ Output::
10
+
11
+ {
12
+ "UserImportJob": {
13
+ "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role",
14
+ "CreationDate": 1736442975.904,
15
+ "FailedUsers": 0,
16
+ "ImportedUsers": 0,
17
+ "JobId": "import-mAgUtd8PMm",
18
+ "JobName": "Customer import",
19
+ "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]",
20
+ "SkippedUsers": 0,
21
+ "StartDate": 1736443020.081,
22
+ "Status": "Pending",
23
+ "UserPoolId": "us-west-2_EXAMPLE"
24
+ }
25
+ }
26
+
27
+ For more information, see `Importing users into a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html>`__ in the *Amazon Cognito Developer Guide*.
@@ -0,0 +1,47 @@
1
+ **To get passkey registration information for a signed-in user**
2
+
3
+ The following ``start-web-authn-registration`` example generates WebAuthn registration options for the current user. ::
4
+
5
+ aws cognito-idp start-web-authn-registration \
6
+ --access-token eyJra456defEXAMPLE
7
+
8
+ Output::
9
+
10
+ {
11
+ "CredentialCreationOptions": {
12
+ "authenticatorSelection": {
13
+ "requireResidentKey": true,
14
+ "residentKey": "required",
15
+ "userVerification": "preferred"
16
+ },
17
+ "challenge": "wxvbDicyqQqvF2EXAMPLE",
18
+ "excludeCredentials": [
19
+ {
20
+ "id": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE",
21
+ "type": "public-key"
22
+ }
23
+ ],
24
+ "pubKeyCredParams": [
25
+ {
26
+ "alg": -7,
27
+ "type": "public-key"
28
+ },
29
+ {
30
+ "alg": -257,
31
+ "type": "public-key"
32
+ }
33
+ ],
34
+ "rp": {
35
+ "id": "auth.example.com",
36
+ "name": "auth.example.com"
37
+ },
38
+ "timeout": 60000,
39
+ "user": {
40
+ "displayName": "testuser",
41
+ "id": "ZWFhZDAyMTktMjExNy00MzlmLThkNDYtNGRiMjBlNEXAMPLE",
42
+ "name": "testuser"
43
+ }
44
+ }
45
+ }
46
+
47
+ For more information, see `Passkey sign-in <https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey>`__ in the *Amazon Cognito Developer Guide*.
@@ -1,31 +1,29 @@
1
- **To stop a user import job**
2
-
3
- This example stops a user input job.
4
-
5
- For more information about importing users, see `Importing Users into User Pools From a CSV File`_.
6
-
7
- Command::
8
-
9
- aws cognito-idp stop-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW
10
-
11
- Output::
12
-
13
- {
14
- "UserImportJob": {
15
- "JobName": "import-Test5",
16
- "JobId": "import-Fx0kARISFL",
17
- "UserPoolId": "us-west-2_aaaaaaaaa",
18
- "PreSignedUrl": "PRE_SIGNED_URL",
19
- "CreationDate": 1548278576.259,
20
- "StartDate": 1548278623.366,
21
- "CompletionDate": 1548278626.741,
22
- "Status": "Stopped",
23
- "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
24
- "ImportedUsers": 0,
25
- "SkippedUsers": 0,
26
- "FailedUsers": 0,
27
- "CompletionMessage": "The Import Job was stopped by the developer."
28
- }
29
- }
30
-
31
- .. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html
1
+ **To stop an import job**
2
+
3
+ The following ``stop-user-import-job`` example stops the requested running user import job in the requested user pool. ::
4
+
5
+ aws cognito-idp stop-user-import-job \
6
+ --user-pool-id us-west-2_EXAMPLE \
7
+ --job-id import-mAgUtd8PMm
8
+
9
+ Output::
10
+
11
+ {
12
+ "UserImportJob": {
13
+ "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role",
14
+ "CompletionDate": 1736443496.379,
15
+ "CompletionMessage": "The Import Job was stopped by the developer.",
16
+ "CreationDate": 1736443471.781,
17
+ "FailedUsers": 0,
18
+ "ImportedUsers": 0,
19
+ "JobId": "import-mAgUtd8PMm",
20
+ "JobName": "Customer import",
21
+ "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]",
22
+ "SkippedUsers": 0,
23
+ "StartDate": 1736443494.154,
24
+ "Status": "Stopped",
25
+ "UserPoolId": "us-west-2_EXAMPLE"
26
+ }
27
+ }
28
+
29
+ For more information, see `Importing users into a user pool <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html>`__ in the *Amazon Cognito Developer Guide*.
@@ -1,9 +1,11 @@
1
1
  **Example 1: To create a new cluster**
2
2
 
3
- The following ``create-cluster`` example creates a cluster. ::
3
+ The following ``create-cluster`` example creates a cluster named ``MyCluster`` and enables CloudWatch Container Insights with enhanced observability. ::
4
4
 
5
5
  aws ecs create-cluster \
6
- --cluster-name MyCluster
6
+ --cluster-name MyCluster \
7
+ --settings name=containerInsights,value=enhanced
8
+
7
9
 
8
10
  Output::
9
11
 
@@ -17,6 +19,12 @@ Output::
17
19
  "runningTasksCount": 0,
18
20
  "activeServicesCount": 0,
19
21
  "statistics": [],
22
+ "settings": [
23
+ {
24
+ "name": "containerInsights",
25
+ "value": "enhanced"
26
+ }
27
+ ],
20
28
  "tags": []
21
29
  }
22
30
  }
@@ -25,7 +33,7 @@ For more information, see `Creating a Cluster <https://docs.aws.amazon.com/Amazo
25
33
 
26
34
  **Example 2: To create a new cluster using capacity providers**
27
35
 
28
- The following ``create-cluster`` example creates a cluster and associates two existing capacity providers with it. The ``create-capacity-provider`` command is used to create a capacity provider. Specifying a default capacity provider strategy is optional, but recommended. In this example, we create a cluster named ``MyCluster`` and associate the ``MyCapacityProvider1`` and ``MyCapacityProvider2`` capacity providers with it. A default capacity provider strategy is specified that spreads the tasks evenly across both capacity providers.
36
+ The following ``create-cluster`` example creates a cluster and associates two existing capacity providers with it. The ``create-capacity-provider`` command is used to create a capacity provider. Specifying a default capacity provider strategy is optional, but recommended. In this example, we create a cluster named ``MyCluster`` and associate the ``MyCapacityProvider1`` and ``MyCapacityProvider2`` capacity providers with it. A default capacity provider strategy is specified that spreads the tasks evenly across both capacity providers. ::
29
37
 
30
38
  aws ecs create-cluster \
31
39
  --cluster-name MyCluster \
@@ -68,18 +76,18 @@ Output::
68
76
  ],
69
77
  "attachments": [
70
78
  {
71
- "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
72
- "type": "asp",
73
- "status": "PRECREATED",
74
- "details": [
75
- {
76
- "name": "capacityProviderName",
77
- "value": "MyCapacityProvider1"
78
- },
79
- {
80
- "name": "scalingPlanName",
81
- "value": "ECSManagedAutoScalingPlan-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
82
- }
79
+ "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
80
+ "type": "asp",
81
+ "status": "PRECREATED",
82
+ "details": [
83
+ {
84
+ "name": "capacityProviderName",
85
+ "value": "MyCapacityProvider1"
86
+ },
87
+ {
88
+ "name": "scalingPlanName",
89
+ "value": "ECSManagedAutoScalingPlan-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
90
+ }
83
91
  ]
84
92
  },
85
93
  {
@@ -106,39 +114,35 @@ For more information, see `Cluster capacity providers <https://docs.aws.amazon.c
106
114
 
107
115
  **Example 3: To create a new cluster with multiple tags**
108
116
 
109
- The following ``create-cluster`` example creates a cluster with multiple tags. For more information about adding tags using shorthand syntax, see `Using Shorthand Syntax with the AWS Command Line Interface <https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-shorthand.html>`_ in the *AWS CLI User Guide*. ::
117
+ The following ``create-cluster`` example creates a cluster with multiple tags. For more information about adding tags using shorthand syntax, see `Using Shorthand Syntax with the AWS Command Line Interface <https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-shorthand.html>`__ in the *AWS CLI User Guide*. ::
110
118
 
111
119
  aws ecs create-cluster \
112
120
  --cluster-name MyCluster \
113
- --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3
121
+ --tags key=key1,value=value1 key=key2,value=value2
114
122
 
115
123
  Output::
116
124
 
117
- {
118
- "cluster": {
119
- "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
120
- "clusterName": "MyCluster",
121
- "status": "ACTIVE",
122
- "registeredContainerInstancesCount": 0,
123
- "pendingTasksCount": 0,
124
- "runningTasksCount": 0,
125
- "activeServicesCount": 0,
126
- "statistics": [],
127
- "tags": [
128
- {
129
- "key": "key1",
130
- "value": "value1"
131
- },
132
- {
133
- "key": "key2",
134
- "value": "value2"
135
- },
136
- {
137
- "key": "key3",
138
- "value": "value3"
139
- }
140
- ]
125
+ {
126
+ "cluster": {
127
+ "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
128
+ "clusterName": "MyCluster",
129
+ "status": "ACTIVE",
130
+ "registeredContainerInstancesCount": 0,
131
+ "pendingTasksCount": 0,
132
+ "runningTasksCount": 0,
133
+ "activeServicesCount": 0,
134
+ "statistics": [],
135
+ "tags": [
136
+ {
137
+ "key": "key1",
138
+ "value": "value1"
139
+ },
140
+ {
141
+ "key": "key2",
142
+ "value": "value2"
143
+ }
144
+ ]
141
145
  }
142
146
  }
143
147
 
144
- For more information, see `Creating a Cluster <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html>`__ in the *Amazon ECS Developer Guide*.
148
+ For more information, see `Creating a Cluster <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html>`__ in the *Amazon ECS Developer Guide*.