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

Class: Aws::IoT::Types::UpdateStreamRequest

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

Overview

Note:

When making an API call, you may pass UpdateStreamRequest data as a hash:

{
  stream_id: "StreamId", # required
  description: "StreamDescription",
  files: [
    {
      file_id: 1,
      s3_location: {
        bucket: "S3Bucket", # required
        key: "S3Key", # required
        version: "S3Version",
      },
    },
  ],
  role_arn: "RoleArn",
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the stream.

Returns:

  • (String)


8010
8011
8012
8013
8014
8015
8016
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8010

class UpdateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn)
  include Aws::Structure
end

#filesArray<Types::StreamFile>

The files associated with the stream.

Returns:



8010
8011
8012
8013
8014
8015
8016
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8010

class UpdateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn)
  include Aws::Structure
end

#role_arnString

An IAM role that allows the IoT service principal assumes to access your S3 files.

Returns:

  • (String)


8010
8011
8012
8013
8014
8015
8016
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8010

class UpdateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn)
  include Aws::Structure
end

#stream_idString

The stream ID.

Returns:

  • (String)


8010
8011
8012
8013
8014
8015
8016
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8010

class UpdateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn)
  include Aws::Structure
end