Struct aws_sdk_detective::types::MemberDetail

#[non_exhaustive]
pub struct MemberDetail {

    pub account_id: Option<String>,
    pub email_address: Option<String>,
    pub graph_arn: Option<String>,
    pub master_id: Option<String>,
    pub administrator_id: Option<String>,
    pub status: Option<MemberStatus>,
    pub disabled_reason: Option<MemberDisabledReason>,
    pub invited_time: Option<DateTime>,
    pub updated_time: Option<DateTime>,
    pub volume_usage_in_bytes: Option<i64>,
    pub volume_usage_updated_time: Option<DateTime>,
    pub percent_of_graph_utilization: Option<f64>,
    pub percent_of_graph_utilization_updated_time: Option<DateTime>,
    pub invitation_type: Option<InvitationType>,
    pub volume_usage_by_datasource_package: Option<HashMap<DatasourcePackage, DatasourcePackageUsageInfo>>,
    pub datasource_package_ingest_states: Option<HashMap<DatasourcePackage, DatasourcePackageIngestState>>,
}

Details about a member account in a behavior graph.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

account_id: Option<String>

The Amazon Web Services account identifier for the member account.

email_address: Option<String>

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

graph_arn: Option<String>

The ARN of the behavior graph.

master_id: Option<String>

👎Deprecated: This property is deprecated. Use AdministratorId instead.

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

administrator_id: Option<String>

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

status: Option<MemberStatus>

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.

disabled_reason: Option<MemberDisabledReason>

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.

invited_time: Option<DateTime>

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.

updated_time: Option<DateTime>

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.

volume_usage_in_bytes: Option<i64>

👎Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

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

volume_usage_updated_time: Option<DateTime>

👎Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

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.

percent_of_graph_utilization: Option<f64>

👎Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

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.

percent_of_graph_utilization_updated_time: Option<DateTime>

👎Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

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.

invitation_type: Option<InvitationType>

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.

volume_usage_by_datasource_package: Option<HashMap<DatasourcePackage, DatasourcePackageUsageInfo>>

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

datasource_package_ingest_states: Option<HashMap<DatasourcePackage, DatasourcePackageIngestState>>

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

Implementations

impl MemberDetail

pub fn account_id(&self) -> Option<&str>

The Amazon Web Services account identifier for the member account.

pub fn email_address(&self) -> Option<&str>

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

pub fn graph_arn(&self) -> Option<&str>

The ARN of the behavior graph.

pub fn master_id(&self) -> Option<&str>

👎Deprecated: This property is deprecated. Use AdministratorId instead.

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

pub fn administrator_id(&self) -> Option<&str>

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

pub fn status(&self) -> Option<&MemberStatus>

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.

pub fn disabled_reason(&self) -> Option<&MemberDisabledReason>

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.

pub fn invited_time(&self) -> Option<&DateTime>

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.

pub fn updated_time(&self) -> Option<&DateTime>

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.

pub fn volume_usage_in_bytes(&self) -> Option<i64>

👎Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

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

pub fn volume_usage_updated_time(&self) -> Option<&DateTime>

👎Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

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.

pub fn percent_of_graph_utilization(&self) -> Option<f64>

👎Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

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.

pub fn percent_of_graph_utilization_updated_time(&self) -> Option<&DateTime>

👎Deprecated: This property is deprecated. Use VolumeUsageByDatasourcePackage instead.

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.

pub fn invitation_type(&self) -> Option<&InvitationType>

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.

pub fn volume_usage_by_datasource_package( &self ) -> Option<&HashMap<DatasourcePackage, DatasourcePackageUsageInfo>>

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

pub fn datasource_package_ingest_states( &self ) -> Option<&HashMap<DatasourcePackage, DatasourcePackageIngestState>>

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

impl MemberDetail

pub fn builder() -> MemberDetailBuilder

Creates a new builder-style object to manufacture MemberDetail.

Trait Implementations

impl Clone for MemberDetail

fn clone(&self) -> MemberDetail

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MemberDetail

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MemberDetail

fn eq(&self, other: &MemberDetail) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MemberDetail