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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb

Overview

Note:

When making an API call, you may pass UpdateDataRetentionInput data as a 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#current_versionString

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)


524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 524

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  include Aws::Structure
end

#data_retention_change_in_hoursInteger

The retention period, in hours. The value you specify replaces the current value.

Returns:

  • (Integer)


524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 524

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  include Aws::Structure
end

#operationString

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

Returns:

  • (String)


524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 524

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  include Aws::Structure
end

#stream_arnString

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

Returns:

  • (String)


524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 524

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  include Aws::Structure
end

#stream_nameString

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

Returns:

  • (String)


524
525
526
527
528
529
530
531
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 524

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  include Aws::Structure
end