awscli 1.36.25__py3-none-any.whl → 1.36.26__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 (70) hide show
  1. awscli/__init__.py +1 -1
  2. awscli/examples/cloudfront/create-distribution.rst +118 -118
  3. awscli/examples/cloudfront/get-distribution-config.rst +6 -10
  4. awscli/examples/cloudfront/list-distributions.rst +29 -249
  5. awscli/examples/cloudfront/update-distribution.rst +16 -24
  6. awscli/examples/cognito-idp/admin-disable-provider-for-user.rst +9 -0
  7. awscli/examples/cognito-idp/admin-disable-user.rst +9 -0
  8. awscli/examples/cognito-idp/admin-enable-user.rst +9 -0
  9. awscli/examples/cognito-idp/admin-get-device.rst +51 -8
  10. awscli/examples/cognito-idp/admin-initiate-auth.rst +24 -25
  11. awscli/examples/cognito-idp/admin-link-provider-for-user.rst +10 -0
  12. awscli/examples/cognito-idp/admin-list-devices.rst +53 -7
  13. awscli/examples/cognito-idp/admin-list-user-auth-events.rst +40 -8
  14. awscli/examples/cognito-idp/admin-respond-to-auth-challenge.rst +29 -0
  15. awscli/examples/cognito-idp/admin-set-user-password.rst +13 -0
  16. awscli/examples/cognito-idp/admin-user-global-sign-out.rst +9 -0
  17. awscli/examples/cognito-idp/associate-software-token.rst +14 -0
  18. awscli/examples/cognito-idp/confirm-device.rst +16 -0
  19. awscli/examples/cognito-idp/create-identity-provider.rst +102 -0
  20. awscli/examples/cognito-idp/create-resource-server.rst +31 -0
  21. awscli/examples/cognito-idp/create-user-pool-client.rst +86 -18
  22. awscli/examples/cognito-idp/create-user-pool-domain.rst +23 -5
  23. awscli/examples/cognito-idp/delete-user-attributes.rst +8 -5
  24. awscli/examples/cognito-idp/describe-user-pool.rst +347 -238
  25. awscli/examples/cognito-idp/get-device.rst +50 -0
  26. awscli/examples/cognito-idp/get-group.rst +15 -12
  27. awscli/examples/cognito-idp/list-devices.rst +53 -0
  28. awscli/examples/ec2/describe-capacity-reservation-fleets.rst +3 -3
  29. awscli/examples/ec2/import-snapshot.rst +1 -1
  30. awscli/examples/ecr-public/batch-delete-image.rst +92 -0
  31. awscli/examples/ecr-public/create-repository.rst +3 -2
  32. awscli/examples/ecr-public/delete-repository-policy.rst +17 -0
  33. awscli/examples/ecr-public/delete-repository.rst +1 -1
  34. awscli/examples/ecr-public/describe-image-tags.rst +25 -0
  35. awscli/examples/ecr-public/describe-images.rst +82 -0
  36. awscli/examples/ecr-public/get-authorization-token.rst +32 -0
  37. awscli/examples/ecr-public/get-repository-policy.rst +17 -0
  38. awscli/examples/ecr-public/put-repository-catalog-data.rst +50 -0
  39. awscli/examples/ecr-public/set-repository-policy.rst +118 -0
  40. awscli/examples/ecs/capacity-provider-update.rst +33 -0
  41. awscli/examples/ecs/get-task-protection.rst +21 -0
  42. awscli/examples/ecs/update-cluster.rst +176 -0
  43. awscli/examples/ecs/update-task-protection.rst +46 -0
  44. awscli/examples/inspector2/associate-member.rst +14 -0
  45. awscli/examples/inspector2/disassociate-member.rst +14 -0
  46. awscli/examples/inspector2/get-member.rst +17 -0
  47. awscli/examples/inspector2/list-members.rst +83 -0
  48. awscli/examples/ivs-realtime/create-ingest-configuration.rst +25 -0
  49. awscli/examples/ivs-realtime/create-stage.rst +6 -2
  50. awscli/examples/ivs-realtime/delete-ingest-configuration.rst +22 -0
  51. awscli/examples/ivs-realtime/get-ingest-configuration.rst +24 -0
  52. awscli/examples/ivs-realtime/get-stage.rst +4 -2
  53. awscli/examples/ivs-realtime/list-ingest-configurations.rst +23 -0
  54. awscli/examples/ivs-realtime/update-ingest-configuration.rst +25 -0
  55. awscli/examples/ivs-realtime/update-stage.rst +3 -1
  56. awscli/examples/s3/sync.rst +1 -1
  57. awscli/examples/s3api/put-object.rst +15 -7
  58. awscli/examples/workmail/list-organizations.rst +1 -1
  59. {awscli-1.36.25.dist-info → awscli-1.36.26.dist-info}/METADATA +2 -2
  60. {awscli-1.36.25.dist-info → awscli-1.36.26.dist-info}/RECORD +68 -36
  61. awscli/examples/cognito-idp/admim-disable-user.rst +0 -8
  62. awscli/examples/cognito-idp/admim-enable-user.rst +0 -8
  63. {awscli-1.36.25.data → awscli-1.36.26.data}/scripts/aws +0 -0
  64. {awscli-1.36.25.data → awscli-1.36.26.data}/scripts/aws.cmd +0 -0
  65. {awscli-1.36.25.data → awscli-1.36.26.data}/scripts/aws_bash_completer +0 -0
  66. {awscli-1.36.25.data → awscli-1.36.26.data}/scripts/aws_completer +0 -0
  67. {awscli-1.36.25.data → awscli-1.36.26.data}/scripts/aws_zsh_completer.sh +0 -0
  68. {awscli-1.36.25.dist-info → awscli-1.36.26.dist-info}/LICENSE.txt +0 -0
  69. {awscli-1.36.25.dist-info → awscli-1.36.26.dist-info}/WHEEL +0 -0
  70. {awscli-1.36.25.dist-info → awscli-1.36.26.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,118 @@
1
+ **Example 1: To set a repository policy to allow a pull on the repository**
2
+
3
+ The following ``set-repository-policy`` example applies an ECR public repository policy to the specified repository to control access permissions. ::
4
+
5
+ aws ecr-public set-repository-policy \
6
+ --repository-name project-a/nginx-web-app \
7
+ --policy-text file://my-repository-policy.json
8
+
9
+ Contents of ``my-repository-policy.json``::
10
+
11
+ {
12
+ "Version" : "2008-10-17",
13
+ "Statement" : [
14
+ {
15
+ "Sid" : "allow public pull",
16
+ "Effect" : "Allow",
17
+ "Principal" : "*",
18
+ "Action" : [
19
+ "ecr:BatchCheckLayerAvailability",
20
+ "ecr:BatchGetImage",
21
+ "ecr:GetDownloadUrlForLayer"
22
+ ]
23
+ }
24
+ ]
25
+ }
26
+
27
+ Output::
28
+
29
+ {
30
+ "registryId": "12345678901",
31
+ "repositoryName": "project-a/nginx-web-app",
32
+ "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}"
33
+ }
34
+
35
+ For more information, see `Setting a repository policy statement <https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html>`__ in the *Amazon ECR Public User Guide*.
36
+
37
+ **Example 2: To set a repository policy to allow an IAM user within your account to push images**
38
+
39
+ The following ``set-repository-policy`` example allows an IAM user within your account to push images using to an ECR repository in your AWS account using the input file named ``file://my-repository-policy.json`` as policy text. ::
40
+
41
+ aws ecr-public set-repository-policy \
42
+ --repository-name project-a/nginx-web-app \
43
+ --policy-text file://my-repository-policy.json
44
+
45
+ Contents of ``my-repository-policy.json``::
46
+
47
+ {
48
+ "Version": "2008-10-17",
49
+ "Statement": [
50
+ {
51
+ "Sid": "AllowPush",
52
+ "Effect": "Allow",
53
+ "Principal": {
54
+ "AWS": [
55
+ "arn:aws:iam::account-id:user/push-pull-user-1",
56
+ "arn:aws:iam::account-id:user/push-pull-user-2"
57
+ ]
58
+ },
59
+ "Action": [
60
+ "ecr-public:BatchCheckLayerAvailability",
61
+ "ecr-public:PutImage",
62
+ "ecr-public:InitiateLayerUpload",
63
+ "ecr-public:UploadLayerPart",
64
+ "ecr-public:CompleteLayerUpload"
65
+ ]
66
+ }
67
+ ]
68
+ }
69
+
70
+ Output::
71
+
72
+ {
73
+ "registryId": "12345678901",
74
+ "repositoryName": "project-a/nginx-web-app",
75
+ "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"AllowPush\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : [ \"arn:aws:iam::12345678901:user/admin\", \"arn:aws:iam::12345678901:user/eksuser1\" ]\n },\n \"Action\" : [ \"ecr-public:BatchCheckLayerAvailability\", \"ecr-public:PutImage\", \"ecr-public:InitiateLayerUpload\", \"ecr-public:UploadLayerPart\", \"ecr-public:CompleteLayerUpload\" ]\n } ]\n}"
76
+ }
77
+
78
+ For more information, see `Setting a repository policy statement <https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html>`__ in the *Amazon ECR Public User Guide*.
79
+
80
+ **Example 3: To set a repository policy to allow an IAM user from different account to push images**
81
+
82
+ The following ``set-repository-policy`` example allows a specific account to push images using cli input file://my-repository-policy.json in your AWS account. ::
83
+
84
+ aws ecr-public set-repository-policy \
85
+ --repository-name project-a/nginx-web-app \
86
+ --policy-text file://my-repository-policy.json
87
+
88
+ Contents of ``my-repository-policy.json``::
89
+
90
+ {
91
+ "Version": "2008-10-17",
92
+ "Statement": [
93
+ {
94
+ "Sid": "AllowCrossAccountPush",
95
+ "Effect": "Allow",
96
+ "Principal": {
97
+ "AWS": "arn:aws:iam::other-or-same-account-id:role/RoleName"
98
+ },
99
+ "Action": [
100
+ "ecr-public:BatchCheckLayerAvailability",
101
+ "ecr-public:PutImage",
102
+ "ecr-public:InitiateLayerUpload",
103
+ "ecr-public:UploadLayerPart",
104
+ "ecr-public:CompleteLayerUpload"
105
+ ]
106
+ }
107
+ ]
108
+ }
109
+
110
+ Output::
111
+
112
+ {
113
+ "registryId": "12345678901",
114
+ "repositoryName": "project-a/nginx-web-app",
115
+ "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"AllowCrossAccountPush\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::12345678901:role/RoleName\"\n },\n \"Action\" : [ \"ecr-public:BatchCheckLayerAvailability\", \"ecr-public:PutImage\", \"ecr-public:InitiateLayerUpload\", \"ecr-public:UploadLayerPart\", \"ecr-public:CompleteLayerUpload\" ]\n } ]\n}"
116
+ }
117
+
118
+ For more information, see `Public repository policy examples <https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html>`__ in the *Amazon ECR Public User Guide*.
@@ -0,0 +1,33 @@
1
+ **Update the capacity provider in an ECS cluster**
2
+
3
+ The following ``update-capacity-provider`` example shows how we can modify the parameters of the capacity provider in an ECS cluster. ::
4
+
5
+ aws ecs update-capacity-provider \
6
+ --name Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt \
7
+ --auto-scaling-group-provider "managedScaling={status=DISABLED,targetCapacity=50,minimumScalingStepSize=2,maximumScalingStepSize=30,instanceWarmupPeriod=200},managedTerminationProtection=DISABLED,managedDraining=DISABLED"
8
+
9
+ Output::
10
+
11
+ {
12
+ "capacityProvider": {
13
+ "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
14
+ "name": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
15
+ "status": "ACTIVE",
16
+ "autoScalingGroupProvider": {
17
+ "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:424941d1-b43f-4a17-adbb-08b6a6e397e1:autoScalingGroupName/Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-ECSAutoScalingGroup-f44jrQHS2nRB",
18
+ "managedScaling": {
19
+ "status": "ENABLED",
20
+ "targetCapacity": 100,
21
+ "minimumScalingStepSize": 1,
22
+ "maximumScalingStepSize": 10000,
23
+ "instanceWarmupPeriod": 300
24
+ },
25
+ "managedTerminationProtection": "DISABLED",
26
+ "managedDraining": "ENABLED"
27
+ },
28
+ "updateStatus": "UPDATE_IN_PROGRESS",
29
+ "tags": []
30
+ }
31
+ }
32
+
33
+ For more information on Capacity Provider, see `Amazon ECS capacity providers for the EC2 launch type <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html>`__ in the *Amazon ECS Developer Guide*.
@@ -0,0 +1,21 @@
1
+ **Retrieve the protection status of task in ECS service**
2
+
3
+ The following ``get-task-protection`` provides the protection status of ECS tasks that belong to Amazon ECS service. ::
4
+
5
+ aws ecs get-task-protection \
6
+ --cluster ECS-project-update-cluster \
7
+ --tasks c43ed3b1331041f289316f958adb6a24
8
+
9
+ Output::
10
+
11
+ {
12
+ "protectedTasks": [
13
+ {
14
+ "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24",
15
+ "protectionEnabled": false
16
+ }
17
+ ],
18
+ "failures": []
19
+ }
20
+
21
+ For more formation on task protection, see `Protect your Amazon ECS tasks from being terminated by scale-in events <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html>`__ in the *Amazon ECS Developer Guide*.
@@ -0,0 +1,176 @@
1
+ **Example 1: Update ECS cluster enabling containerInsights**
2
+
3
+ The following ``update-cluster`` updates the containerInsights value to ``enabled`` in an already created cluster. By default, it is disabled. ::
4
+
5
+ aws ecs update-cluster \
6
+ --cluster ECS-project-update-cluster \
7
+ --settings name=containerInsights,value=enabled
8
+
9
+ Output::
10
+
11
+ "cluster": {
12
+ "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster",
13
+ "clusterName": "ECS-project-update-cluster",
14
+ "status": "ACTIVE",
15
+ "registeredContainerInstancesCount": 0,
16
+ "runningTasksCount": 0,
17
+ "pendingTasksCount": 0,
18
+ "activeServicesCount": 0,
19
+ "statistics": [],
20
+ "tags": [],
21
+ "settings": [
22
+ {
23
+ "name": "containerInsights",
24
+ "value": "enabled"
25
+ }
26
+ ],
27
+ "capacityProviders": [
28
+ "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
29
+ ],
30
+ "defaultCapacityProviderStrategy": [
31
+ {
32
+ "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
33
+ "weight": 1,
34
+ "base": 0
35
+ }
36
+ ],
37
+ "attachments": [
38
+ {
39
+ "id": "069d002b-7634-42e4-b1d4-544f4c8f6380",
40
+ "type": "as_policy",
41
+ "status": "CREATED",
42
+ "details": [
43
+ {
44
+ "name": "capacityProviderName",
45
+ "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
46
+ },
47
+ {
48
+ "name": "scalingPolicyName",
49
+ "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93"
50
+ }
51
+ ]
52
+ },
53
+ {
54
+ "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a",
55
+ "type": "managed_draining",
56
+ "status": "CREATED",
57
+ "details": [
58
+ {
59
+ "name": "capacityProviderName",
60
+ "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
61
+ },
62
+ {
63
+ "name": "autoScalingLifecycleHookName",
64
+ "value": "ecs-managed-draining-termination-hook"
65
+ }
66
+ ]
67
+ },
68
+ {
69
+ "id": "45d0b36f-8cff-46b6-9380-1288744802ab",
70
+ "type": "sc",
71
+ "status": "ATTACHED",
72
+ "details": []
73
+ }
74
+ ],
75
+ "attachmentsStatus": "UPDATE_COMPLETE",
76
+ "serviceConnectDefaults": {
77
+ "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-igwrsylmy3kwvcdx"
78
+ }
79
+ }
80
+
81
+
82
+ **Example 2: Update ECS cluster to set a default Service Connect namspace**
83
+
84
+ The following ``update-cluster`` updates ECS cluster by setting a default Service Connect namespace. ::
85
+
86
+ aws ecs update-cluster \
87
+ --cluster ECS-project-update-cluster \
88
+ --service-connect-defaults namespace=test
89
+
90
+ Output::
91
+
92
+ {
93
+ "cluster": {
94
+ "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster",
95
+ "clusterName": "ECS-project-update-cluster",
96
+ "status": "ACTIVE",
97
+ "registeredContainerInstancesCount": 0,
98
+ "runningTasksCount": 0,
99
+ "pendingTasksCount": 0,
100
+ "activeServicesCount": 0,
101
+ "statistics": [],
102
+ "tags": [],
103
+ "settings": [
104
+ {
105
+ "name": "containerInsights",
106
+ "value": "enabled"
107
+ }
108
+ ],
109
+ "capacityProviders": [
110
+ "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
111
+ ],
112
+ "defaultCapacityProviderStrategy": [
113
+ {
114
+ "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt",
115
+ "weight": 1,
116
+ "base": 0
117
+ }
118
+ ],
119
+ "attachments": [
120
+ {
121
+ "id": "069d002b-7634-42e4-b1d4-544f4c8f6380",
122
+ "type": "as_policy",
123
+ "status": "CREATED",
124
+ "details": [
125
+ {
126
+ "name": "capacityProviderName",
127
+ "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
128
+ },
129
+ {
130
+ "name": "scalingPolicyName",
131
+ "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93"
132
+ }
133
+ ]
134
+ },
135
+ {
136
+ "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a",
137
+ "type": "managed_draining",
138
+ "status": "CREATED",
139
+ "details": [
140
+ {
141
+ "name": "capacityProviderName",
142
+ "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt"
143
+ },
144
+ {
145
+ "name": "autoScalingLifecycleHookName",
146
+ "value": "ecs-managed-draining-termination-hook"
147
+ }
148
+ ]
149
+ },
150
+ {
151
+ "id": "45d0b36f-8cff-46b6-9380-1288744802ab",
152
+ "type": "sc",
153
+ "status": "DELETED",
154
+ "details": []
155
+ },
156
+ {
157
+ "id": "3e6890c3-609c-4832-91de-d6ca891b3ef1",
158
+ "type": "sc",
159
+ "status": "ATTACHED",
160
+ "details": []
161
+ },
162
+ {
163
+ "id": "961b8ec1-c2f1-4070-8495-e669b7668e90",
164
+ "type": "sc",
165
+ "status": "DELETED",
166
+ "details": []
167
+ }
168
+ ],
169
+ "attachmentsStatus": "UPDATE_COMPLETE",
170
+ "serviceConnectDefaults": {
171
+ "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-dtjmxqpfi46ht7dr"
172
+ }
173
+ }
174
+ }
175
+
176
+ For more information on Service Connect, see `Use Service Connect to connect Amazon ECS services with short names <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html>`__ in the *Amazon ECS Developer Guide*.
@@ -0,0 +1,46 @@
1
+ **Example 1: Enable task protection for ECS tasks**
2
+
3
+ The following ``update-task-protection`` protects your ECS task from termination during scale-in from Deployments or Service AutoScaling. You can specify custom expiration period for task protection from 1 up to 2,880 minutes (48 hours). If you do not specify expiration period, enabling task protection default time is 2 hours. ::
4
+
5
+ aws ecs update-task-protection \
6
+ --cluster ECS-project-update-cluster \
7
+ --tasks c43ed3b1331041f289316f958adb6a24 \
8
+ --protection-enabled \
9
+ --expires-in-minutes 300
10
+
11
+ Output::
12
+
13
+ {
14
+ "protectedTasks": [
15
+ {
16
+ "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24",
17
+ "protectionEnabled": true,
18
+ "expirationDate": "2024-09-14T19:53:36.687000-05:00"
19
+ }
20
+ ],
21
+ "failures": []
22
+ }
23
+
24
+ **Example 2: Disable task protection for ECS tasks**
25
+
26
+ The following ``update-task-protection`` disables the tasks protected from scale in from Deployments or Service AutoScaling. ::
27
+
28
+ aws ecs update-task-protection \
29
+ --cluster ECS-project-update-cluster \
30
+ --tasks c43ed3b1331041f289316f958adb6a24 \
31
+ --no-protection-enabled
32
+
33
+ Output::
34
+
35
+ {
36
+ "protectedTasks": [
37
+ {
38
+ "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24",
39
+ "protectionEnabled": false
40
+ }
41
+ ],
42
+ "failures": []
43
+ }
44
+
45
+ For more formation on task protection, see `Protect your Amazon ECS tasks from being terminated by scale-in events <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html>`__ in the *Amazon ECS Developer Guide*.
46
+
@@ -0,0 +1,14 @@
1
+ **Example: To associate an AWS account with an Amazon Inspector delegated administrator**
2
+
3
+ The following ``associate-member`` example associates an AWS account with an Amazon Inspector delegated administrator. ::
4
+
5
+ aws inspector2 associate-member \
6
+ --account-id 123456789012
7
+
8
+ Output::
9
+
10
+ {
11
+ "accountId": "123456789012"
12
+ }
13
+
14
+ For more information, see `Managing multiple accounts in Amazon Inspector with AWS Organizations <https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html>`__ in the *Amazon Inspector User Guide*.
@@ -0,0 +1,14 @@
1
+ **Example: To disassociate a member account from an Amazon Inspector delegated administrator**
2
+
3
+ The following ``disassociate-member`` example disassociates an AWS account from an Amazon Inspector delegated administrator. ::
4
+
5
+ aws inspector2 disassociate-member \
6
+ --account-id 123456789012
7
+
8
+ Output::
9
+
10
+ {
11
+ "accountId": "123456789012"
12
+ }
13
+
14
+ For more information, see `Managing multiple accounts in Amazon Inspector with AWS Organizations <https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html>`__ in the *Amazon Inspector User Guide*.
@@ -0,0 +1,17 @@
1
+ **Example: To get member information for your organization**
2
+
3
+ aws inspector2 get-member \
4
+ --account-id 123456789012
5
+
6
+ Output::
7
+
8
+ {
9
+ "member": {
10
+ "accountId": "123456789012",
11
+ "delegatedAdminAccountId": "123456789012",
12
+ "relationshipStatus": "ENABLED",
13
+ "updatedAt": "2023-09-11T09:57:20.520000-07:00"
14
+ }
15
+ }
16
+
17
+ For more information, see `Managing multiple accounts in Amazon Inspector with AWS Organizations <https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html>`__ in the *Amazon Inspector User Guide*.
@@ -0,0 +1,83 @@
1
+ **Example 1: To list all member accounts associated with the Amazon Inspector delegated administrator for your organization**
2
+
3
+ aws inspector2 list-members \
4
+ --only-associated
5
+
6
+ Output::
7
+
8
+ {
9
+ {
10
+ "members": [
11
+ {
12
+ "accountId": "123456789012",
13
+ "delegatedAdminAccountId": "123456789012",
14
+ "relationshipStatus": "ENABLED",
15
+ "updatedAt": "2023-09-11T09:57:20.520000-07:00"
16
+ },
17
+ {
18
+ "accountId": "123456789012",
19
+ "delegatedAdminAccountId": "123456789012",
20
+ "relationshipStatus": "ENABLED",
21
+ "updatedAt": "2024-08-12T10:13:01.472000-07:00"
22
+ },
23
+ {
24
+ "accountId": "625032911453",
25
+ "delegatedAdminAccountId": "123456789012",
26
+ "relationshipStatus": "ENABLED",
27
+ "updatedAt": "2023-09-11T09:57:20.438000-07:00"
28
+ },
29
+ {
30
+ "accountId": "715411239211",
31
+ "delegatedAdminAccountId": "123456789012",
32
+ "relationshipStatus": "ENABLED",
33
+ "updatedAt": "2024-04-24T09:14:57.471000-07:00"
34
+ }
35
+ ]
36
+ }
37
+
38
+ For more information, see `Managing multiple accounts in Amazon Inspector with AWS Organizations <https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html>`__ in the *Amazon Inspector User Guide*.
39
+
40
+ **Example 2: To list all member accounts associated with and disassociated from the Amazon Inspector delegated administrator for your organization**
41
+
42
+ aws inspector2 list-members \
43
+ --no-only-associated
44
+
45
+ Output::
46
+
47
+ {
48
+ {
49
+ "members": [
50
+ {
51
+ "accountId": "123456789012",
52
+ "delegatedAdminAccountId": "123456789012",
53
+ "relationshipStatus": "REMOVED",
54
+ "updatedAt": "2024-05-15T11:34:53.326000-07:00"
55
+ },
56
+ {
57
+ "accountId": "123456789012",
58
+ "delegatedAdminAccountId": "123456789012",
59
+ "relationshipStatus": "ENABLED",
60
+ "updatedAt": "2023-09-11T09:57:20.520000-07:00"
61
+ },
62
+ {
63
+ "accountId": "123456789012",
64
+ "delegatedAdminAccountId": "123456789012",
65
+ "relationshipStatus": "ENABLED",
66
+ "updatedAt": "2024-08-12T10:13:01.472000-07:00"
67
+ },
68
+ {
69
+ "accountId": "123456789012",
70
+ "delegatedAdminAccountId": "123456789012",
71
+ "relationshipStatus": "ENABLED",
72
+ "updatedAt": "2023-09-11T09:57:20.438000-07:00"
73
+ },
74
+ {
75
+ "accountId": "123456789012",
76
+ "delegatedAdminAccountId": "123456789012",
77
+ "relationshipStatus": "ENABLED",
78
+ "updatedAt": "2024-04-24T09:14:57.471000-07:00"
79
+ }
80
+ ]
81
+ }
82
+
83
+ For more information, see `Managing multiple accounts in Amazon Inspector with AWS Organizations <https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html>`__ in the *Amazon Inspector User Guide*.
@@ -0,0 +1,25 @@
1
+ **To create an ingest configuration**
2
+
3
+ The following ``create-ingest-configuration`` example creates an ingest configuration using RTMPS protocol. ::
4
+
5
+ aws ivs-realtime create-ingest-configuration \
6
+ --name ingest1 \
7
+ --ingest-protocol rtmps
8
+
9
+ Output::
10
+
11
+ {
12
+ "ingestConfiguration": {
13
+ "name": "ingest1",
14
+ "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
15
+ "ingestProtocol": "RTMPS",
16
+ "streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
17
+ "stageArn": "",
18
+ "participantId": "xyZ654abC321",
19
+ "state": "INACTIVE",
20
+ "userId": "",
21
+ "tags": {}
22
+ }
23
+ }
24
+
25
+ For more information, see `IVS Stream Ingest | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html>`__ in the *Amazon Interactive Video Service User Guide*.
@@ -21,6 +21,8 @@ Output::
21
21
  "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
22
22
  "endpoints": {
23
23
  "events": "wss://global.events.live-video.net",
24
+ "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
25
+ "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
24
26
  "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
25
27
  },
26
28
  "name": "stage1",
@@ -49,9 +51,11 @@ Output::
49
51
  "AUDIO_VIDEO"
50
52
  ],
51
53
  "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
52
- },
54
+ },
53
55
  "endpoints": {
54
56
  "events": "wss://global.events.live-video.net",
57
+ "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
58
+ "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
55
59
  "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
56
60
  },
57
61
  "name": "stage1",
@@ -59,4 +63,4 @@ Output::
59
63
  }
60
64
  }
61
65
 
62
- For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
66
+ For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
@@ -0,0 +1,22 @@
1
+ **Example 1: To delete an inactive ingest configuration**
2
+
3
+ The following ``delete-ingest-configuration`` example deletes the inactive ingest configuration for a specified ingest-configuration ARN (Amazon Resource Name). ::
4
+
5
+ aws ivs-realtime delete-ingest-configuration \
6
+ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234
7
+
8
+ This command produces no output.
9
+
10
+ For more information, see `IVS Stream Ingest | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html>`__ in the *Amazon Interactive Video Service User Guide*.
11
+
12
+ **Example 2: To force delete an active ingest configuration**
13
+
14
+ The following ``delete-ingest-configuration`` example forces deletion of the active ingest configuration for a specified ingest-configuration ARN (Amazon Resource Name). ::
15
+
16
+ aws ivs-realtime delete-ingest-configuration \
17
+ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \
18
+ --force
19
+
20
+ This command produces no output.
21
+
22
+ For more information, see `IVS Stream Ingest | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html>`__ in the *Amazon Interactive Video Service User Guide*.
@@ -0,0 +1,24 @@
1
+ **To get ingest configuration information**
2
+
3
+ The following ``get-ingest-configuration`` example gets the ingest configuration for a specified ingest-configuration ARN (Amazon Resource Name). ::
4
+
5
+ aws ivs-realtime get-ingest-configuration \
6
+ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234
7
+
8
+ Output::
9
+
10
+ {
11
+ "ingestConfiguration": {
12
+ "name": "ingest1",
13
+ "arn": "arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234",
14
+ "ingestProtocol": "RTMPS",
15
+ "streamKey": "rt_123456789012_us-west-2_AbCdEfGh1234_abcd1234efgh5678ijkl9012MNOP34",
16
+ "stageArn": "",
17
+ "participantId": "xyZ654abC321",
18
+ "state": "INACTIVE",
19
+ "userId": "",
20
+ "tags": {}
21
+ }
22
+ }
23
+
24
+ For more information, see `IVS Stream Ingest | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html>`__ in the *Amazon Interactive Video Service User Guide*.
@@ -16,9 +16,11 @@ Output::
16
16
  "AUDIO_VIDEO"
17
17
  ],
18
18
  "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
19
- },
19
+ },
20
20
  "endpoints": {
21
21
  "events": "wss://global.events.live-video.net",
22
+ "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
23
+ "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
22
24
  "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
23
25
  },
24
26
  "name": "test",
@@ -26,4 +28,4 @@ Output::
26
28
  }
27
29
  }
28
30
 
29
- For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
31
+ For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.