diff --git a/AWSKinesisVideo/AWSKinesisVideoModel.h b/AWSKinesisVideo/AWSKinesisVideoModel.h index c704a2f7033..2313872cba7 100644 --- a/AWSKinesisVideo/AWSKinesisVideoModel.h +++ b/AWSKinesisVideo/AWSKinesisVideoModel.h @@ -1300,7 +1300,7 @@ typedef NS_ENUM(NSInteger, AWSKinesisVideoUploaderStatus) { @end /** -
A structure that encapsulates, or contains, the media storage configuration properties.
+A structure that encapsulates, or contains, the media storage configuration properties.
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.
The Amazon Resource Name (ARN) of the stream
+The Amazon Resource Name (ARN) of the stream.
*/ @property (nonatomic, strong) NSString * _Nullable streamARN; @@ -1720,7 +1720,7 @@ typedef NS_ENUM(NSInteger, AWSKinesisVideoUploaderStatus) { @property (nonatomic, strong) NSString * _Nullable currentVersion; /** -The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
+The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the operation
.
The minimum value for data retention is 0 and the maximum value is 87600 (ten years).
*/ @property (nonatomic, strong) NSNumber * _Nullable dataRetentionChangeInHours; diff --git a/AWSKinesisVideo/AWSKinesisVideoResources.m b/AWSKinesisVideo/AWSKinesisVideoResources.m index 572fcfd9f55..d72b25cb3c6 100644 --- a/AWSKinesisVideo/AWSKinesisVideoResources.m +++ b/AWSKinesisVideo/AWSKinesisVideoResources.m @@ -222,7 +222,7 @@ - (NSString *)definitionString { {\"shape\":\"AccessDeniedException\"},\ {\"shape\":\"ClientLimitExceededException\"}\ ],\ - \"documentation\":\"This API is related to WebRTC Ingestion and is only available in the us-west-2
region.
Returns the most current information about the channel. Specify the ChannelName
or ChannelARN
in the input.
Returns the most current information about the channel. Specify the ChannelName
or ChannelARN
in the input.
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
.
The retention period that you specify replaces the current value.
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.
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.
This API is related to WebRTC Ingestion and is only available in the us-west-2
region.
Associates a SignalingChannel
to a stream to store the media. There are two signaling modes that can specified :
If the StorageStatus
is disabled, no data will be stored, and the StreamARN
parameter will not be needed.
If the StorageStatus
is enabled, the data will be stored in the StreamARN
provided.
If StorageStatus
is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession
API to trigger an SDP offer send and establish a connection between a peer and the storage session.
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.
If StorageStatus
is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession
API to trigger an SDP offer send and establish a connection between a peer and the storage session.
The Amazon Resource Name (ARN) of the stream
\"\ + \"documentation\":\"The Amazon Resource Name (ARN) of the stream.
\"\ },\ \"Status\":{\ \"shape\":\"MediaStorageConfigurationStatus\",\ \"documentation\":\"The status of the media storage configuration.
\"\ }\ },\ - \"documentation\":\"A structure that encapsulates, or contains, the media storage configuration properties.
\"\ + \"documentation\":\"A structure that encapsulates, or contains, the media storage configuration properties.
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.
The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
\"\ + \"documentation\":\"The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the operation
.
The minimum value for data retention is 0 and the maximum value is 87600 (ten years).
\"\ }\ }\ },\ diff --git a/AWSKinesisVideo/AWSKinesisVideoService.h b/AWSKinesisVideo/AWSKinesisVideoService.h index 6478f274acd..0795224a715 100644 --- a/AWSKinesisVideo/AWSKinesisVideoService.h +++ b/AWSKinesisVideo/AWSKinesisVideoService.h @@ -375,7 +375,7 @@ FOUNDATION_EXPORT NSString *const AWSKinesisVideoSDKVersion; - (void)describeMappedResourceConfiguration:(AWSKinesisVideoDescribeMappedResourceConfigurationInput *)request completionHandler:(void (^ _Nullable)(AWSKinesisVideoDescribeMappedResourceConfigurationOutput * _Nullable response, NSError * _Nullable error))completionHandler; /** -This API is related to WebRTC Ingestion and is only available in the us-west-2
region.
Returns the most current information about the channel. Specify the ChannelName
or ChannelARN
in the input.
Returns the most current information about the channel. Specify the ChannelName
or ChannelARN
in the input.
This API is related to WebRTC Ingestion and is only available in the us-west-2
region.
Returns the most current information about the channel. Specify the ChannelName
or ChannelARN
in the input.
Returns the most current information about the channel. Specify the ChannelName
or ChannelARN
in the input.
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
.
The retention period that you specify replaces the current value.
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.
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.
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
.
The retention period that you specify replaces the current value.
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.
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.
This API is related to WebRTC Ingestion and is only available in the us-west-2
region.
Associates a SignalingChannel
to a stream to store the media. There are two signaling modes that can specified :
If the StorageStatus
is disabled, no data will be stored, and the StreamARN
parameter will not be needed.
If the StorageStatus
is enabled, the data will be stored in the StreamARN
provided.
If StorageStatus
is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession
API to trigger an SDP offer send and establish a connection between a peer and the storage session.
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.
If StorageStatus
is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession
API to trigger an SDP offer send and establish a connection between a peer and the storage session.
This API is related to WebRTC Ingestion and is only available in the us-west-2
region.
Associates a SignalingChannel
to a stream to store the media. There are two signaling modes that can specified :
If the StorageStatus
is disabled, no data will be stored, and the StreamARN
parameter will not be needed.
If the StorageStatus
is enabled, the data will be stored in the StreamARN
provided.
If StorageStatus
is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession
API to trigger an SDP offer send and establish a connection between a peer and the storage session.
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.
If StorageStatus
is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the JoinStorageSession
API to trigger an SDP offer send and establish a connection between a peer and the storage session.