Class: Aws::AlexaForBusiness::Types::RegisterAVSDeviceRequest

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

Overview

Note:

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

{
  client_id: "ClientId", # required
  user_code: "UserCode", # required
  product_id: "ProductId", # required
  device_serial_number: "DeviceSerialNumberForAVS",
  amazon_id: "AmazonId", # required
  room_arn: "Arn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#amazon_idString

The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

Returns:

  • (String)


4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4306

class RegisterAVSDeviceRequest < Struct.new(
  :client_id,
  :user_code,
  :product_id,
  :device_serial_number,
  :amazon_id,
  :room_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_idString

The client ID of the OEM used for code-based linking authorization on an AVS device.

Returns:

  • (String)


4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4306

class RegisterAVSDeviceRequest < Struct.new(
  :client_id,
  :user_code,
  :product_id,
  :device_serial_number,
  :amazon_id,
  :room_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#device_serial_numberString

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

Returns:

  • (String)


4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4306

class RegisterAVSDeviceRequest < Struct.new(
  :client_id,
  :user_code,
  :product_id,
  :device_serial_number,
  :amazon_id,
  :room_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#product_idString

The product ID used to identify your AVS device during authorization.

Returns:

  • (String)


4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4306

class RegisterAVSDeviceRequest < Struct.new(
  :client_id,
  :user_code,
  :product_id,
  :device_serial_number,
  :amazon_id,
  :room_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#room_arnString

The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

Returns:

  • (String)


4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4306

class RegisterAVSDeviceRequest < Struct.new(
  :client_id,
  :user_code,
  :product_id,
  :device_serial_number,
  :amazon_id,
  :room_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to be added to the specified resource. Do not provide system tags.

Returns:



4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4306

class RegisterAVSDeviceRequest < Struct.new(
  :client_id,
  :user_code,
  :product_id,
  :device_serial_number,
  :amazon_id,
  :room_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#user_codeString

The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

Returns:

  • (String)


4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 4306

class RegisterAVSDeviceRequest < Struct.new(
  :client_id,
  :user_code,
  :product_id,
  :device_serial_number,
  :amazon_id,
  :room_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end