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 |
- Operations
- AcceptInvitation
- BatchGetGraphMemberDatasources
- BatchGetMembershipDatasources
- CreateGraph
- CreateMembers
- DeleteGraph
- DeleteMembers
- DescribeOrganizationConfiguration
- DisableOrganizationAdminAccount
- DisassociateMembership
- EnableOrganizationAdminAccount
- GetMembers
- ListDatasourcePackages
- ListGraphs
- ListInvitations
- ListMembers
- ListOrganizationAdminAccounts
- ListTagsForResource
- RejectInvitation
- StartMonitoringMember
- TagResource
- UntagResource
- UpdateDatasourcePackages
- UpdateOrganizationConfiguration
- Types
Synopsis
- acceptInvitation_graphArn :: Lens' AcceptInvitation Text
- batchGetGraphMemberDatasources_graphArn :: Lens' BatchGetGraphMemberDatasources Text
- batchGetGraphMemberDatasources_accountIds :: Lens' BatchGetGraphMemberDatasources (NonEmpty Text)
- batchGetGraphMemberDatasourcesResponse_memberDatasources :: Lens' BatchGetGraphMemberDatasourcesResponse (Maybe [MembershipDatasources])
- batchGetGraphMemberDatasourcesResponse_unprocessedAccounts :: Lens' BatchGetGraphMemberDatasourcesResponse (Maybe [UnprocessedAccount])
- batchGetGraphMemberDatasourcesResponse_httpStatus :: Lens' BatchGetGraphMemberDatasourcesResponse Int
- batchGetMembershipDatasources_graphArns :: Lens' BatchGetMembershipDatasources (NonEmpty Text)
- batchGetMembershipDatasourcesResponse_membershipDatasources :: Lens' BatchGetMembershipDatasourcesResponse (Maybe [MembershipDatasources])
- batchGetMembershipDatasourcesResponse_unprocessedGraphs :: Lens' BatchGetMembershipDatasourcesResponse (Maybe [UnprocessedGraph])
- batchGetMembershipDatasourcesResponse_httpStatus :: Lens' BatchGetMembershipDatasourcesResponse Int
- createGraph_tags :: Lens' CreateGraph (Maybe (HashMap Text Text))
- createGraphResponse_graphArn :: Lens' CreateGraphResponse (Maybe Text)
- createGraphResponse_httpStatus :: Lens' CreateGraphResponse Int
- createMembers_disableEmailNotification :: Lens' CreateMembers (Maybe Bool)
- createMembers_message :: Lens' CreateMembers (Maybe Text)
- createMembers_graphArn :: Lens' CreateMembers Text
- createMembers_accounts :: Lens' CreateMembers (NonEmpty Account)
- createMembersResponse_members :: Lens' CreateMembersResponse (Maybe [MemberDetail])
- createMembersResponse_unprocessedAccounts :: Lens' CreateMembersResponse (Maybe [UnprocessedAccount])
- createMembersResponse_httpStatus :: Lens' CreateMembersResponse Int
- deleteGraph_graphArn :: Lens' DeleteGraph Text
- deleteMembers_graphArn :: Lens' DeleteMembers Text
- deleteMembers_accountIds :: Lens' DeleteMembers (NonEmpty Text)
- deleteMembersResponse_accountIds :: Lens' DeleteMembersResponse (Maybe (NonEmpty Text))
- deleteMembersResponse_unprocessedAccounts :: Lens' DeleteMembersResponse (Maybe [UnprocessedAccount])
- deleteMembersResponse_httpStatus :: Lens' DeleteMembersResponse Int
- describeOrganizationConfiguration_graphArn :: Lens' DescribeOrganizationConfiguration Text
- describeOrganizationConfigurationResponse_autoEnable :: Lens' DescribeOrganizationConfigurationResponse (Maybe Bool)
- describeOrganizationConfigurationResponse_httpStatus :: Lens' DescribeOrganizationConfigurationResponse Int
- disassociateMembership_graphArn :: Lens' DisassociateMembership Text
- enableOrganizationAdminAccount_accountId :: Lens' EnableOrganizationAdminAccount Text
- getMembers_graphArn :: Lens' GetMembers Text
- getMembers_accountIds :: Lens' GetMembers (NonEmpty Text)
- getMembersResponse_memberDetails :: Lens' GetMembersResponse (Maybe [MemberDetail])
- getMembersResponse_unprocessedAccounts :: Lens' GetMembersResponse (Maybe [UnprocessedAccount])
- getMembersResponse_httpStatus :: Lens' GetMembersResponse Int
- listDatasourcePackages_maxResults :: Lens' ListDatasourcePackages (Maybe Natural)
- listDatasourcePackages_nextToken :: Lens' ListDatasourcePackages (Maybe Text)
- listDatasourcePackages_graphArn :: Lens' ListDatasourcePackages Text
- listDatasourcePackagesResponse_datasourcePackages :: Lens' ListDatasourcePackagesResponse (Maybe (HashMap DatasourcePackage DatasourcePackageIngestDetail))
- listDatasourcePackagesResponse_nextToken :: Lens' ListDatasourcePackagesResponse (Maybe Text)
- listDatasourcePackagesResponse_httpStatus :: Lens' ListDatasourcePackagesResponse Int
- listGraphs_maxResults :: Lens' ListGraphs (Maybe Natural)
- listGraphs_nextToken :: Lens' ListGraphs (Maybe Text)
- listGraphsResponse_graphList :: Lens' ListGraphsResponse (Maybe [Graph])
- listGraphsResponse_nextToken :: Lens' ListGraphsResponse (Maybe Text)
- listGraphsResponse_httpStatus :: Lens' ListGraphsResponse Int
- listInvitations_maxResults :: Lens' ListInvitations (Maybe Natural)
- listInvitations_nextToken :: Lens' ListInvitations (Maybe Text)
- listInvitationsResponse_invitations :: Lens' ListInvitationsResponse (Maybe [MemberDetail])
- listInvitationsResponse_nextToken :: Lens' ListInvitationsResponse (Maybe Text)
- listInvitationsResponse_httpStatus :: Lens' ListInvitationsResponse Int
- listMembers_maxResults :: Lens' ListMembers (Maybe Natural)
- listMembers_nextToken :: Lens' ListMembers (Maybe Text)
- listMembers_graphArn :: Lens' ListMembers Text
- listMembersResponse_memberDetails :: Lens' ListMembersResponse (Maybe [MemberDetail])
- listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text)
- listMembersResponse_httpStatus :: Lens' ListMembersResponse Int
- listOrganizationAdminAccounts_maxResults :: Lens' ListOrganizationAdminAccounts (Maybe Natural)
- listOrganizationAdminAccounts_nextToken :: Lens' ListOrganizationAdminAccounts (Maybe Text)
- listOrganizationAdminAccountsResponse_administrators :: Lens' ListOrganizationAdminAccountsResponse (Maybe [Administrator])
- listOrganizationAdminAccountsResponse_nextToken :: Lens' ListOrganizationAdminAccountsResponse (Maybe Text)
- listOrganizationAdminAccountsResponse_httpStatus :: Lens' ListOrganizationAdminAccountsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- rejectInvitation_graphArn :: Lens' RejectInvitation Text
- startMonitoringMember_graphArn :: Lens' StartMonitoringMember Text
- startMonitoringMember_accountId :: Lens' StartMonitoringMember Text
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateDatasourcePackages_graphArn :: Lens' UpdateDatasourcePackages Text
- updateDatasourcePackages_datasourcePackages :: Lens' UpdateDatasourcePackages (NonEmpty DatasourcePackage)
- updateOrganizationConfiguration_autoEnable :: Lens' UpdateOrganizationConfiguration (Maybe Bool)
- updateOrganizationConfiguration_graphArn :: Lens' UpdateOrganizationConfiguration Text
- account_accountId :: Lens' Account Text
- account_emailAddress :: Lens' Account Text
- administrator_accountId :: Lens' Administrator (Maybe Text)
- administrator_delegationTime :: Lens' Administrator (Maybe UTCTime)
- administrator_graphArn :: Lens' Administrator (Maybe Text)
- datasourcePackageIngestDetail_datasourcePackageIngestState :: Lens' DatasourcePackageIngestDetail (Maybe DatasourcePackageIngestState)
- datasourcePackageIngestDetail_lastIngestStateChange :: Lens' DatasourcePackageIngestDetail (Maybe (HashMap DatasourcePackageIngestState TimestampForCollection))
- datasourcePackageUsageInfo_volumeUsageInBytes :: Lens' DatasourcePackageUsageInfo (Maybe Integer)
- datasourcePackageUsageInfo_volumeUsageUpdateTime :: Lens' DatasourcePackageUsageInfo (Maybe UTCTime)
- graph_arn :: Lens' Graph (Maybe Text)
- graph_createdTime :: Lens' Graph (Maybe UTCTime)
- 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)
- membershipDatasources_accountId :: Lens' MembershipDatasources (Maybe Text)
- membershipDatasources_datasourcePackageIngestHistory :: Lens' MembershipDatasources (Maybe (HashMap DatasourcePackage (HashMap DatasourcePackageIngestState TimestampForCollection)))
- membershipDatasources_graphArn :: Lens' MembershipDatasources (Maybe Text)
- timestampForCollection_timestamp :: Lens' TimestampForCollection (Maybe UTCTime)
- unprocessedAccount_accountId :: Lens' UnprocessedAccount (Maybe Text)
- unprocessedAccount_reason :: Lens' UnprocessedAccount (Maybe Text)
- unprocessedGraph_graphArn :: Lens' UnprocessedGraph (Maybe Text)
- unprocessedGraph_reason :: Lens' UnprocessedGraph (Maybe Text)
Operations
AcceptInvitation
acceptInvitation_graphArn :: Lens' AcceptInvitation Text Source #
The ARN of the behavior graph that the member account is accepting the invitation for.
The member account status in the behavior graph must be INVITED
.
BatchGetGraphMemberDatasources
batchGetGraphMemberDatasources_graphArn :: Lens' BatchGetGraphMemberDatasources Text Source #
The ARN of the behavior graph.
batchGetGraphMemberDatasources_accountIds :: Lens' BatchGetGraphMemberDatasources (NonEmpty Text) Source #
The list of Amazon Web Services accounts to get data source package information on.
batchGetGraphMemberDatasourcesResponse_memberDatasources :: Lens' BatchGetGraphMemberDatasourcesResponse (Maybe [MembershipDatasources]) Source #
Details on the status of data source packages for members of the behavior graph.
batchGetGraphMemberDatasourcesResponse_unprocessedAccounts :: Lens' BatchGetGraphMemberDatasourcesResponse (Maybe [UnprocessedAccount]) Source #
Accounts that data source package information could not be retrieved for.
batchGetGraphMemberDatasourcesResponse_httpStatus :: Lens' BatchGetGraphMemberDatasourcesResponse Int Source #
The response's http status code.
BatchGetMembershipDatasources
batchGetMembershipDatasources_graphArns :: Lens' BatchGetMembershipDatasources (NonEmpty Text) Source #
The ARN of the behavior graph.
batchGetMembershipDatasourcesResponse_membershipDatasources :: Lens' BatchGetMembershipDatasourcesResponse (Maybe [MembershipDatasources]) Source #
Details on the data source package history for an member of the behavior graph.
batchGetMembershipDatasourcesResponse_unprocessedGraphs :: Lens' BatchGetMembershipDatasourcesResponse (Maybe [UnprocessedGraph]) Source #
Graphs that data source package information could not be retrieved for.
batchGetMembershipDatasourcesResponse_httpStatus :: Lens' BatchGetMembershipDatasourcesResponse Int Source #
The response's http status code.
CreateGraph
createGraph_tags :: Lens' CreateGraph (Maybe (HashMap Text Text)) Source #
The tags to assign to the new behavior graph. You can add up to 50 tags. For each tag, you provide the tag key and the tag value. Each tag key can contain up to 128 characters. Each tag value can contain up to 256 characters.
createGraphResponse_graphArn :: Lens' CreateGraphResponse (Maybe Text) Source #
The ARN of the new behavior graph.
createGraphResponse_httpStatus :: Lens' CreateGraphResponse Int Source #
The response's http status code.
CreateMembers
createMembers_disableEmailNotification :: Lens' CreateMembers (Maybe Bool) Source #
if set to true
, then the invited accounts do not receive email
notifications. By default, this is set to false
, and the invited
accounts receive email notifications.
Organization accounts in the organization behavior graph do not receive email notifications.
createMembers_message :: Lens' CreateMembers (Maybe Text) Source #
Customized message text to include in the invitation email message to the invited member accounts.
createMembers_graphArn :: Lens' CreateMembers Text Source #
The ARN of the behavior graph.
createMembers_accounts :: Lens' CreateMembers (NonEmpty Account) Source #
The list of Amazon Web Services accounts to invite or to enable. You can invite or enable up to 50 accounts at a time. For each invited account, the account list contains the account identifier and the Amazon Web Services account root user email address. For organization accounts in the organization behavior graph, the email address is not required.
createMembersResponse_members :: Lens' CreateMembersResponse (Maybe [MemberDetail]) Source #
The set of member account invitation or enablement requests that Detective was able to process. This includes accounts that are being verified, that failed verification, and that passed verification and are being sent an invitation or are being enabled.
createMembersResponse_unprocessedAccounts :: Lens' CreateMembersResponse (Maybe [UnprocessedAccount]) Source #
The list of accounts for which Detective was unable to process the invitation or enablement request. For each account, the list provides the reason why the request could not be processed. The list includes accounts that are already member accounts in the behavior graph.
createMembersResponse_httpStatus :: Lens' CreateMembersResponse Int Source #
The response's http status code.
DeleteGraph
deleteGraph_graphArn :: Lens' DeleteGraph Text Source #
The ARN of the behavior graph to disable.
DeleteMembers
deleteMembers_graphArn :: Lens' DeleteMembers Text Source #
The ARN of the behavior graph to remove members from.
deleteMembers_accountIds :: Lens' DeleteMembers (NonEmpty Text) Source #
The list of Amazon Web Services account identifiers for the member accounts to remove from the behavior graph. You can remove up to 50 member accounts at a time.
deleteMembersResponse_accountIds :: Lens' DeleteMembersResponse (Maybe (NonEmpty Text)) Source #
The list of Amazon Web Services account identifiers for the member accounts that Detective successfully removed from the behavior graph.
deleteMembersResponse_unprocessedAccounts :: Lens' DeleteMembersResponse (Maybe [UnprocessedAccount]) Source #
The list of member accounts that Detective was not able to remove from the behavior graph. For each member account, provides the reason that the deletion could not be processed.
deleteMembersResponse_httpStatus :: Lens' DeleteMembersResponse Int Source #
The response's http status code.
DescribeOrganizationConfiguration
describeOrganizationConfiguration_graphArn :: Lens' DescribeOrganizationConfiguration Text Source #
The ARN of the organization behavior graph.
describeOrganizationConfigurationResponse_autoEnable :: Lens' DescribeOrganizationConfigurationResponse (Maybe Bool) Source #
Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
describeOrganizationConfigurationResponse_httpStatus :: Lens' DescribeOrganizationConfigurationResponse Int Source #
The response's http status code.
DisableOrganizationAdminAccount
DisassociateMembership
disassociateMembership_graphArn :: Lens' DisassociateMembership Text Source #
The ARN of the behavior graph to remove the member account from.
The member account's member status in the behavior graph must be
ENABLED
.
EnableOrganizationAdminAccount
enableOrganizationAdminAccount_accountId :: Lens' EnableOrganizationAdminAccount Text Source #
The Amazon Web Services account identifier of the account to designate as the Detective administrator account for the organization.
GetMembers
getMembers_graphArn :: Lens' GetMembers Text Source #
The ARN of the behavior graph for which to request the member details.
getMembers_accountIds :: Lens' GetMembers (NonEmpty Text) Source #
The list of Amazon Web Services account identifiers for the member account for which to return member details. You can request details for up to 50 member accounts at a time.
You cannot use GetMembers
to retrieve information about member
accounts that were removed from the behavior graph.
getMembersResponse_memberDetails :: Lens' GetMembersResponse (Maybe [MemberDetail]) Source #
The member account details that Detective is returning in response to the request.
getMembersResponse_unprocessedAccounts :: Lens' GetMembersResponse (Maybe [UnprocessedAccount]) Source #
The requested member accounts for which Detective was unable to return member details.
For each account, provides the reason why the request could not be processed.
getMembersResponse_httpStatus :: Lens' GetMembersResponse Int Source #
The response's http status code.
ListDatasourcePackages
listDatasourcePackages_maxResults :: Lens' ListDatasourcePackages (Maybe Natural) Source #
The maximum number of results to return.
listDatasourcePackages_nextToken :: Lens' ListDatasourcePackages (Maybe Text) Source #
For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.
listDatasourcePackages_graphArn :: Lens' ListDatasourcePackages Text Source #
The ARN of the behavior graph.
listDatasourcePackagesResponse_datasourcePackages :: Lens' ListDatasourcePackagesResponse (Maybe (HashMap DatasourcePackage DatasourcePackageIngestDetail)) Source #
Details on the data source packages active in the behavior graph.
listDatasourcePackagesResponse_nextToken :: Lens' ListDatasourcePackagesResponse (Maybe Text) Source #
For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.
listDatasourcePackagesResponse_httpStatus :: Lens' ListDatasourcePackagesResponse Int Source #
The response's http status code.
ListGraphs
listGraphs_maxResults :: Lens' ListGraphs (Maybe Natural) Source #
The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.
listGraphs_nextToken :: Lens' ListGraphs (Maybe Text) Source #
For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.
listGraphsResponse_graphList :: Lens' ListGraphsResponse (Maybe [Graph]) Source #
A list of behavior graphs that the account is an administrator account for.
listGraphsResponse_nextToken :: Lens' ListGraphsResponse (Maybe Text) Source #
If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.
listGraphsResponse_httpStatus :: Lens' ListGraphsResponse Int Source #
The response's http status code.
ListInvitations
listInvitations_maxResults :: Lens' ListInvitations (Maybe Natural) Source #
The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.
listInvitations_nextToken :: Lens' ListInvitations (Maybe Text) Source #
For requests to retrieve the next page of results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.
listInvitationsResponse_invitations :: Lens' ListInvitationsResponse (Maybe [MemberDetail]) Source #
The list of behavior graphs for which the member account has open or accepted invitations.
listInvitationsResponse_nextToken :: Lens' ListInvitationsResponse (Maybe Text) Source #
If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.
listInvitationsResponse_httpStatus :: Lens' ListInvitationsResponse Int Source #
The response's http status code.
ListMembers
listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #
The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.
listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #
For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.
listMembers_graphArn :: Lens' ListMembers Text Source #
The ARN of the behavior graph for which to retrieve the list of member accounts.
listMembersResponse_memberDetails :: Lens' ListMembersResponse (Maybe [MemberDetail]) Source #
The list of member accounts in the behavior graph.
For invited accounts, the results include member accounts that did not pass verification and member accounts that have not yet accepted the invitation to the behavior graph. The results do not include member accounts that were removed from the behavior graph.
For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.
listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #
If there are more member accounts remaining in the results, then use this pagination token to request the next page of member accounts.
listMembersResponse_httpStatus :: Lens' ListMembersResponse Int Source #
The response's http status code.
ListOrganizationAdminAccounts
listOrganizationAdminAccounts_maxResults :: Lens' ListOrganizationAdminAccounts (Maybe Natural) Source #
The maximum number of results to return.
listOrganizationAdminAccounts_nextToken :: Lens' ListOrganizationAdminAccounts (Maybe Text) Source #
For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.
listOrganizationAdminAccountsResponse_administrators :: Lens' ListOrganizationAdminAccountsResponse (Maybe [Administrator]) Source #
The list of Detective administrator accounts.
listOrganizationAdminAccountsResponse_nextToken :: Lens' ListOrganizationAdminAccountsResponse (Maybe Text) Source #
If there are more accounts remaining in the results, then this is the pagination token to use to request the next page of accounts.
listOrganizationAdminAccountsResponse_httpStatus :: Lens' ListOrganizationAdminAccountsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The ARN of the behavior graph for which to retrieve the tag values.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
The tag values that are assigned to the behavior graph. The request returns up to 50 tag values.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
RejectInvitation
rejectInvitation_graphArn :: Lens' RejectInvitation Text Source #
The ARN of the behavior graph to reject the invitation to.
The member account's current member status in the behavior graph must
be INVITED
.
StartMonitoringMember
startMonitoringMember_graphArn :: Lens' StartMonitoringMember Text Source #
The ARN of the behavior graph.
startMonitoringMember_accountId :: Lens' StartMonitoringMember Text Source #
The account ID of the member account to try to enable.
The account must be an invited member account with a status of
ACCEPTED_BUT_DISABLED
.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The ARN of the behavior graph to assign the tags to.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
The tags to assign to the behavior graph. You can add up to 50 tags. For each tag, you provide the tag key and the tag value. Each tag key can contain up to 128 characters. Each tag value can contain up to 256 characters.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The ARN of the behavior graph to remove the tags from.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
The tag keys of the tags to remove from the behavior graph. You can remove up to 50 tags at a time.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateDatasourcePackages
updateDatasourcePackages_graphArn :: Lens' UpdateDatasourcePackages Text Source #
The ARN of the behavior graph.
updateDatasourcePackages_datasourcePackages :: Lens' UpdateDatasourcePackages (NonEmpty DatasourcePackage) Source #
The data source package start for the behavior graph.
UpdateOrganizationConfiguration
updateOrganizationConfiguration_autoEnable :: Lens' UpdateOrganizationConfiguration (Maybe Bool) Source #
Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
updateOrganizationConfiguration_graphArn :: Lens' UpdateOrganizationConfiguration Text Source #
The ARN of the organization behavior graph.
Types
Account
account_accountId :: Lens' Account Text Source #
The account identifier of the Amazon Web Services account.
account_emailAddress :: Lens' Account Text Source #
The Amazon Web Services account root user email address for the Amazon Web Services account.
Administrator
administrator_accountId :: Lens' Administrator (Maybe Text) Source #
The Amazon Web Services account identifier of the Detective administrator account for the organization.
administrator_delegationTime :: Lens' Administrator (Maybe UTCTime) Source #
The date and time when the Detective administrator account was enabled.
The value is an ISO8601 formatted string. For example,
2021-08-18T16:35:56.284Z
.
administrator_graphArn :: Lens' Administrator (Maybe Text) Source #
The ARN of the organization behavior graph.
DatasourcePackageIngestDetail
datasourcePackageIngestDetail_datasourcePackageIngestState :: Lens' DatasourcePackageIngestDetail (Maybe DatasourcePackageIngestState) Source #
Details on which data source packages are ingested for a member account.
datasourcePackageIngestDetail_lastIngestStateChange :: Lens' DatasourcePackageIngestDetail (Maybe (HashMap DatasourcePackageIngestState TimestampForCollection)) Source #
The date a data source package was enabled for this account
DatasourcePackageUsageInfo
datasourcePackageUsageInfo_volumeUsageInBytes :: Lens' DatasourcePackageUsageInfo (Maybe Integer) Source #
Total volume of data in bytes per day ingested for a given data source package.
datasourcePackageUsageInfo_volumeUsageUpdateTime :: Lens' DatasourcePackageUsageInfo (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
.
Graph
graph_createdTime :: Lens' Graph (Maybe UTCTime) Source #
The date and time that the behavior graph was created. The value is an
ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z
.
MemberDetail
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
.
MembershipDatasources
membershipDatasources_accountId :: Lens' MembershipDatasources (Maybe Text) Source #
The account identifier of the Amazon Web Services account.
membershipDatasources_datasourcePackageIngestHistory :: Lens' MembershipDatasources (Maybe (HashMap DatasourcePackage (HashMap DatasourcePackageIngestState TimestampForCollection))) Source #
Details on when a data source package was added to a behavior graph.
membershipDatasources_graphArn :: Lens' MembershipDatasources (Maybe Text) Source #
The ARN of the organization behavior graph.
TimestampForCollection
timestampForCollection_timestamp :: Lens' TimestampForCollection (Maybe UTCTime) Source #
The data and time when data collection began for a source package. The
value is an ISO8601 formatted string. For example,
2021-08-18T16:35:56.284Z
.
UnprocessedAccount
unprocessedAccount_accountId :: Lens' UnprocessedAccount (Maybe Text) Source #
The Amazon Web Services account identifier of the member account that was not processed.
unprocessedAccount_reason :: Lens' UnprocessedAccount (Maybe Text) Source #
The reason that the member account request could not be processed.
UnprocessedGraph
unprocessedGraph_graphArn :: Lens' UnprocessedGraph (Maybe Text) Source #
The ARN of the organization behavior graph.
unprocessedGraph_reason :: Lens' UnprocessedGraph (Maybe Text) Source #
The reason data source package information could not be processed for a behavior graph.