Class: Aws::Organizations::Types::Account
- Inherits:
-
Struct
- Object
- Struct
- Aws::Organizations::Types::Account
- 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
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the account.
-
#email ⇒ String
The email address associated with the Amazon Web Services account.
-
#id ⇒ String
The unique identifier (ID) of the account.
-
#joined_method ⇒ String
The method by which the account joined the organization.
-
#joined_timestamp ⇒ Time
The date the account became a part of the organization.
-
#name ⇒ String
The friendly name of the account.
-
#state ⇒ String
Each state represents a specific phase in the account lifecycle.
-
#status ⇒ String
The status of the account in the organization.
Instance Attribute Details
#arn ⇒ String
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.
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 |
#email ⇒ String
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.
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 |
#id ⇒ String
The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
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_method ⇒ String
The method by which the account joined the organization.
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_timestamp ⇒ Time
The date the account became a part of the organization.
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 |
#name ⇒ String
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.
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 |
#state ⇒ String
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.
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 |
#status ⇒ String
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.
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 |