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

Class: Aws::Chime::Types::InviteUsersRequest

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

Overview

Note:

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

{
  account_id: "NonEmptyString", # required
  user_email_list: ["EmailAddress"], # required
  user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The Amazon Chime account ID.

Returns:

  • (String)


2322
2323
2324
2325
2326
2327
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2322

class InviteUsersRequest < Struct.new(
  :account_id,
  :user_email_list,
  :user_type)
  include Aws::Structure
end

#user_email_listArray<String>

The user email addresses to which to send the email invitation.

Returns:

  • (Array<String>)


2322
2323
2324
2325
2326
2327
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2322

class InviteUsersRequest < Struct.new(
  :account_id,
  :user_email_list,
  :user_type)
  include Aws::Structure
end

#user_typeString

The user type.

Returns:

  • (String)


2322
2323
2324
2325
2326
2327
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2322

class InviteUsersRequest < Struct.new(
  :account_id,
  :user_email_list,
  :user_type)
  include Aws::Structure
end