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

Class: Aws::GuardDuty::Types::InviteMembersRequest

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

Overview

Note:

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

{
  account_ids: ["__string"],
  detector_id: "__string", # required
  disable_email_notification: false,
  message: "Message",
}

InviteMembers request body.

Instance Attribute Summary collapse

Instance Attribute Details

#account_idsArray<String>

A list of account IDs of the accounts that you want to invite to GuardDuty as members.

Returns:

  • (Array<String>)


1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1615

class InviteMembersRequest < Struct.new(
  :account_ids,
  :detector_id,
  :disable_email_notification,
  :message)
  include Aws::Structure
end

#detector_idString

Returns:

  • (String)


1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1615

class InviteMembersRequest < Struct.new(
  :account_ids,
  :detector_id,
  :disable_email_notification,
  :message)
  include Aws::Structure
end

#disable_email_notificationBoolean

A boolean value that specifies whether you want to disable email notification to the accounts that you’re inviting to GuardDuty as members.

Returns:

  • (Boolean)


1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1615

class InviteMembersRequest < Struct.new(
  :account_ids,
  :detector_id,
  :disable_email_notification,
  :message)
  include Aws::Structure
end

#messageString

The invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members.

Returns:

  • (String)


1615
1616
1617
1618
1619
1620
1621
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 1615

class InviteMembersRequest < Struct.new(
  :account_ids,
  :detector_id,
  :disable_email_notification,
  :message)
  include Aws::Structure
end