Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions awscli/examples/ivs-realtime/get-composition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,10 @@ Output::
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"featuredParticipantAttribute": "",
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
Expand All @@ -65,7 +66,7 @@ Output::
}
}

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*.
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*.

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

Expand Down Expand Up @@ -123,6 +124,7 @@ Output::
"featuredParticipantAttribute": "abcdefg",
"gridGap": 0,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"pipBehavior": "STATIC",
"pipOffset": 0,
"pipParticipantAttribute": "",
Expand All @@ -137,7 +139,7 @@ Output::
}
}

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*.
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*.

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

Expand Down Expand Up @@ -203,6 +205,7 @@ Output::
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": "" }
},
Expand All @@ -213,4 +216,4 @@ Output::
}
}

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*.
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*.
91 changes: 88 additions & 3 deletions awscli/examples/ivs-realtime/start-composition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Output::
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
Expand All @@ -68,7 +69,7 @@ Output::
}
}

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*.
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*.

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

Expand Down Expand Up @@ -129,6 +130,7 @@ Output::
"featuredParticipantAttribute": "abcdefg",
"gridGap": 0,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"pipBehavior": "STATIC",
"pipOffset": 0,
"pipParticipantAttribute": "",
Expand All @@ -143,7 +145,7 @@ Output::
}
}

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*.
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*.

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

Expand Down Expand Up @@ -212,6 +214,7 @@ Output::
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
Expand All @@ -223,4 +226,86 @@ Output::
}
}

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*.
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*.

**Example 4: To start a composition using grid layout with custom participant ordering**

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. ::

aws ivs-realtime start-composition \
--stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \
"thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]' \
--layout grid='{participantOrderAttribute="abcdefg"}'

Output::

{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"state": "STARTING"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
{
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
]
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"participantOrderAttribute": "abcdefg",
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "STARTING",
"tags": {}
}
}

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*.
8 changes: 4 additions & 4 deletions awscli/examples/lambda/create-function.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following ``create-function`` example creates a Lambda function named ``my-f

aws lambda create-function \
--function-name my-function \
--runtime nodejs18.x \
--runtime nodejs22.x \
--zip-file fileb://my-function.zip \
--handler my-function.handler \
--role arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-tges6bf4
Expand All @@ -28,10 +28,10 @@ Output::
"Version": "$LATEST",
"Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4",
"Timeout": 3,
"LastModified": "2023-10-14T22:26:11.234+0000",
"LastModified": "2025-10-14T22:26:11.234+0000",
"Handler": "my-function.handler",
"Runtime": "nodejs18.x",
"Runtime": "nodejs22.x",
"Description": ""
}

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*.
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*.
6 changes: 3 additions & 3 deletions awscli/examples/lambda/get-function.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ Output::
"Handler": "index.handler",
"Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq",
"Timeout": 3,
"LastModified": "2019-09-24T18:20:35.054+0000",
"Runtime": "nodejs10.x",
"LastModified": "2025-09-24T18:20:35.054+0000",
"Runtime": "nodejs22.x",
"Description": ""
}
}

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*.
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*.
12 changes: 6 additions & 6 deletions awscli/examples/lambda/list-functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Output::
"Handler": "helloworld.handler",
"Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4",
"Timeout": 3,
"LastModified": "2023-09-23T18:32:33.857+0000",
"Runtime": "nodejs18.x",
"LastModified": "2025-09-23T18:32:33.857+0000",
"Runtime": "nodejs22.x",
"Description": ""
},
{
Expand All @@ -45,8 +45,8 @@ Output::
"Handler": "index.handler",
"Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq",
"Timeout": 3,
"LastModified": "2023-10-01T16:47:28.490+0000",
"Runtime": "nodejs18.x",
"LastModified": "2025-10-01T16:47:28.490+0000",
"Runtime": "nodejs22.x",
"Description": ""
},
{
Expand Down Expand Up @@ -78,11 +78,11 @@ Output::
"Handler": "lambda_function.lambda_handler",
"Role": "arn:aws:iam::123456789012:role/service-role/my-python-function-role-z5g7dr6n",
"Timeout": 3,
"LastModified": "2023-10-01T19:40:41.643+0000",
"LastModified": "2025-10-01T19:40:41.643+0000",
"Runtime": "python3.11",
"Description": ""
}
]
}

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*.
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*.
10 changes: 6 additions & 4 deletions awscli/examples/securityhub/describe-hub.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
**To get information about a hub resource**

The following ``describe-hub`` example returns the subscription date for the specified hub resource. The hub resource is identified by its ARN. ::
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. ::

aws securityhub describe-hub \
aws securityhub describe-hub \
--hub-arn "arn:aws:securityhub:us-west-1:123456789012:hub/default"

Output::

{
"HubArn": "arn:aws:securityhub:us-west-1:123456789012:hub/default",
"SubscribedAt": "2019-11-19T23:15:10.046Z"
"SubscribedAt": "2019-11-19T23:15:10.046Z",
"AutoEnableControls": true,
"ControlFindingGenerator": "SECURITY_CONTROL"
}

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*.
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*.
Loading