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

Class: Aws::WorkMail::Types::UpdatePrimaryEmailAddressRequest

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

Overview

Note:

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

{
  organization_id: "OrganizationId", # required
  entity_id: "WorkMailIdentifier", # required
  email: "EmailAddress", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#emailString

The value of the email to be updated as primary.

Returns:

  • (String)


1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1573

class UpdatePrimaryEmailAddressRequest < Struct.new(
  :organization_id,
  :entity_id,
  :email)
  include Aws::Structure
end

#entity_idString

The entity to update (user, group, or resource).

Returns:

  • (String)


1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1573

class UpdatePrimaryEmailAddressRequest < Struct.new(
  :organization_id,
  :entity_id,
  :email)
  include Aws::Structure
end

#organization_idString

The organization that contains the entity to update.

Returns:

  • (String)


1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 1573

class UpdatePrimaryEmailAddressRequest < Struct.new(
  :organization_id,
  :entity_id,
  :email)
  include Aws::Structure
end