Class: Aws::Organizations::Types::Account

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

Overview

Contains information about an Amazon Web Services account that is a member of an organization.

Constant Summary collapse

SENSITIVE =
[:email, :name]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the account.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

Returns:

  • (String)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 182

class Account < Struct.new(
  :id,
  :arn,
  :email,
  :name,
  :status,
  :state,
  :joined_method,
  :joined_timestamp)
  SENSITIVE = [:email, :name]
  include Aws::Structure
end

#emailString

The email address associated with the Amazon Web Services account.

The regex pattern for this parameter is a string of characters that represents a standard internet email address.

Returns:

  • (String)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 182

class Account < Struct.new(
  :id,
  :arn,
  :email,
  :name,
  :status,
  :state,
  :joined_method,
  :joined_timestamp)
  SENSITIVE = [:email, :name]
  include Aws::Structure
end

#idString

The unique identifier (ID) of the account.

The regex pattern for an account ID string requires exactly 12 digits.

Returns:

  • (String)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 182

class Account < Struct.new(
  :id,
  :arn,
  :email,
  :name,
  :status,
  :state,
  :joined_method,
  :joined_timestamp)
  SENSITIVE = [:email, :name]
  include Aws::Structure
end

#joined_methodString

The method by which the account joined the organization.

Returns:

  • (String)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 182

class Account < Struct.new(
  :id,
  :arn,
  :email,
  :name,
  :status,
  :state,
  :joined_method,
  :joined_timestamp)
  SENSITIVE = [:email, :name]
  include Aws::Structure
end

#joined_timestampTime

The date the account became a part of the organization.

Returns:

  • (Time)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 182

class Account < Struct.new(
  :id,
  :arn,
  :email,
  :name,
  :status,
  :state,
  :joined_method,
  :joined_timestamp)
  SENSITIVE = [:email, :name]
  include Aws::Structure
end

#nameString

The friendly name of the account.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

Returns:

  • (String)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 182

class Account < Struct.new(
  :id,
  :arn,
  :email,
  :name,
  :status,
  :state,
  :joined_method,
  :joined_timestamp)
  SENSITIVE = [:email, :name]
  include Aws::Structure
end

#stateString

Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

Returns:

  • (String)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 182

class Account < Struct.new(
  :id,
  :arn,
  :email,
  :name,
  :status,
  :state,
  :joined_method,
  :joined_timestamp)
  SENSITIVE = [:email, :name]
  include Aws::Structure
end

#statusString

The status of the account in the organization.

The Status parameter in the Account object will be retired on September 9, 2026. Although both the account State and account Status parameters are currently available in the Organizations APIs (DescribeAccount, ListAccounts, ListAccountsForParent), we recommend that you update your scripts or other code to use the State parameter instead of Status before September 9, 2026.

Returns:

  • (String)


182
183
184
185
186
187
188
189
190
191
192
193
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 182

class Account < Struct.new(
  :id,
  :arn,
  :email,
  :name,
  :status,
  :state,
  :joined_method,
  :joined_timestamp)
  SENSITIVE = [:email, :name]
  include Aws::Structure
end