You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KinesisVideo::Types::UpdateDataRetentionInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateDataRetentionInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
  current_version: "Version", # required
  operation: "INCREASE_DATA_RETENTION", # required, accepts INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
  data_retention_change_in_hours: 1, # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#current_version ⇒ String

The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

Returns:

  • (String) —

    The version of the stream whose retention period you want to change.

#data_retention_change_in_hours ⇒ Integer

The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).

Returns:

  • (Integer) —

    The retention period, in hours.

#operation ⇒ String

Indicates whether you want to increase or decrease the retention period.

Possible values:

  • INCREASE_DATA_RETENTION
  • DECREASE_DATA_RETENTION

Returns:

  • (String) —

    Indicates whether you want to increase or decrease the retention period.

#stream_arn ⇒ String

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

#stream_name ⇒ String

The name of the stream whose retention period you want to change.

Returns:

  • (String) —

    The name of the stream whose retention period you want to change.