software.amazon.awssdk.services.detective.model

Class MemberDetail

java.lang.Object

software.amazon.awssdk.services.detective.model.MemberDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MemberDetail.Builder,MemberDetail>

@Generated(value="software.amazon.awssdk:codegen")
public final class MemberDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MemberDetail.Builder,MemberDetail>

Details about a member account that was invited to contribute to a behavior graph.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MemberDetail.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The AWS account identifier for the member account.
static MemberDetail.Builder	builder()
MemberDisabledReason	disabledReason() For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.
String	disabledReasonAsString() For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that the member account is not enabled.
String	emailAddress() The AWS account root user email address for the member account.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	graphArn() The ARN of the behavior graph that the member account was invited to.
int	hashCode()
Instant	invitedTime() The date and time that Detective sent the invitation to the member account.
String	masterId() The AWS account identifier of the master account for the behavior graph.
Double	percentOfGraphUtilization() The member account data volume as a percentage of the maximum allowed data volume.
Instant	percentOfGraphUtilizationUpdatedTime() The date and time when the graph utilization percentage was last updated.
List<SdkField<?>>	sdkFields()
static Class<? extends MemberDetail.Builder>	serializableBuilderClass()
MemberStatus	status() The current membership status of the member account.
String	statusAsString() The current membership status of the member account.
MemberDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedTime() The date and time that the member account was last updated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accountId

public final String accountId()

The AWS account identifier for the member account.

Returns:

The AWS account identifier for the member account.

emailAddress

public final String emailAddress()

The AWS account root user email address for the member account.

Returns:

The AWS account root user email address for the member account.

graphArn

public final String graphArn()

The ARN of the behavior graph that the member account was invited to.

Returns:

The ARN of the behavior graph that the member account was invited to.

masterId

public final String masterId()

The AWS account identifier of the master account for the behavior graph.

Returns:

The AWS account identifier of the master account for the behavior graph.

status

public final MemberStatus status()

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

• INVITED - Indicates that the member was sent an invitation but has not yet responded.

• VERIFICATION_IN_PROGRESS - 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.

• VERIFICATION_FAILED - 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 accepted the invitation to contribute to the behavior graph.

• ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

If the service returns an enum value that is not available in the current SDK version, status will return MemberStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

• INVITED - Indicates that the member was sent an invitation but has not yet responded.

• VERIFICATION_IN_PROGRESS - 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.

• VERIFICATION_FAILED - 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 accepted the invitation to contribute to the behavior graph.

• ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

See Also:

MemberStatus

statusAsString

public final String statusAsString()

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

• INVITED - Indicates that the member was sent an invitation but has not yet responded.

• VERIFICATION_IN_PROGRESS - 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.

• VERIFICATION_FAILED - 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 accepted the invitation to contribute to the behavior graph.

• ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

If the service returns an enum value that is not available in the current SDK version, status will return MemberStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

• INVITED - Indicates that the member was sent an invitation but has not yet responded.

• VERIFICATION_IN_PROGRESS - 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.

• VERIFICATION_FAILED - 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 accepted the invitation to contribute to the behavior graph.

• ACCEPTED_BUT_DISABLED - Indicates that the member account accepted the invitation but is prevented from contributing data to the behavior graph. DisabledReason provides the reason why the member account is not enabled.

Member accounts that declined an invitation or that were removed from the behavior graph are not included.

See Also:

MemberStatus

disabledReason

public final MemberDisabledReason disabledReason()

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.

If the service returns an enum value that is not available in the current SDK version, disabledReason will return MemberDisabledReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from disabledReasonAsString().

Returns:

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.

See Also:

MemberDisabledReason

disabledReasonAsString

public final String disabledReasonAsString()

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.

If the service returns an enum value that is not available in the current SDK version, disabledReason will return MemberDisabledReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from disabledReasonAsString().

Returns:

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.

See Also:

MemberDisabledReason

invitedTime

public final Instant invitedTime()

The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.

Returns:

The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.

updatedTime

public final Instant updatedTime()

The date and time that the member account was last updated. The value is in milliseconds since the epoch.

Returns:

The date and time that the member account was last updated. The value is in milliseconds since the epoch.

percentOfGraphUtilization

public final Double percentOfGraphUtilization()

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:

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.

percentOfGraphUtilizationUpdatedTime

public final Instant percentOfGraphUtilizationUpdatedTime()

The date and time when the graph utilization percentage was last updated.

Returns:

The date and time when the graph utilization percentage was last updated.

toBuilder

public MemberDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MemberDetail.Builder,MemberDetail>

builder

public static MemberDetail.Builder builder()

serializableBuilderClass

public static Class<? extends MemberDetail.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo