Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data MemberDetail = MemberDetail' {
- accountId :: Maybe Text
- administratorId :: Maybe Text
- datasourcePackageIngestStates :: Maybe (HashMap DatasourcePackage DatasourcePackageIngestState)
- disabledReason :: Maybe MemberDisabledReason
- emailAddress :: Maybe Text
- graphArn :: Maybe Text
- invitationType :: Maybe InvitationType
- invitedTime :: Maybe ISO8601
- masterId :: Maybe Text
- percentOfGraphUtilization :: Maybe Double
- percentOfGraphUtilizationUpdatedTime :: Maybe ISO8601
- status :: Maybe MemberStatus
- updatedTime :: Maybe ISO8601
- volumeUsageByDatasourcePackage :: Maybe (HashMap DatasourcePackage DatasourcePackageUsageInfo)
- volumeUsageInBytes :: Maybe Integer
- volumeUsageUpdatedTime :: Maybe ISO8601
- newMemberDetail :: MemberDetail
- memberDetail_accountId :: Lens' MemberDetail (Maybe Text)
- memberDetail_administratorId :: Lens' MemberDetail (Maybe Text)
- memberDetail_datasourcePackageIngestStates :: Lens' MemberDetail (Maybe (HashMap DatasourcePackage DatasourcePackageIngestState))
- memberDetail_disabledReason :: Lens' MemberDetail (Maybe MemberDisabledReason)
- memberDetail_emailAddress :: Lens' MemberDetail (Maybe Text)
- memberDetail_graphArn :: Lens' MemberDetail (Maybe Text)
- memberDetail_invitationType :: Lens' MemberDetail (Maybe InvitationType)
- memberDetail_invitedTime :: Lens' MemberDetail (Maybe UTCTime)
- memberDetail_masterId :: Lens' MemberDetail (Maybe Text)
- memberDetail_percentOfGraphUtilization :: Lens' MemberDetail (Maybe Double)
- memberDetail_percentOfGraphUtilizationUpdatedTime :: Lens' MemberDetail (Maybe UTCTime)
- memberDetail_status :: Lens' MemberDetail (Maybe MemberStatus)
- memberDetail_updatedTime :: Lens' MemberDetail (Maybe UTCTime)
- memberDetail_volumeUsageByDatasourcePackage :: Lens' MemberDetail (Maybe (HashMap DatasourcePackage DatasourcePackageUsageInfo))
- memberDetail_volumeUsageInBytes :: Lens' MemberDetail (Maybe Integer)
- memberDetail_volumeUsageUpdatedTime :: Lens' MemberDetail (Maybe UTCTime)
Documentation
data MemberDetail Source #
Details about a member account in a behavior graph.
See: newMemberDetail
smart constructor.
MemberDetail' | |
|
Instances
newMemberDetail :: MemberDetail Source #
Create a value of MemberDetail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:MemberDetail'
, memberDetail_accountId
- The Amazon Web Services account identifier for the member account.
$sel:administratorId:MemberDetail'
, memberDetail_administratorId
- The Amazon Web Services account identifier of the administrator account
for the behavior graph.
$sel:datasourcePackageIngestStates:MemberDetail'
, memberDetail_datasourcePackageIngestStates
- The state of a data source package for the behavior graph.
$sel:disabledReason:MemberDetail'
, memberDetail_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.
$sel:emailAddress:MemberDetail'
, memberDetail_emailAddress
- The Amazon Web Services account root user email address for the member
account.
$sel:graphArn:MemberDetail'
, memberDetail_graphArn
- The ARN of the behavior graph.
$sel:invitationType:MemberDetail'
, memberDetail_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
.
$sel:invitedTime:MemberDetail'
, memberDetail_invitedTime
- 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
.
$sel:masterId:MemberDetail'
, memberDetail_masterId
- The Amazon Web Services account identifier of the administrator account
for the behavior graph.
$sel:percentOfGraphUtilization:MemberDetail'
, memberDetail_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.
$sel:percentOfGraphUtilizationUpdatedTime:MemberDetail'
, memberDetail_percentOfGraphUtilizationUpdatedTime
- 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
.
$sel:status:MemberDetail'
, memberDetail_status
- 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.
$sel:updatedTime:MemberDetail'
, memberDetail_updatedTime
- 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
.
$sel:volumeUsageByDatasourcePackage:MemberDetail'
, memberDetail_volumeUsageByDatasourcePackage
- Details on the volume of usage for each data source package in a
behavior graph.
MemberDetail
, memberDetail_volumeUsageInBytes
- The data volume in bytes per day for the member account.
$sel:volumeUsageUpdatedTime:MemberDetail'
, memberDetail_volumeUsageUpdatedTime
- 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
.
memberDetail_accountId :: Lens' MemberDetail (Maybe Text) Source #
The Amazon Web Services account identifier for the member account.
memberDetail_administratorId :: Lens' MemberDetail (Maybe Text) Source #
The Amazon Web Services account identifier of the administrator account for the behavior graph.
memberDetail_datasourcePackageIngestStates :: Lens' MemberDetail (Maybe (HashMap DatasourcePackage DatasourcePackageIngestState)) Source #
The state of a data source package for the behavior graph.
memberDetail_disabledReason :: Lens' MemberDetail (Maybe MemberDisabledReason) Source #
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.
memberDetail_emailAddress :: Lens' MemberDetail (Maybe Text) Source #
The Amazon Web Services account root user email address for the member account.
memberDetail_graphArn :: Lens' MemberDetail (Maybe Text) Source #
The ARN of the behavior graph.
memberDetail_invitationType :: Lens' MemberDetail (Maybe InvitationType) Source #
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
.
memberDetail_invitedTime :: Lens' MemberDetail (Maybe UTCTime) Source #
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
.
memberDetail_masterId :: Lens' MemberDetail (Maybe Text) Source #
The Amazon Web Services account identifier of the administrator account for the behavior graph.
memberDetail_percentOfGraphUtilization :: Lens' MemberDetail (Maybe Double) Source #
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.
memberDetail_percentOfGraphUtilizationUpdatedTime :: Lens' MemberDetail (Maybe UTCTime) Source #
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
.
memberDetail_status :: Lens' MemberDetail (Maybe MemberStatus) Source #
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.
memberDetail_updatedTime :: Lens' MemberDetail (Maybe UTCTime) Source #
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
.
memberDetail_volumeUsageByDatasourcePackage :: Lens' MemberDetail (Maybe (HashMap DatasourcePackage DatasourcePackageUsageInfo)) Source #
Details on the volume of usage for each data source package in a behavior graph.
memberDetail_volumeUsageInBytes :: Lens' MemberDetail (Maybe Integer) Source #
The data volume in bytes per day for the member account.
memberDetail_volumeUsageUpdatedTime :: Lens' MemberDetail (Maybe UTCTime) Source #
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
.