CreateSignalingChannel

$result = $client->createSignalingChannel([/* ... */]);
$promise = $client->createSignalingChannelAsync([/* ... */]);

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

Parameter Syntax

$result = $client->createSignalingChannel([
    'ChannelName' => '<string>', // REQUIRED
    'ChannelType' => 'SINGLE_MASTER|FULL_MESH',
    'SingleMasterConfiguration' => [
        'MessageTtlSeconds' => <integer>,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ChannelARN' => '<string>',
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

AccountChannelLimitExceededException:

You have reached the maximum limit of active signaling channels for this Amazon Web Services account in this region.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

AccessDeniedException:

You do not have required permissions to perform this operation.

TagsPerResourceExceededLimitException:

You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.

CreateStream

$result = $client->createStream([/* ... */]);
$promise = $client->createStreamAsync([/* ... */]);

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works.

You must have permissions for the KinesisVideo:CreateStream action.

Parameter Syntax

$result = $client->createStream([
    'DataRetentionInHours' => <integer>,
    'DeviceName' => '<string>',
    'KmsKeyId' => '<string>',
    'MediaType' => '<string>',
    'StreamName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'StreamARN' => '<string>',
]

Result Details

Errors

AccountStreamLimitExceededException:

The number of streams created for the account is too high.

DeviceStreamLimitExceededException:

Not implemented.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

InvalidDeviceException:

Not implemented.

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

TagsPerResourceExceededLimitException:

You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.

DeleteEdgeConfiguration

$result = $client->deleteEdgeConfiguration([/* ... */]);
$promise = $client->deleteEdgeConfigurationAsync([/* ... */]);

An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.

When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion.

When the deletion process has completed successfully, the edge configuration is no longer accessible.

Parameter Syntax

$result = $client->deleteEdgeConfiguration([
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have required permissions to perform this operation.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

StreamEdgeConfigurationNotFoundException:

The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.

DeleteSignalingChannel

$result = $client->deleteSignalingChannel([/* ... */]);
$promise = $client->deleteSignalingChannelAsync([/* ... */]);

Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.

Parameter Syntax

$result = $client->deleteSignalingChannel([
    'ChannelARN' => '<string>', // REQUIRED
    'CurrentVersion' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

VersionMismatchException:

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

DeleteStream

$result = $client->deleteStream([/* ... */]);
$promise = $client->deleteStreamAsync([/* ... */]);

Deletes a Kinesis video stream and the data contained in the stream.

This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

This operation requires permission for the KinesisVideo:DeleteStream action.

Parameter Syntax

$result = $client->deleteStream([
    'CurrentVersion' => '<string>',
    'StreamARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

NotAuthorizedException:

The caller is not authorized to perform this operation.

VersionMismatchException:

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

DescribeEdgeConfiguration

$result = $client->describeEdgeConfiguration([/* ... */]);
$promise = $client->describeEdgeConfigurationAsync([/* ... */]);

Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.

Parameter Syntax

$result = $client->describeEdgeConfiguration([
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'EdgeAgentStatus' => [
        'LastRecorderStatus' => [
            'JobStatusDetails' => '<string>',
            'LastCollectedTime' => <DateTime>,
            'LastUpdatedTime' => <DateTime>,
            'RecorderStatus' => 'SUCCESS|USER_ERROR|SYSTEM_ERROR',
        ],
        'LastUploaderStatus' => [
            'JobStatusDetails' => '<string>',
            'LastCollectedTime' => <DateTime>,
            'LastUpdatedTime' => <DateTime>,
            'UploaderStatus' => 'SUCCESS|USER_ERROR|SYSTEM_ERROR',
        ],
    ],
    'EdgeConfig' => [
        'DeletionConfig' => [
            'DeleteAfterUpload' => true || false,
            'EdgeRetentionInHours' => <integer>,
            'LocalSizeConfig' => [
                'MaxLocalMediaSizeInMB' => <integer>,
                'StrategyOnFullSize' => 'DELETE_OLDEST_MEDIA|DENY_NEW_MEDIA',
            ],
        ],
        'HubDeviceArn' => '<string>',
        'RecorderConfig' => [
            'MediaSourceConfig' => [
                'MediaUriSecretArn' => '<string>',
                'MediaUriType' => 'RTSP_URI|FILE_URI',
            ],
            'ScheduleConfig' => [
                'DurationInSeconds' => <integer>,
                'ScheduleExpression' => '<string>',
            ],
        ],
        'UploaderConfig' => [
            'ScheduleConfig' => [
                'DurationInSeconds' => <integer>,
                'ScheduleExpression' => '<string>',
            ],
        ],
    ],
    'FailedStatusDetails' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
    'SyncStatus' => 'SYNCING|ACKNOWLEDGED|IN_SYNC|SYNC_FAILED|DELETING|DELETE_FAILED|DELETING_ACKNOWLEDGED',
]

Result Details

Errors

AccessDeniedException:

You do not have required permissions to perform this operation.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

StreamEdgeConfigurationNotFoundException:

The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified.

DescribeImageGenerationConfiguration

$result = $client->describeImageGenerationConfiguration([/* ... */]);
$promise = $client->describeImageGenerationConfigurationAsync([/* ... */]);

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

Parameter Syntax

$result = $client->describeImageGenerationConfiguration([
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ImageGenerationConfiguration' => [
        'DestinationConfig' => [
            'DestinationRegion' => '<string>',
            'Uri' => '<string>',
        ],
        'Format' => 'JPEG|PNG',
        'FormatConfig' => ['<string>', ...],
        'HeightPixels' => <integer>,
        'ImageSelectorType' => 'SERVER_TIMESTAMP|PRODUCER_TIMESTAMP',
        'SamplingInterval' => <integer>,
        'Status' => 'ENABLED|DISABLED',
        'WidthPixels' => <integer>,
    ],
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

DescribeMappedResourceConfiguration

$result = $client->describeMappedResourceConfiguration([/* ... */]);
$promise = $client->describeMappedResourceConfigurationAsync([/* ... */]);

Returns the most current information about the stream. The streamName or streamARN should be provided in the input.

Parameter Syntax

$result = $client->describeMappedResourceConfiguration([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MappedResourceConfigurationList' => [
        [
            'ARN' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

InvalidArgumentException:

The value for this input parameter is invalid.

AccessDeniedException:

You do not have required permissions to perform this operation.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

DescribeMediaStorageConfiguration

$result = $client->describeMediaStorageConfiguration([/* ... */]);
$promise = $client->describeMediaStorageConfigurationAsync([/* ... */]);

Returns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.

Parameter Syntax

$result = $client->describeMediaStorageConfiguration([
    'ChannelARN' => '<string>',
    'ChannelName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MediaStorageConfiguration' => [
        'Status' => 'ENABLED|DISABLED',
        'StreamARN' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

InvalidArgumentException:

The value for this input parameter is invalid.

AccessDeniedException:

You do not have required permissions to perform this operation.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

DescribeNotificationConfiguration

$result = $client->describeNotificationConfiguration([/* ... */]);
$promise = $client->describeNotificationConfigurationAsync([/* ... */]);

Gets the NotificationConfiguration for a given Kinesis video stream.

Parameter Syntax

$result = $client->describeNotificationConfiguration([
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NotificationConfiguration' => [
        'DestinationConfig' => [
            'Uri' => '<string>',
        ],
        'Status' => 'ENABLED|DISABLED',
    ],
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

DescribeSignalingChannel

$result = $client->describeSignalingChannel([/* ... */]);
$promise = $client->describeSignalingChannelAsync([/* ... */]);

Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.

Parameter Syntax

$result = $client->describeSignalingChannel([
    'ChannelARN' => '<string>',
    'ChannelName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ChannelInfo' => [
        'ChannelARN' => '<string>',
        'ChannelName' => '<string>',
        'ChannelStatus' => 'CREATING|ACTIVE|UPDATING|DELETING',
        'ChannelType' => 'SINGLE_MASTER|FULL_MESH',
        'CreationTime' => <DateTime>,
        'SingleMasterConfiguration' => [
            'MessageTtlSeconds' => <integer>,
        ],
        'Version' => '<string>',
    ],
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

DescribeStream

$result = $client->describeStream([/* ... */]);
$promise = $client->describeStreamAsync([/* ... */]);

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

Parameter Syntax

$result = $client->describeStream([
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'StreamInfo' => [
        'CreationTime' => <DateTime>,
        'DataRetentionInHours' => <integer>,
        'DeviceName' => '<string>',
        'KmsKeyId' => '<string>',
        'MediaType' => '<string>',
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING',
        'StreamARN' => '<string>',
        'StreamName' => '<string>',
        'Version' => '<string>',
    ],
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException:

The caller is not authorized to perform this operation.

GetDataEndpoint

$result = $client->getDataEndpoint([/* ... */]);
$promise = $client->getDataEndpointAsync([/* ... */]);

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

In the request, specify the stream either by StreamName or StreamARN.

Parameter Syntax

$result = $client->getDataEndpoint([
    'APIName' => 'PUT_MEDIA|GET_MEDIA|LIST_FRAGMENTS|GET_MEDIA_FOR_FRAGMENT_LIST|GET_HLS_STREAMING_SESSION_URL|GET_DASH_STREAMING_SESSION_URL|GET_CLIP|GET_IMAGES', // REQUIRED
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataEndpoint' => '<string>',
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException:

The caller is not authorized to perform this operation.

GetSignalingChannelEndpoint

$result = $client->getSignalingChannelEndpoint([/* ... */]);
$promise = $client->getSignalingChannelEndpointAsync([/* ... */]);

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

Parameter Syntax

$result = $client->getSignalingChannelEndpoint([
    'ChannelARN' => '<string>', // REQUIRED
    'SingleMasterChannelEndpointConfiguration' => [
        'Protocols' => ['<string>', ...],
        'Role' => 'MASTER|VIEWER',
    ],
]);

Parameter Details

Result Syntax

[
    'ResourceEndpointList' => [
        [
            'Protocol' => 'WSS|HTTPS|WEBRTC',
            'ResourceEndpoint' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

AccessDeniedException:

You do not have required permissions to perform this operation.

ListEdgeAgentConfigurations

$result = $client->listEdgeAgentConfigurations([/* ... */]);
$promise = $client->listEdgeAgentConfigurationsAsync([/* ... */]);

Returns an array of edge configurations associated with the specified Edge Agent.

In the request, you must specify the Edge Agent HubDeviceArn.

Parameter Syntax

$result = $client->listEdgeAgentConfigurations([
    'HubDeviceArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EdgeConfigs' => [
        [
            'CreationTime' => <DateTime>,
            'EdgeConfig' => [
                'DeletionConfig' => [
                    'DeleteAfterUpload' => true || false,
                    'EdgeRetentionInHours' => <integer>,
                    'LocalSizeConfig' => [
                        'MaxLocalMediaSizeInMB' => <integer>,
                        'StrategyOnFullSize' => 'DELETE_OLDEST_MEDIA|DENY_NEW_MEDIA',
                    ],
                ],
                'HubDeviceArn' => '<string>',
                'RecorderConfig' => [
                    'MediaSourceConfig' => [
                        'MediaUriSecretArn' => '<string>',
                        'MediaUriType' => 'RTSP_URI|FILE_URI',
                    ],
                    'ScheduleConfig' => [
                        'DurationInSeconds' => <integer>,
                        'ScheduleExpression' => '<string>',
                    ],
                ],
                'UploaderConfig' => [
                    'ScheduleConfig' => [
                        'DurationInSeconds' => <integer>,
                        'ScheduleExpression' => '<string>',
                    ],
                ],
            ],
            'FailedStatusDetails' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'StreamARN' => '<string>',
            'StreamName' => '<string>',
            'SyncStatus' => 'SYNCING|ACKNOWLEDGED|IN_SYNC|SYNC_FAILED|DELETING|DELETE_FAILED|DELETING_ACKNOWLEDGED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

NotAuthorizedException:

The caller is not authorized to perform this operation.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ListSignalingChannels

$result = $client->listSignalingChannels([/* ... */]);
$promise = $client->listSignalingChannelsAsync([/* ... */]);

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

Parameter Syntax

$result = $client->listSignalingChannels([
    'ChannelNameCondition' => [
        'ComparisonOperator' => 'BEGINS_WITH',
        'ComparisonValue' => '<string>',
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ChannelInfoList' => [
        [
            'ChannelARN' => '<string>',
            'ChannelName' => '<string>',
            'ChannelStatus' => 'CREATING|ACTIVE|UPDATING|DELETING',
            'ChannelType' => 'SINGLE_MASTER|FULL_MESH',
            'CreationTime' => <DateTime>,
            'SingleMasterConfiguration' => [
                'MessageTtlSeconds' => <integer>,
            ],
            'Version' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

AccessDeniedException:

You do not have required permissions to perform this operation.

ListStreams

$result = $client->listStreams([/* ... */]);
$promise = $client->listStreamsAsync([/* ... */]);

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

Parameter Syntax

$result = $client->listStreams([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StreamNameCondition' => [
        'ComparisonOperator' => 'BEGINS_WITH',
        'ComparisonValue' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'StreamInfoList' => [
        [
            'CreationTime' => <DateTime>,
            'DataRetentionInHours' => <integer>,
            'DeviceName' => '<string>',
            'KmsKeyId' => '<string>',
            'MediaType' => '<string>',
            'Status' => 'CREATING|ACTIVE|UPDATING|DELETING',
            'StreamARN' => '<string>',
            'StreamName' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags associated with the specified signaling channel.

Parameter Syntax

$result = $client->listTagsForResource([
    'NextToken' => '<string>',
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

ListTagsForStream

$result = $client->listTagsForStream([/* ... */]);
$promise = $client->listTagsForStreamAsync([/* ... */]);

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

Parameter Syntax

$result = $client->listTagsForStream([
    'NextToken' => '<string>',
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

NotAuthorizedException:

The caller is not authorized to perform this operation.

InvalidResourceFormatException:

The format of the StreamARN is invalid.

StartEdgeConfigurationUpdate

$result = $client->startEdgeConfigurationUpdate([/* ... */]);
$promise = $client->startEdgeConfigurationUpdateAsync([/* ... */]);

An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent.

If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to SYNCING. You will have to wait for the sync status to reach a terminal state such as: IN_SYNC, or SYNC_FAILED, before using this API again. If you invoke this API during the syncing process, a ResourceInUseException will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the SYNC_FAILED state.

To move an edge configuration from one device to another, use DeleteEdgeConfiguration to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.

Parameter Syntax

$result = $client->startEdgeConfigurationUpdate([
    'EdgeConfig' => [ // REQUIRED
        'DeletionConfig' => [
            'DeleteAfterUpload' => true || false,
            'EdgeRetentionInHours' => <integer>,
            'LocalSizeConfig' => [
                'MaxLocalMediaSizeInMB' => <integer>,
                'StrategyOnFullSize' => 'DELETE_OLDEST_MEDIA|DENY_NEW_MEDIA',
            ],
        ],
        'HubDeviceArn' => '<string>', // REQUIRED
        'RecorderConfig' => [ // REQUIRED
            'MediaSourceConfig' => [ // REQUIRED
                'MediaUriSecretArn' => '<string>', // REQUIRED
                'MediaUriType' => 'RTSP_URI|FILE_URI', // REQUIRED
            ],
            'ScheduleConfig' => [
                'DurationInSeconds' => <integer>, // REQUIRED
                'ScheduleExpression' => '<string>', // REQUIRED
            ],
        ],
        'UploaderConfig' => [
            'ScheduleConfig' => [ // REQUIRED
                'DurationInSeconds' => <integer>, // REQUIRED
                'ScheduleExpression' => '<string>', // REQUIRED
            ],
        ],
    ],
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'EdgeConfig' => [
        'DeletionConfig' => [
            'DeleteAfterUpload' => true || false,
            'EdgeRetentionInHours' => <integer>,
            'LocalSizeConfig' => [
                'MaxLocalMediaSizeInMB' => <integer>,
                'StrategyOnFullSize' => 'DELETE_OLDEST_MEDIA|DENY_NEW_MEDIA',
            ],
        ],
        'HubDeviceArn' => '<string>',
        'RecorderConfig' => [
            'MediaSourceConfig' => [
                'MediaUriSecretArn' => '<string>',
                'MediaUriType' => 'RTSP_URI|FILE_URI',
            ],
            'ScheduleConfig' => [
                'DurationInSeconds' => <integer>,
                'ScheduleExpression' => '<string>',
            ],
        ],
        'UploaderConfig' => [
            'ScheduleConfig' => [
                'DurationInSeconds' => <integer>,
                'ScheduleExpression' => '<string>',
            ],
        ],
    ],
    'FailedStatusDetails' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
    'SyncStatus' => 'SYNCING|ACKNOWLEDGED|IN_SYNC|SYNC_FAILED|DELETING|DELETE_FAILED|DELETING_ACKNOWLEDGED',
]

Result Details

Errors

AccessDeniedException:

You do not have required permissions to perform this operation.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

NoDataRetentionException:

The Stream data retention in hours is equal to zero.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

TagsPerResourceExceededLimitException:

You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.

TagStream

$result = $client->tagStream([/* ... */]);
$promise = $client->tagStreamAsync([/* ... */]);

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the Billing and Cost Management and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

A Kinesis video stream can support up to 50 tags.

Parameter Syntax

$result = $client->tagStream([
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

NotAuthorizedException:

The caller is not authorized to perform this operation.

InvalidResourceFormatException:

The format of the StreamARN is invalid.

TagsPerResourceExceededLimitException:

You have exceeded the limit of tags that you can associate with the resource. A Kinesis video stream can support up to 50 tags.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeyList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

UntagStream

$result = $client->untagStream([/* ... */]);
$promise = $client->untagStreamAsync([/* ... */]);

Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

In the request, you must provide the StreamName or StreamARN.

Parameter Syntax

$result = $client->untagStream([
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
    'TagKeyList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

NotAuthorizedException:

The caller is not authorized to perform this operation.

InvalidResourceFormatException:

The format of the StreamARN is invalid.

UpdateDataRetention

$result = $client->updateDataRetention([/* ... */]);
$promise = $client->updateDataRetentionAsync([/* ... */]);

Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

• If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.

• If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

Parameter Syntax

$result = $client->updateDataRetention([
    'CurrentVersion' => '<string>', // REQUIRED
    'DataRetentionChangeInHours' => <integer>, // REQUIRED
    'Operation' => 'INCREASE_DATA_RETENTION|DECREASE_DATA_RETENTION', // REQUIRED
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

NotAuthorizedException:

The caller is not authorized to perform this operation.

VersionMismatchException:

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.

UpdateImageGenerationConfiguration

$result = $client->updateImageGenerationConfiguration([/* ... */]);
$promise = $client->updateImageGenerationConfigurationAsync([/* ... */]);

Updates the StreamInfo and ImageProcessingConfiguration fields.

Parameter Syntax

$result = $client->updateImageGenerationConfiguration([
    'ImageGenerationConfiguration' => [
        'DestinationConfig' => [ // REQUIRED
            'DestinationRegion' => '<string>', // REQUIRED
            'Uri' => '<string>', // REQUIRED
        ],
        'Format' => 'JPEG|PNG', // REQUIRED
        'FormatConfig' => ['<string>', ...],
        'HeightPixels' => <integer>,
        'ImageSelectorType' => 'SERVER_TIMESTAMP|PRODUCER_TIMESTAMP', // REQUIRED
        'SamplingInterval' => <integer>, // REQUIRED
        'Status' => 'ENABLED|DISABLED', // REQUIRED
        'WidthPixels' => <integer>,
    ],
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

NoDataRetentionException:

The Stream data retention in hours is equal to zero.

UpdateMediaStorageConfiguration

$result = $client->updateMediaStorageConfiguration([/* ... */]);
$promise = $client->updateMediaStorageConfigurationAsync([/* ... */]);

Associates a SignalingChannel to a stream to store the media. There are two signaling modes that you can specify :

• If StorageStatus is enabled, the data will be stored in the StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled.

• If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed.

Parameter Syntax

$result = $client->updateMediaStorageConfiguration([
    'ChannelARN' => '<string>', // REQUIRED
    'MediaStorageConfiguration' => [ // REQUIRED
        'Status' => 'ENABLED|DISABLED', // REQUIRED
        'StreamARN' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

NoDataRetentionException:

The Stream data retention in hours is equal to zero.

UpdateNotificationConfiguration

$result = $client->updateNotificationConfiguration([/* ... */]);
$promise = $client->updateNotificationConfigurationAsync([/* ... */]);

Updates the notification information for a stream.

Parameter Syntax

$result = $client->updateNotificationConfiguration([
    'NotificationConfiguration' => [
        'DestinationConfig' => [ // REQUIRED
            'Uri' => '<string>', // REQUIRED
        ],
        'Status' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

AccessDeniedException:

You do not have required permissions to perform this operation.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

NoDataRetentionException:

The Stream data retention in hours is equal to zero.

UpdateSignalingChannel

$result = $client->updateSignalingChannel([/* ... */]);
$promise = $client->updateSignalingChannelAsync([/* ... */]);

Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.

Parameter Syntax

$result = $client->updateSignalingChannel([
    'ChannelARN' => '<string>', // REQUIRED
    'CurrentVersion' => '<string>', // REQUIRED
    'SingleMasterConfiguration' => [
        'MessageTtlSeconds' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidArgumentException:

The value for this input parameter is invalid.

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

AccessDeniedException:

You do not have required permissions to perform this operation.

VersionMismatchException:

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.

UpdateStream

$result = $client->updateStream([/* ... */]);
$promise = $client->updateStreamAsync([/* ... */]);

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

UpdateStream is an asynchronous operation, and takes time to complete.

Parameter Syntax

$result = $client->updateStream([
    'CurrentVersion' => '<string>', // REQUIRED
    'DeviceName' => '<string>',
    'MediaType' => '<string>',
    'StreamARN' => '<string>',
    'StreamName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientLimitExceededException:

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

InvalidArgumentException:

The value for this input parameter is invalid.

ResourceNotFoundException:

Amazon Kinesis Video Streams can't find the stream that you specified.

ResourceInUseException:

When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following :

1. The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to.

2. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to.

3. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource.

NotAuthorizedException:

The caller is not authorized to perform this operation.

VersionMismatchException:

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.