Class: Aws::Detective::Types::MemberDetail

Inherits:

Struct

Object
Struct
Aws::Detective::Types::MemberDetail

show all

Defined in:: gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb

Overview

Details about a member account in a behavior graph.

Constant Summary collapse

SENSITIVE =

[:email_address]

Instance Attribute Summary collapse

#account_id ⇒ String
The Amazon Web Services account identifier for the member account.
#administrator_id ⇒ String
The Amazon Web Services account identifier of the administrator account for the behavior graph.
#datasource_package_ingest_states ⇒ Hash<String,String>
The state of a data source package for the behavior graph.
#disabled_reason ⇒ String
For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.
#email_address ⇒ String
The Amazon Web Services account root user email address for the member account.
#graph_arn ⇒ String
The ARN of the behavior graph.
#invitation_type ⇒ String
The type of behavior graph membership.
#invited_time ⇒ Time
For invited accounts, the date and time that Detective sent the invitation to the account.
#master_id ⇒ String
The Amazon Web Services account identifier of the administrator account for the behavior graph.
#percent_of_graph_utilization ⇒ Float
The member account data volume as a percentage of the maximum allowed data volume.
#percent_of_graph_utilization_updated_time ⇒ Time
The date and time when the graph utilization percentage was last updated.
#status ⇒ String
The current membership status of the member account.
#updated_time ⇒ Time
The date and time that the member account was last updated.
#volume_usage_by_datasource_package ⇒ Hash<String,Types::DatasourcePackageUsageInfo>
Details on the volume of usage for each data source package in a behavior graph.
#volume_usage_in_bytes ⇒ Integer
The data volume in bytes per day for the member account.
#volume_usage_updated_time ⇒ Time
The data and time when the member account data volume was last updated.

Instance Attribute Details

#account_id ⇒ `String`

The Amazon Web Services account identifier for the member account.

Returns:

(String)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#administrator_id ⇒ `String`

The Amazon Web Services account identifier of the administrator account for the behavior graph.

Returns:

(String)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#datasource_package_ingest_states ⇒ `Hash<String,String>`

The state of a data source package for the behavior graph.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#disabled_reason ⇒ `String`

For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.

The reason can have one of the following values:

VOLUME_TOO_HIGH - Indicates that adding the member account would cause the data volume for the behavior graph to be too high.
VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data volume for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

Returns:

(String)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#email_address ⇒ `String`

The Amazon Web Services account root user email address for the member account.

Returns:

(String)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#graph_arn ⇒ `String`

The ARN of the behavior graph.

Returns:

(String)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#invitation_type ⇒ `String`

The type of behavior graph membership.

For an organization account in the organization behavior graph, the type is ORGANIZATION.

For an account that was invited to a behavior graph, the type is INVITATION.

Returns:

(String)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#invited_time ⇒ `Time`

For invited accounts, the date and time that Detective sent the invitation to the account. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

Returns:

(Time)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#master_id ⇒ `String`

The Amazon Web Services account identifier of the administrator account for the behavior graph.

Returns:

(String)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#percent_of_graph_utilization ⇒ `Float`

The member account data volume as a percentage of the maximum allowed data volume. 0 indicates 0 percent, and 100 indicates 100 percent.

Note that this is not the percentage of the behavior graph data volume.

For example, the data volume for the behavior graph is 80 GB per day. The maximum data volume is 160 GB per day. If the data volume for the member account is 40 GB per day, then PercentOfGraphUtilization is 25. It represents 25% of the maximum allowed data volume.

Returns:

(Float)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#percent_of_graph_utilization_updated_time ⇒ `Time`

The date and time when the graph utilization percentage was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

Returns:

(Time)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#status ⇒ `String`

The current membership status of the member account. The status can have one of the following values:

INVITED - For invited accounts only. Indicates that the member was sent an invitation but has not yet responded.
VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.

For organization accounts in the organization behavior graph, indicates that Detective is verifying that the account belongs to the organization.
VERIFICATION_FAILED - For invited accounts only. Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
ENABLED - Indicates that the member account currently contributes data to the behavior graph. For invited accounts, the member account accepted the invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member account.
ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was enabled by the Detective administrator account, but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Invited accounts that declined an invitation or that were removed from the behavior graph are not included. In the organization behavior graph, organization accounts that the Detective administrator account did not enable are not included.

Returns:

(String)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#updated_time ⇒ `Time`

The date and time that the member account was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

Returns:

(Time)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#volume_usage_by_datasource_package ⇒ `Hash<String,Types::DatasourcePackageUsageInfo>`

Details on the volume of usage for each data source package in a behavior graph.

Returns:

(Hash<String,Types::DatasourcePackageUsageInfo>)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#volume_usage_in_bytes ⇒ `Integer`

The data volume in bytes per day for the member account.

Returns:

(Integer)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

#volume_usage_updated_time ⇒ `Time`

The data and time when the member account data volume was last updated. The value is an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

Returns:

(Time)

# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/types.rb', line 1370

class MemberDetail < Struct.new(
  :account_id,
  :email_address,
  :graph_arn,
  :master_id,
  :administrator_id,
  :status,
  :disabled_reason,
  :invited_time,
  :updated_time,
  :volume_usage_in_bytes,
  :volume_usage_updated_time,
  :percent_of_graph_utilization,
  :percent_of_graph_utilization_updated_time,
  :invitation_type,
  :volume_usage_by_datasource_package,
  :datasource_package_ingest_states)
  SENSITIVE = [:email_address]
  include Aws::Structure
end

Class: Aws::Detective::Types::MemberDetail

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

#administrator_id ⇒ String

#datasource_package_ingest_states ⇒ Hash<String,String>

#disabled_reason ⇒ String

#email_address ⇒ String

#graph_arn ⇒ String

#invitation_type ⇒ String

#invited_time ⇒ Time

#master_id ⇒ String

#percent_of_graph_utilization ⇒ Float

#percent_of_graph_utilization_updated_time ⇒ Time

#status ⇒ String

#updated_time ⇒ Time

#volume_usage_by_datasource_package ⇒ Hash<String,Types::DatasourcePackageUsageInfo>

#volume_usage_in_bytes ⇒ Integer

#volume_usage_updated_time ⇒ Time

#account_id ⇒ `String`

#administrator_id ⇒ `String`

#datasource_package_ingest_states ⇒ `Hash<String,String>`

#disabled_reason ⇒ `String`

#email_address ⇒ `String`

#graph_arn ⇒ `String`

#invitation_type ⇒ `String`

#invited_time ⇒ `Time`

#master_id ⇒ `String`

#percent_of_graph_utilization ⇒ `Float`

#percent_of_graph_utilization_updated_time ⇒ `Time`

#status ⇒ `String`

#updated_time ⇒ `Time`

#volume_usage_by_datasource_package ⇒ `Hash<String,Types::DatasourcePackageUsageInfo>`

#volume_usage_in_bytes ⇒ `Integer`

#volume_usage_updated_time ⇒ `Time`