Skip to content

Commit c5a008e

Browse files
elysahallaws-sdk-python-automation
elysahall
authored and
aws-sdk-python-automation
committed
Examples for ivs-realtime, lambda, securityhub
1 parent 9c8ebe1 commit c5a008e

File tree

6 files changed

+114
-24
lines changed

6 files changed

+114
-24
lines changed

‎awscli/examples/ivs-realtime/get-composition.rst‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,10 @@ Output::
5151
],
5252
"layout": {
5353
"grid": {
54-
"featuredParticipantAttribute": ""
54+
"featuredParticipantAttribute": "",
5555
"gridGap": 2,
5656
"omitStoppedVideo": false,
57+
"participantOrderAttribute": "",
5758
"videoAspectRatio": "VIDEO",
5859
"videoFillMode": ""
5960
}
@@ -65,7 +66,7 @@ Output::
6566
}
6667
}
6768

68-
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
69+
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
6970

7071
**Example 2: To get a composition with PiP layout**
7172

@@ -123,6 +124,7 @@ Output::
123124
"featuredParticipantAttribute": "abcdefg",
124125
"gridGap": 0,
125126
"omitStoppedVideo": false,
127+
"participantOrderAttribute": "",
126128
"pipBehavior": "STATIC",
127129
"pipOffset": 0,
128130
"pipParticipantAttribute": "",
@@ -137,7 +139,7 @@ Output::
137139
}
138140
}
139141

140-
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
142+
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
141143

142144
**Example 3: To get a composition with thumbnail recording enabled**
143145

@@ -203,6 +205,7 @@ Output::
203205
"featuredParticipantAttribute": ""
204206
"gridGap": 2,
205207
"omitStoppedVideo": false,
208+
"participantOrderAttribute": "",
206209
"videoAspectRatio": "VIDEO",
207210
"videoFillMode": "" }
208211
},
@@ -213,4 +216,4 @@ Output::
213216
}
214217
}
215218

216-
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
219+
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.

‎awscli/examples/ivs-realtime/start-composition.rst‎

Lines changed: 88 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Output::
5757
"featuredParticipantAttribute": ""
5858
"gridGap": 2,
5959
"omitStoppedVideo": false,
60+
"participantOrderAttribute": "",
6061
"videoAspectRatio": "VIDEO",
6162
"videoFillMode": ""
6263
}
@@ -68,7 +69,7 @@ Output::
6869
}
6970
}
7071

71-
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
72+
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
7273

7374
**Example 2: To start a composition with PiP layout**
7475

@@ -129,6 +130,7 @@ Output::
129130
"featuredParticipantAttribute": "abcdefg",
130131
"gridGap": 0,
131132
"omitStoppedVideo": false,
133+
"participantOrderAttribute": "",
132134
"pipBehavior": "STATIC",
133135
"pipOffset": 0,
134136
"pipParticipantAttribute": "",
@@ -143,7 +145,7 @@ Output::
143145
}
144146
}
145147

146-
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
148+
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
147149

148150
**Example 3: To start a composition with thumbnail recording enabled**
149151

@@ -212,6 +214,7 @@ Output::
212214
"featuredParticipantAttribute": ""
213215
"gridGap": 2,
214216
"omitStoppedVideo": false,
217+
"participantOrderAttribute": "",
215218
"videoAspectRatio": "VIDEO",
216219
"videoFillMode": ""
217220
}
@@ -223,4 +226,86 @@ Output::
223226
}
224227
}
225228

226-
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
229+
For more information, see `Composite Recording (Real-Time Streaming) <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
230+
231+
**Example 4: To start a composition using grid layout with custom participant ordering**
232+
233+
The following ``start-composition`` example starts a composition for the specified stage to be streamed to the specified locations using grid layout with custom participant ordering. ::
234+
235+
aws ivs-realtime start-composition \
236+
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
237+
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
238+
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
239+
{"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
240+
"storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \
241+
"thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]' \
242+
--layout grid='{participantOrderAttribute="abcdefg"}'
243+
244+
Output::
245+
246+
{
247+
"composition": {
248+
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
249+
"destinations": [
250+
{
251+
"configuration": {
252+
"channel": {
253+
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
254+
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
255+
},
256+
"name": ""
257+
},
258+
"id": "AabBCcdDEefF",
259+
"state": "STARTING"
260+
},
261+
{
262+
"configuration": {
263+
"name": "",
264+
"s3": {
265+
"encoderConfigurationArns": [
266+
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
267+
],
268+
"recordingConfiguration": {
269+
"format": "HLS",
270+
"hlsConfiguration": {
271+
"targetSegmentDurationSeconds": 2
272+
}
273+
},
274+
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
275+
"thumbnailConfigurations": [
276+
{
277+
"targetIntervalSeconds": 60,
278+
"storage": [
279+
"SEQUENTIAL"
280+
]
281+
}
282+
]
283+
}
284+
},
285+
"detail": {
286+
"s3": {
287+
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
288+
}
289+
},
290+
"id": "GHFabcgefABC",
291+
"state": "STARTING"
292+
}
293+
],
294+
"layout": {
295+
"grid": {
296+
"featuredParticipantAttribute": ""
297+
"gridGap": 2,
298+
"omitStoppedVideo": false,
299+
"participantOrderAttribute": "abcdefg",
300+
"videoAspectRatio": "VIDEO",
301+
"videoFillMode": ""
302+
}
303+
},
304+
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
305+
"startTime": "2023-10-16T23:24:00+00:00",
306+
"state": "STARTING",
307+
"tags": {}
308+
}
309+
}
310+
311+
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.

‎awscli/examples/lambda/create-function.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The following ``create-function`` example creates a Lambda function named ``my-f
44

55
aws lambda create-function \
66
--function-name my-function \
7-
--runtime nodejs18.x \
7+
--runtime nodejs22.x \
88
--zip-file fileb://my-function.zip \
99
--handler my-function.handler \
1010
--role arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-tges6bf4
@@ -28,10 +28,10 @@ Output::
2828
"Version": "$LATEST",
2929
"Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4",
3030
"Timeout": 3,
31-
"LastModified": "2023-10-14T22:26:11.234+0000",
31+
"LastModified": "2025-10-14T22:26:11.234+0000",
3232
"Handler": "my-function.handler",
33-
"Runtime": "nodejs18.x",
33+
"Runtime": "nodejs22.x",
3434
"Description": ""
3535
}
3636

37-
For more information, see `AWS Lambda Function Configuration <https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html>`__ in the *AWS Lambda Developer Guide*.
37+
For more information, see `Configure Lambda function memory <https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html>`__ in the *AWS Lambda Developer Guide*.

‎awscli/examples/lambda/get-function.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ Output::
3434
"Handler": "index.handler",
3535
"Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq",
3636
"Timeout": 3,
37-
"LastModified": "2019-09-24T18:20:35.054+0000",
38-
"Runtime": "nodejs10.x",
37+
"LastModified": "2025-09-24T18:20:35.054+0000",
38+
"Runtime": "nodejs22.x",
3939
"Description": ""
4040
}
4141
}
4242

43-
For more information, see `AWS Lambda Function Configuration <https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html>`__ in the *AWS Lambda Developer Guide*.
43+
For more information, see `Configure Lambda function memory <https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html>`__ in the *AWS Lambda Developer Guide*.

‎awscli/examples/lambda/list-functions.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Output::
2222
"Handler": "helloworld.handler",
2323
"Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4",
2424
"Timeout": 3,
25-
"LastModified": "2023-09-23T18:32:33.857+0000",
26-
"Runtime": "nodejs18.x",
25+
"LastModified": "2025-09-23T18:32:33.857+0000",
26+
"Runtime": "nodejs22.x",
2727
"Description": ""
2828
},
2929
{
@@ -45,8 +45,8 @@ Output::
4545
"Handler": "index.handler",
4646
"Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq",
4747
"Timeout": 3,
48-
"LastModified": "2023-10-01T16:47:28.490+0000",
49-
"Runtime": "nodejs18.x",
48+
"LastModified": "2025-10-01T16:47:28.490+0000",
49+
"Runtime": "nodejs22.x",
5050
"Description": ""
5151
},
5252
{
@@ -78,11 +78,11 @@ Output::
7878
"Handler": "lambda_function.lambda_handler",
7979
"Role": "arn:aws:iam::123456789012:role/service-role/my-python-function-role-z5g7dr6n",
8080
"Timeout": 3,
81-
"LastModified": "2023-10-01T19:40:41.643+0000",
81+
"LastModified": "2025-10-01T19:40:41.643+0000",
8282
"Runtime": "python3.11",
8383
"Description": ""
8484
}
8585
]
8686
}
8787

88-
For more information, see `AWS Lambda Function Configuration <https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html>`__ in the *AWS Lambda Developer Guide*.
88+
For more information, see `Configure Lambda function memory <https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html>`__ in the *AWS Lambda Developer Guide*.

‎awscli/examples/securityhub/describe-hub.rst‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
**To get information about a hub resource**
22

3-
The following ``describe-hub`` example returns the subscription date for the specified hub resource. The hub resource is identified by its ARN. ::
3+
The following ``describe-hub`` example returns the subscription date and other configuration settings for the specified hub resource. The hub resource is identified by its ARN. ::
44

5-
aws securityhub describe-hub \
5+
aws securityhub describe-hub \
66
--hub-arn "arn:aws:securityhub:us-west-1:123456789012:hub/default"
77

88
Output::
99

1010
{
1111
"HubArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default",
12-
"SubscribedAt": "2019-11-19T23:15:10.046Z"
12+
"SubscribedAt": "2019-11-19T23:15:10.046Z",
13+
"AutoEnableControls": true,
14+
"ControlFindingGenerator": "SECURITY_CONTROL"
1315
}
1416

15-
For more information, see `AWS::SecurityHub::Hub <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-hub.html>`__ in the *AWS CloudFormation User Guide*.
17+
For more information, see `AWS::SecurityHub::Hub <https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-securityhub-hub.html>`__ in the *AWS CloudFormation User Guide*.

0 commit comments

Comments
 (0)