| 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 |
Amazonka.Detective
Contents
- Service Configuration
- Errors
- Waiters
- 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
Description
Derived from API version 2018-10-26 of the AWS service descriptions, licensed under Apache 2.0.
Detective uses machine learning and purpose-built visualizations to help you to analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.
The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by an administrator account.
To add a member account to the behavior graph, the administrator account sends an invitation to the account. When the account accepts the invitation, it becomes a member account in the behavior graph.
Detective is also integrated with Organizations. The organization management account designates the Detective administrator account for the organization. That account becomes the administrator account for the organization behavior graph. The Detective administrator account is also the delegated administrator account for Detective in Organizations.
The Detective administrator account can enable any organization account as a member account in the organization behavior graph. The organization accounts do not receive invitations. The Detective administrator account can also invite other accounts to the organization behavior graph.
Every behavior graph is specific to a Region. You can only use the API to manage behavior graphs that belong to the Region that is associated with the currently selected endpoint.
The administrator account for a behavior graph can use the Detective API to do the following:
- Enable and disable Detective. Enabling Detective creates a new behavior graph.
- View the list of member accounts in a behavior graph.
- Add member accounts to a behavior graph.
- Remove member accounts from a behavior graph.
- Apply tags to a behavior graph.
The organization management account can use the Detective API to select the delegated administrator for Detective.
The Detective administrator account for an organization can use the Detective API to do the following:
- Perform all of the functions of an administrator account.
- Determine whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
An invited member account can use the Detective API to do the following:
- View the list of behavior graphs that they are invited to.
- Accept an invitation to contribute to a behavior graph.
- Decline an invitation to contribute to a behavior graph.
- Remove their account from a behavior graph.
All API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
We replaced the term "master account" with the term "administrator account." An administrator account is used to centrally manage multiple accounts. In the case of Detective, the administrator account manages the accounts in their behavior graph.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AcceptInvitation = AcceptInvitation' Text
- newAcceptInvitation :: Text -> AcceptInvitation
- data AcceptInvitationResponse = AcceptInvitationResponse' {
- newAcceptInvitationResponse :: AcceptInvitationResponse
- data BatchGetGraphMemberDatasources = BatchGetGraphMemberDatasources' Text (NonEmpty Text)
- newBatchGetGraphMemberDatasources :: Text -> NonEmpty Text -> BatchGetGraphMemberDatasources
- data BatchGetGraphMemberDatasourcesResponse = BatchGetGraphMemberDatasourcesResponse' (Maybe [MembershipDatasources]) (Maybe [UnprocessedAccount]) Int
- newBatchGetGraphMemberDatasourcesResponse :: Int -> BatchGetGraphMemberDatasourcesResponse
- data BatchGetMembershipDatasources = BatchGetMembershipDatasources' (NonEmpty Text)
- newBatchGetMembershipDatasources :: NonEmpty Text -> BatchGetMembershipDatasources
- data BatchGetMembershipDatasourcesResponse = BatchGetMembershipDatasourcesResponse' (Maybe [MembershipDatasources]) (Maybe [UnprocessedGraph]) Int
- newBatchGetMembershipDatasourcesResponse :: Int -> BatchGetMembershipDatasourcesResponse
- data CreateGraph = CreateGraph' (Maybe (HashMap Text Text))
- newCreateGraph :: CreateGraph
- data CreateGraphResponse = CreateGraphResponse' (Maybe Text) Int
- newCreateGraphResponse :: Int -> CreateGraphResponse
- data CreateMembers = CreateMembers' (Maybe Bool) (Maybe Text) Text (NonEmpty Account)
- newCreateMembers :: Text -> NonEmpty Account -> CreateMembers
- data CreateMembersResponse = CreateMembersResponse' (Maybe [MemberDetail]) (Maybe [UnprocessedAccount]) Int
- newCreateMembersResponse :: Int -> CreateMembersResponse
- data DeleteGraph = DeleteGraph' Text
- newDeleteGraph :: Text -> DeleteGraph
- data DeleteGraphResponse = DeleteGraphResponse' {
- newDeleteGraphResponse :: DeleteGraphResponse
- data DeleteMembers = DeleteMembers' Text (NonEmpty Text)
- newDeleteMembers :: Text -> NonEmpty Text -> DeleteMembers
- data DeleteMembersResponse = DeleteMembersResponse' (Maybe (NonEmpty Text)) (Maybe [UnprocessedAccount]) Int
- newDeleteMembersResponse :: Int -> DeleteMembersResponse
- data DescribeOrganizationConfiguration = DescribeOrganizationConfiguration' Text
- newDescribeOrganizationConfiguration :: Text -> DescribeOrganizationConfiguration
- data DescribeOrganizationConfigurationResponse = DescribeOrganizationConfigurationResponse' (Maybe Bool) Int
- newDescribeOrganizationConfigurationResponse :: Int -> DescribeOrganizationConfigurationResponse
- data DisableOrganizationAdminAccount = DisableOrganizationAdminAccount' {
- newDisableOrganizationAdminAccount :: DisableOrganizationAdminAccount
- data DisableOrganizationAdminAccountResponse = DisableOrganizationAdminAccountResponse' {
- newDisableOrganizationAdminAccountResponse :: DisableOrganizationAdminAccountResponse
- data DisassociateMembership = DisassociateMembership' Text
- newDisassociateMembership :: Text -> DisassociateMembership
- data DisassociateMembershipResponse = DisassociateMembershipResponse' {
- newDisassociateMembershipResponse :: DisassociateMembershipResponse
- data EnableOrganizationAdminAccount = EnableOrganizationAdminAccount' Text
- newEnableOrganizationAdminAccount :: Text -> EnableOrganizationAdminAccount
- data EnableOrganizationAdminAccountResponse = EnableOrganizationAdminAccountResponse' {
- newEnableOrganizationAdminAccountResponse :: EnableOrganizationAdminAccountResponse
- data GetMembers = GetMembers' Text (NonEmpty Text)
- newGetMembers :: Text -> NonEmpty Text -> GetMembers
- data GetMembersResponse = GetMembersResponse' (Maybe [MemberDetail]) (Maybe [UnprocessedAccount]) Int
- newGetMembersResponse :: Int -> GetMembersResponse
- data ListDatasourcePackages = ListDatasourcePackages' (Maybe Natural) (Maybe Text) Text
- newListDatasourcePackages :: Text -> ListDatasourcePackages
- data ListDatasourcePackagesResponse = ListDatasourcePackagesResponse' (Maybe (HashMap DatasourcePackage DatasourcePackageIngestDetail)) (Maybe Text) Int
- newListDatasourcePackagesResponse :: Int -> ListDatasourcePackagesResponse
- data ListGraphs = ListGraphs' (Maybe Natural) (Maybe Text)
- newListGraphs :: ListGraphs
- data ListGraphsResponse = ListGraphsResponse' (Maybe [Graph]) (Maybe Text) Int
- newListGraphsResponse :: Int -> ListGraphsResponse
- data ListInvitations = ListInvitations' (Maybe Natural) (Maybe Text)
- newListInvitations :: ListInvitations
- data ListInvitationsResponse = ListInvitationsResponse' (Maybe [MemberDetail]) (Maybe Text) Int
- newListInvitationsResponse :: Int -> ListInvitationsResponse
- data ListMembers = ListMembers' (Maybe Natural) (Maybe Text) Text
- newListMembers :: Text -> ListMembers
- data ListMembersResponse = ListMembersResponse' (Maybe [MemberDetail]) (Maybe Text) Int
- newListMembersResponse :: Int -> ListMembersResponse
- data ListOrganizationAdminAccounts = ListOrganizationAdminAccounts' (Maybe Natural) (Maybe Text)
- newListOrganizationAdminAccounts :: ListOrganizationAdminAccounts
- data ListOrganizationAdminAccountsResponse = ListOrganizationAdminAccountsResponse' (Maybe [Administrator]) (Maybe Text) Int
- newListOrganizationAdminAccountsResponse :: Int -> ListOrganizationAdminAccountsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data RejectInvitation = RejectInvitation' Text
- newRejectInvitation :: Text -> RejectInvitation
- data RejectInvitationResponse = RejectInvitationResponse' {
- newRejectInvitationResponse :: RejectInvitationResponse
- data StartMonitoringMember = StartMonitoringMember' Text Text
- newStartMonitoringMember :: Text -> Text -> StartMonitoringMember
- data StartMonitoringMemberResponse = StartMonitoringMemberResponse' {
- newStartMonitoringMemberResponse :: StartMonitoringMemberResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDatasourcePackages = UpdateDatasourcePackages' Text (NonEmpty DatasourcePackage)
- newUpdateDatasourcePackages :: Text -> NonEmpty DatasourcePackage -> UpdateDatasourcePackages
- data UpdateDatasourcePackagesResponse = UpdateDatasourcePackagesResponse' {
- newUpdateDatasourcePackagesResponse :: UpdateDatasourcePackagesResponse
- data UpdateOrganizationConfiguration = UpdateOrganizationConfiguration' (Maybe Bool) Text
- newUpdateOrganizationConfiguration :: Text -> UpdateOrganizationConfiguration
- data UpdateOrganizationConfigurationResponse = UpdateOrganizationConfigurationResponse' {
- newUpdateOrganizationConfigurationResponse :: UpdateOrganizationConfigurationResponse
- newtype DatasourcePackage where
- newtype DatasourcePackageIngestState where
- newtype InvitationType where
- InvitationType' { }
- pattern InvitationType_INVITATION :: InvitationType
- pattern InvitationType_ORGANIZATION :: InvitationType
- newtype MemberDisabledReason where
- newtype MemberStatus where
- MemberStatus' { }
- pattern MemberStatus_ACCEPTED_BUT_DISABLED :: MemberStatus
- pattern MemberStatus_ENABLED :: MemberStatus
- pattern MemberStatus_INVITED :: MemberStatus
- pattern MemberStatus_VERIFICATION_FAILED :: MemberStatus
- pattern MemberStatus_VERIFICATION_IN_PROGRESS :: MemberStatus
- data Account = Account' Text Text
- newAccount :: Text -> Text -> Account
- data Administrator = Administrator' (Maybe Text) (Maybe ISO8601) (Maybe Text)
- newAdministrator :: Administrator
- data DatasourcePackageIngestDetail = DatasourcePackageIngestDetail' (Maybe DatasourcePackageIngestState) (Maybe (HashMap DatasourcePackageIngestState TimestampForCollection))
- newDatasourcePackageIngestDetail :: DatasourcePackageIngestDetail
- data DatasourcePackageUsageInfo = DatasourcePackageUsageInfo' (Maybe Integer) (Maybe ISO8601)
- newDatasourcePackageUsageInfo :: DatasourcePackageUsageInfo
- data Graph = Graph' (Maybe Text) (Maybe ISO8601)
- newGraph :: Graph
- data MemberDetail = MemberDetail' (Maybe Text) (Maybe Text) (Maybe (HashMap DatasourcePackage DatasourcePackageIngestState)) (Maybe MemberDisabledReason) (Maybe Text) (Maybe Text) (Maybe InvitationType) (Maybe ISO8601) (Maybe Text) (Maybe Double) (Maybe ISO8601) (Maybe MemberStatus) (Maybe ISO8601) (Maybe (HashMap DatasourcePackage DatasourcePackageUsageInfo)) (Maybe Integer) (Maybe ISO8601)
- newMemberDetail :: MemberDetail
- data MembershipDatasources = MembershipDatasources' (Maybe Text) (Maybe (HashMap DatasourcePackage (HashMap DatasourcePackageIngestState TimestampForCollection))) (Maybe Text)
- newMembershipDatasources :: MembershipDatasources
- data TimestampForCollection = TimestampForCollection' (Maybe ISO8601)
- newTimestampForCollection :: TimestampForCollection
- data UnprocessedAccount = UnprocessedAccount' (Maybe Text) (Maybe Text)
- newUnprocessedAccount :: UnprocessedAccount
- data UnprocessedGraph = UnprocessedGraph' (Maybe Text) (Maybe Text)
- newUnprocessedGraph :: UnprocessedGraph
Service Configuration
defaultService :: Service Source #
API version 2018-10-26 of the Amazon Detective SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Detective.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The request issuer does not have permission to access this resource or perform this operation.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request attempted an invalid action.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request was valid but failed because of a problem with the service.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request refers to a nonexistent resource.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
This request cannot be completed for one of the following reasons.
- The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1200 member accounts.
- The request would cause the data rate for the behavior graph to exceed the maximum allowed.
- Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
The request cannot be completed because too many other requests are occurring at the same time.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The request parameters are invalid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AcceptInvitation
data AcceptInvitation Source #
See: newAcceptInvitation smart constructor.
Constructors
| AcceptInvitation' Text |
Instances
Arguments
| :: Text | |
| -> AcceptInvitation |
Create a value of AcceptInvitation 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:
AcceptInvitation, acceptInvitation_graphArn - 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.
data AcceptInvitationResponse Source #
See: newAcceptInvitationResponse smart constructor.
Constructors
| AcceptInvitationResponse' | |
Instances
newAcceptInvitationResponse :: AcceptInvitationResponse Source #
Create a value of AcceptInvitationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
BatchGetGraphMemberDatasources
data BatchGetGraphMemberDatasources Source #
See: newBatchGetGraphMemberDatasources smart constructor.
Constructors
| BatchGetGraphMemberDatasources' Text (NonEmpty Text) |
Instances
newBatchGetGraphMemberDatasources Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> BatchGetGraphMemberDatasources |
Create a value of BatchGetGraphMemberDatasources 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:
BatchGetGraphMemberDatasources, batchGetGraphMemberDatasources_graphArn - The ARN of the behavior graph.
$sel:accountIds:BatchGetGraphMemberDatasources', batchGetGraphMemberDatasources_accountIds - The list of Amazon Web Services accounts to get data source package
information on.
data BatchGetGraphMemberDatasourcesResponse Source #
See: newBatchGetGraphMemberDatasourcesResponse smart constructor.
Constructors
| BatchGetGraphMemberDatasourcesResponse' (Maybe [MembershipDatasources]) (Maybe [UnprocessedAccount]) Int |
Instances
newBatchGetGraphMemberDatasourcesResponse Source #
Arguments
| :: Int | |
| -> BatchGetGraphMemberDatasourcesResponse |
Create a value of BatchGetGraphMemberDatasourcesResponse 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:memberDatasources:BatchGetGraphMemberDatasourcesResponse', batchGetGraphMemberDatasourcesResponse_memberDatasources - Details on the status of data source packages for members of the
behavior graph.
$sel:unprocessedAccounts:BatchGetGraphMemberDatasourcesResponse', batchGetGraphMemberDatasourcesResponse_unprocessedAccounts - Accounts that data source package information could not be retrieved
for.
$sel:httpStatus:BatchGetGraphMemberDatasourcesResponse', batchGetGraphMemberDatasourcesResponse_httpStatus - The response's http status code.
BatchGetMembershipDatasources
data BatchGetMembershipDatasources Source #
See: newBatchGetMembershipDatasources smart constructor.
Constructors
| BatchGetMembershipDatasources' (NonEmpty Text) |
Instances
newBatchGetMembershipDatasources Source #
Arguments
| :: NonEmpty Text | |
| -> BatchGetMembershipDatasources |
Create a value of BatchGetMembershipDatasources 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:graphArns:BatchGetMembershipDatasources', batchGetMembershipDatasources_graphArns - The ARN of the behavior graph.
data BatchGetMembershipDatasourcesResponse Source #
See: newBatchGetMembershipDatasourcesResponse smart constructor.
Constructors
| BatchGetMembershipDatasourcesResponse' (Maybe [MembershipDatasources]) (Maybe [UnprocessedGraph]) Int |
Instances
newBatchGetMembershipDatasourcesResponse Source #
Arguments
| :: Int | |
| -> BatchGetMembershipDatasourcesResponse |
Create a value of BatchGetMembershipDatasourcesResponse 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:membershipDatasources:BatchGetMembershipDatasourcesResponse', batchGetMembershipDatasourcesResponse_membershipDatasources - Details on the data source package history for an member of the behavior
graph.
$sel:unprocessedGraphs:BatchGetMembershipDatasourcesResponse', batchGetMembershipDatasourcesResponse_unprocessedGraphs - Graphs that data source package information could not be retrieved for.
$sel:httpStatus:BatchGetMembershipDatasourcesResponse', batchGetMembershipDatasourcesResponse_httpStatus - The response's http status code.
CreateGraph
data CreateGraph Source #
See: newCreateGraph smart constructor.
Constructors
| CreateGraph' (Maybe (HashMap Text Text)) |
Instances
newCreateGraph :: CreateGraph Source #
Create a value of CreateGraph 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:tags:CreateGraph', createGraph_tags - 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.
data CreateGraphResponse Source #
See: newCreateGraphResponse smart constructor.
Constructors
| CreateGraphResponse' (Maybe Text) Int |
Instances
newCreateGraphResponse Source #
Arguments
| :: Int | |
| -> CreateGraphResponse |
Create a value of CreateGraphResponse 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:
CreateGraphResponse, createGraphResponse_graphArn - The ARN of the new behavior graph.
$sel:httpStatus:CreateGraphResponse', createGraphResponse_httpStatus - The response's http status code.
CreateMembers
data CreateMembers Source #
See: newCreateMembers smart constructor.
Instances
Arguments
| :: Text | |
| -> NonEmpty Account | |
| -> CreateMembers |
Create a value of CreateMembers 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:disableEmailNotification:CreateMembers', createMembers_disableEmailNotification - 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.
$sel:message:CreateMembers', createMembers_message - Customized message text to include in the invitation email message to
the invited member accounts.
CreateMembers, createMembers_graphArn - The ARN of the behavior graph.
$sel:accounts:CreateMembers', createMembers_accounts - 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.
data CreateMembersResponse Source #
See: newCreateMembersResponse smart constructor.
Constructors
| CreateMembersResponse' (Maybe [MemberDetail]) (Maybe [UnprocessedAccount]) Int |
Instances
newCreateMembersResponse Source #
Create a value of CreateMembersResponse 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:members:CreateMembersResponse', createMembersResponse_members - 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.
$sel:unprocessedAccounts:CreateMembersResponse', createMembersResponse_unprocessedAccounts - 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.
$sel:httpStatus:CreateMembersResponse', createMembersResponse_httpStatus - The response's http status code.
DeleteGraph
data DeleteGraph Source #
See: newDeleteGraph smart constructor.
Constructors
| DeleteGraph' Text |
Instances
Arguments
| :: Text | |
| -> DeleteGraph |
Create a value of DeleteGraph 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:
DeleteGraph, deleteGraph_graphArn - The ARN of the behavior graph to disable.
data DeleteGraphResponse Source #
See: newDeleteGraphResponse smart constructor.
Constructors
| DeleteGraphResponse' | |
Instances
newDeleteGraphResponse :: DeleteGraphResponse Source #
Create a value of DeleteGraphResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMembers
data DeleteMembers Source #
See: newDeleteMembers smart constructor.
Constructors
| DeleteMembers' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> DeleteMembers |
Create a value of DeleteMembers 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:
DeleteMembers, deleteMembers_graphArn - The ARN of the behavior graph to remove members from.
DeleteMembers, deleteMembers_accountIds - 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.
data DeleteMembersResponse Source #
See: newDeleteMembersResponse smart constructor.
Constructors
| DeleteMembersResponse' (Maybe (NonEmpty Text)) (Maybe [UnprocessedAccount]) Int |
Instances
newDeleteMembersResponse Source #
Create a value of DeleteMembersResponse 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:
DeleteMembers, deleteMembersResponse_accountIds - The list of Amazon Web Services account identifiers for the member
accounts that Detective successfully removed from the behavior graph.
$sel:unprocessedAccounts:DeleteMembersResponse', deleteMembersResponse_unprocessedAccounts - 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.
$sel:httpStatus:DeleteMembersResponse', deleteMembersResponse_httpStatus - The response's http status code.
DescribeOrganizationConfiguration
data DescribeOrganizationConfiguration Source #
See: newDescribeOrganizationConfiguration smart constructor.
Constructors
| DescribeOrganizationConfiguration' Text |
Instances
newDescribeOrganizationConfiguration Source #
Create a value of DescribeOrganizationConfiguration 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:
DescribeOrganizationConfiguration, describeOrganizationConfiguration_graphArn - The ARN of the organization behavior graph.
data DescribeOrganizationConfigurationResponse Source #
See: newDescribeOrganizationConfigurationResponse smart constructor.
Constructors
| DescribeOrganizationConfigurationResponse' (Maybe Bool) Int |
Instances
newDescribeOrganizationConfigurationResponse Source #
Arguments
| :: Int | |
| -> DescribeOrganizationConfigurationResponse |
Create a value of DescribeOrganizationConfigurationResponse 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:autoEnable:DescribeOrganizationConfigurationResponse', describeOrganizationConfigurationResponse_autoEnable - Indicates whether to automatically enable new organization accounts as
member accounts in the organization behavior graph.
$sel:httpStatus:DescribeOrganizationConfigurationResponse', describeOrganizationConfigurationResponse_httpStatus - The response's http status code.
DisableOrganizationAdminAccount
data DisableOrganizationAdminAccount Source #
See: newDisableOrganizationAdminAccount smart constructor.
Constructors
| DisableOrganizationAdminAccount' | |
Instances
newDisableOrganizationAdminAccount :: DisableOrganizationAdminAccount Source #
Create a value of DisableOrganizationAdminAccount with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DisableOrganizationAdminAccountResponse Source #
See: newDisableOrganizationAdminAccountResponse smart constructor.
Constructors
| DisableOrganizationAdminAccountResponse' | |
Instances
| Generic DisableOrganizationAdminAccountResponse Source # | |
Defined in Amazonka.Detective.DisableOrganizationAdminAccount Associated Types type Rep DisableOrganizationAdminAccountResponse :: Type -> Type # | |
| Read DisableOrganizationAdminAccountResponse Source # | |
| Show DisableOrganizationAdminAccountResponse Source # | |
| NFData DisableOrganizationAdminAccountResponse Source # | |
Defined in Amazonka.Detective.DisableOrganizationAdminAccount Methods rnf :: DisableOrganizationAdminAccountResponse -> () # | |
| Eq DisableOrganizationAdminAccountResponse Source # | |
| type Rep DisableOrganizationAdminAccountResponse Source # | |
Defined in Amazonka.Detective.DisableOrganizationAdminAccount type Rep DisableOrganizationAdminAccountResponse = D1 ('MetaData "DisableOrganizationAdminAccountResponse" "Amazonka.Detective.DisableOrganizationAdminAccount" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" 'False) (C1 ('MetaCons "DisableOrganizationAdminAccountResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) | |
newDisableOrganizationAdminAccountResponse :: DisableOrganizationAdminAccountResponse Source #
Create a value of DisableOrganizationAdminAccountResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisassociateMembership
data DisassociateMembership Source #
See: newDisassociateMembership smart constructor.
Constructors
| DisassociateMembership' Text |
Instances
newDisassociateMembership Source #
Arguments
| :: Text | |
| -> DisassociateMembership |
Create a value of DisassociateMembership 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:
DisassociateMembership, disassociateMembership_graphArn - 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.
data DisassociateMembershipResponse Source #
See: newDisassociateMembershipResponse smart constructor.
Constructors
| DisassociateMembershipResponse' | |
Instances
| Generic DisassociateMembershipResponse Source # | |
Defined in Amazonka.Detective.DisassociateMembership Associated Types type Rep DisassociateMembershipResponse :: Type -> Type # | |
| Read DisassociateMembershipResponse Source # | |
| Show DisassociateMembershipResponse Source # | |
Defined in Amazonka.Detective.DisassociateMembership Methods showsPrec :: Int -> DisassociateMembershipResponse -> ShowS # show :: DisassociateMembershipResponse -> String # showList :: [DisassociateMembershipResponse] -> ShowS # | |
| NFData DisassociateMembershipResponse Source # | |
Defined in Amazonka.Detective.DisassociateMembership Methods rnf :: DisassociateMembershipResponse -> () # | |
| Eq DisassociateMembershipResponse Source # | |
Defined in Amazonka.Detective.DisassociateMembership | |
| type Rep DisassociateMembershipResponse Source # | |
Defined in Amazonka.Detective.DisassociateMembership | |
newDisassociateMembershipResponse :: DisassociateMembershipResponse Source #
Create a value of DisassociateMembershipResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
EnableOrganizationAdminAccount
data EnableOrganizationAdminAccount Source #
See: newEnableOrganizationAdminAccount smart constructor.
Constructors
| EnableOrganizationAdminAccount' Text |
Instances
newEnableOrganizationAdminAccount Source #
Create a value of EnableOrganizationAdminAccount 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:
EnableOrganizationAdminAccount, enableOrganizationAdminAccount_accountId - The Amazon Web Services account identifier of the account to designate
as the Detective administrator account for the organization.
data EnableOrganizationAdminAccountResponse Source #
See: newEnableOrganizationAdminAccountResponse smart constructor.
Constructors
| EnableOrganizationAdminAccountResponse' | |
Instances
newEnableOrganizationAdminAccountResponse :: EnableOrganizationAdminAccountResponse Source #
Create a value of EnableOrganizationAdminAccountResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetMembers
data GetMembers Source #
See: newGetMembers smart constructor.
Constructors
| GetMembers' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> GetMembers |
Create a value of GetMembers 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:
GetMembers, getMembers_graphArn - The ARN of the behavior graph for which to request the member details.
$sel:accountIds:GetMembers', getMembers_accountIds - 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.
data GetMembersResponse Source #
See: newGetMembersResponse smart constructor.
Constructors
| GetMembersResponse' (Maybe [MemberDetail]) (Maybe [UnprocessedAccount]) Int |
Instances
newGetMembersResponse Source #
Arguments
| :: Int | |
| -> GetMembersResponse |
Create a value of GetMembersResponse 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:memberDetails:GetMembersResponse', getMembersResponse_memberDetails - The member account details that Detective is returning in response to
the request.
$sel:unprocessedAccounts:GetMembersResponse', getMembersResponse_unprocessedAccounts - 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.
$sel:httpStatus:GetMembersResponse', getMembersResponse_httpStatus - The response's http status code.
ListDatasourcePackages
data ListDatasourcePackages Source #
See: newListDatasourcePackages smart constructor.
Instances
newListDatasourcePackages Source #
Arguments
| :: Text | |
| -> ListDatasourcePackages |
Create a value of ListDatasourcePackages 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:maxResults:ListDatasourcePackages', listDatasourcePackages_maxResults - The maximum number of results to return.
ListDatasourcePackages, listDatasourcePackages_nextToken - 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, listDatasourcePackages_graphArn - The ARN of the behavior graph.
data ListDatasourcePackagesResponse Source #
See: newListDatasourcePackagesResponse smart constructor.
Constructors
| ListDatasourcePackagesResponse' (Maybe (HashMap DatasourcePackage DatasourcePackageIngestDetail)) (Maybe Text) Int |
Instances
newListDatasourcePackagesResponse Source #
Create a value of ListDatasourcePackagesResponse 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:datasourcePackages:ListDatasourcePackagesResponse', listDatasourcePackagesResponse_datasourcePackages - Details on the data source packages active in the behavior graph.
ListDatasourcePackages, listDatasourcePackagesResponse_nextToken - 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.
$sel:httpStatus:ListDatasourcePackagesResponse', listDatasourcePackagesResponse_httpStatus - The response's http status code.
ListGraphs
data ListGraphs Source #
See: newListGraphs smart constructor.
Constructors
| ListGraphs' (Maybe Natural) (Maybe Text) |
Instances
newListGraphs :: ListGraphs Source #
Create a value of ListGraphs 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:maxResults:ListGraphs', listGraphs_maxResults - 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, listGraphs_nextToken - 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.
data ListGraphsResponse Source #
See: newListGraphsResponse smart constructor.
Instances
newListGraphsResponse Source #
Arguments
| :: Int | |
| -> ListGraphsResponse |
Create a value of ListGraphsResponse 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:graphList:ListGraphsResponse', listGraphsResponse_graphList - A list of behavior graphs that the account is an administrator account
for.
ListGraphs, listGraphsResponse_nextToken - 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.
$sel:httpStatus:ListGraphsResponse', listGraphsResponse_httpStatus - The response's http status code.
ListInvitations
data ListInvitations Source #
See: newListInvitations smart constructor.
Constructors
| ListInvitations' (Maybe Natural) (Maybe Text) |
Instances
newListInvitations :: ListInvitations Source #
Create a value of ListInvitations 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:maxResults:ListInvitations', listInvitations_maxResults - 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, listInvitations_nextToken - 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.
data ListInvitationsResponse Source #
See: newListInvitationsResponse smart constructor.
Constructors
| ListInvitationsResponse' (Maybe [MemberDetail]) (Maybe Text) Int |
Instances
newListInvitationsResponse Source #
Create a value of ListInvitationsResponse 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:invitations:ListInvitationsResponse', listInvitationsResponse_invitations - The list of behavior graphs for which the member account has open or
accepted invitations.
ListInvitations, listInvitationsResponse_nextToken - 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.
$sel:httpStatus:ListInvitationsResponse', listInvitationsResponse_httpStatus - The response's http status code.
ListMembers
data ListMembers Source #
See: newListMembers smart constructor.
Instances
Arguments
| :: Text | |
| -> ListMembers |
Create a value of ListMembers 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:maxResults:ListMembers', listMembers_maxResults - 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, listMembers_nextToken - 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, listMembers_graphArn - The ARN of the behavior graph for which to retrieve the list of member
accounts.
data ListMembersResponse Source #
See: newListMembersResponse smart constructor.
Constructors
| ListMembersResponse' (Maybe [MemberDetail]) (Maybe Text) Int |
Instances
newListMembersResponse Source #
Arguments
| :: Int | |
| -> ListMembersResponse |
Create a value of ListMembersResponse 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:memberDetails:ListMembersResponse', listMembersResponse_memberDetails - 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.
ListMembers, listMembersResponse_nextToken - If there are more member accounts remaining in the results, then use
this pagination token to request the next page of member accounts.
$sel:httpStatus:ListMembersResponse', listMembersResponse_httpStatus - The response's http status code.
ListOrganizationAdminAccounts
data ListOrganizationAdminAccounts Source #
See: newListOrganizationAdminAccounts smart constructor.
Constructors
| ListOrganizationAdminAccounts' (Maybe Natural) (Maybe Text) |
Instances
newListOrganizationAdminAccounts :: ListOrganizationAdminAccounts Source #
Create a value of ListOrganizationAdminAccounts 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:maxResults:ListOrganizationAdminAccounts', listOrganizationAdminAccounts_maxResults - The maximum number of results to return.
ListOrganizationAdminAccounts, listOrganizationAdminAccounts_nextToken - 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.
data ListOrganizationAdminAccountsResponse Source #
See: newListOrganizationAdminAccountsResponse smart constructor.
Constructors
| ListOrganizationAdminAccountsResponse' (Maybe [Administrator]) (Maybe Text) Int |
Instances
newListOrganizationAdminAccountsResponse Source #
Arguments
| :: Int | |
| -> ListOrganizationAdminAccountsResponse |
Create a value of ListOrganizationAdminAccountsResponse 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:administrators:ListOrganizationAdminAccountsResponse', listOrganizationAdminAccountsResponse_administrators - The list of Detective administrator accounts.
ListOrganizationAdminAccounts, listOrganizationAdminAccountsResponse_nextToken - If there are more accounts remaining in the results, then this is the
pagination token to use to request the next page of accounts.
$sel:httpStatus:ListOrganizationAdminAccountsResponse', listOrganizationAdminAccountsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the behavior graph for which to retrieve the tag values.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tag values that are assigned to the behavior graph. The request
returns up to 50 tag values.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
RejectInvitation
data RejectInvitation Source #
See: newRejectInvitation smart constructor.
Constructors
| RejectInvitation' Text |
Instances
Arguments
| :: Text | |
| -> RejectInvitation |
Create a value of RejectInvitation 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:
RejectInvitation, rejectInvitation_graphArn - 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.
data RejectInvitationResponse Source #
See: newRejectInvitationResponse smart constructor.
Constructors
| RejectInvitationResponse' | |
Instances
newRejectInvitationResponse :: RejectInvitationResponse Source #
Create a value of RejectInvitationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartMonitoringMember
data StartMonitoringMember Source #
See: newStartMonitoringMember smart constructor.
Constructors
| StartMonitoringMember' Text Text |
Instances
newStartMonitoringMember Source #
Arguments
| :: Text | |
| -> Text | |
| -> StartMonitoringMember |
Create a value of StartMonitoringMember 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:
StartMonitoringMember, startMonitoringMember_graphArn - The ARN of the behavior graph.
StartMonitoringMember, startMonitoringMember_accountId - 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.
data StartMonitoringMemberResponse Source #
See: newStartMonitoringMemberResponse smart constructor.
Constructors
| StartMonitoringMemberResponse' | |
Instances
| Generic StartMonitoringMemberResponse Source # | |
Defined in Amazonka.Detective.StartMonitoringMember Associated Types type Rep StartMonitoringMemberResponse :: Type -> Type # | |
| Read StartMonitoringMemberResponse Source # | |
| Show StartMonitoringMemberResponse Source # | |
Defined in Amazonka.Detective.StartMonitoringMember Methods showsPrec :: Int -> StartMonitoringMemberResponse -> ShowS # show :: StartMonitoringMemberResponse -> String # showList :: [StartMonitoringMemberResponse] -> ShowS # | |
| NFData StartMonitoringMemberResponse Source # | |
Defined in Amazonka.Detective.StartMonitoringMember Methods rnf :: StartMonitoringMemberResponse -> () # | |
| Eq StartMonitoringMemberResponse Source # | |
Defined in Amazonka.Detective.StartMonitoringMember | |
| type Rep StartMonitoringMemberResponse Source # | |
Defined in Amazonka.Detective.StartMonitoringMember | |
newStartMonitoringMemberResponse :: StartMonitoringMemberResponse Source #
Create a value of StartMonitoringMemberResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of the behavior graph to assign the tags to.
$sel:tags:TagResource', tagResource_tags - 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.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the behavior graph to remove the tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag keys of the tags to remove from the behavior graph. You can
remove up to 50 tags at a time.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateDatasourcePackages
data UpdateDatasourcePackages Source #
See: newUpdateDatasourcePackages smart constructor.
Constructors
| UpdateDatasourcePackages' Text (NonEmpty DatasourcePackage) |
Instances
newUpdateDatasourcePackages Source #
Arguments
| :: Text | |
| -> NonEmpty DatasourcePackage | |
| -> UpdateDatasourcePackages |
Create a value of UpdateDatasourcePackages 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:
UpdateDatasourcePackages, updateDatasourcePackages_graphArn - The ARN of the behavior graph.
$sel:datasourcePackages:UpdateDatasourcePackages', updateDatasourcePackages_datasourcePackages - The data source package start for the behavior graph.
data UpdateDatasourcePackagesResponse Source #
See: newUpdateDatasourcePackagesResponse smart constructor.
Constructors
| UpdateDatasourcePackagesResponse' | |
Instances
| Generic UpdateDatasourcePackagesResponse Source # | |
Defined in Amazonka.Detective.UpdateDatasourcePackages Associated Types type Rep UpdateDatasourcePackagesResponse :: Type -> Type # | |
| Read UpdateDatasourcePackagesResponse Source # | |
| Show UpdateDatasourcePackagesResponse Source # | |
Defined in Amazonka.Detective.UpdateDatasourcePackages Methods showsPrec :: Int -> UpdateDatasourcePackagesResponse -> ShowS # | |
| NFData UpdateDatasourcePackagesResponse Source # | |
Defined in Amazonka.Detective.UpdateDatasourcePackages Methods rnf :: UpdateDatasourcePackagesResponse -> () # | |
| Eq UpdateDatasourcePackagesResponse Source # | |
| type Rep UpdateDatasourcePackagesResponse Source # | |
Defined in Amazonka.Detective.UpdateDatasourcePackages | |
newUpdateDatasourcePackagesResponse :: UpdateDatasourcePackagesResponse Source #
Create a value of UpdateDatasourcePackagesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateOrganizationConfiguration
data UpdateOrganizationConfiguration Source #
See: newUpdateOrganizationConfiguration smart constructor.
Constructors
| UpdateOrganizationConfiguration' (Maybe Bool) Text |
Instances
newUpdateOrganizationConfiguration Source #
Create a value of UpdateOrganizationConfiguration 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:autoEnable:UpdateOrganizationConfiguration', updateOrganizationConfiguration_autoEnable - Indicates whether to automatically enable new organization accounts as
member accounts in the organization behavior graph.
UpdateOrganizationConfiguration, updateOrganizationConfiguration_graphArn - The ARN of the organization behavior graph.
data UpdateOrganizationConfigurationResponse Source #
See: newUpdateOrganizationConfigurationResponse smart constructor.
Constructors
| UpdateOrganizationConfigurationResponse' | |
Instances
| Generic UpdateOrganizationConfigurationResponse Source # | |
Defined in Amazonka.Detective.UpdateOrganizationConfiguration Associated Types type Rep UpdateOrganizationConfigurationResponse :: Type -> Type # | |
| Read UpdateOrganizationConfigurationResponse Source # | |
| Show UpdateOrganizationConfigurationResponse Source # | |
| NFData UpdateOrganizationConfigurationResponse Source # | |
Defined in Amazonka.Detective.UpdateOrganizationConfiguration Methods rnf :: UpdateOrganizationConfigurationResponse -> () # | |
| Eq UpdateOrganizationConfigurationResponse Source # | |
| type Rep UpdateOrganizationConfigurationResponse Source # | |
Defined in Amazonka.Detective.UpdateOrganizationConfiguration type Rep UpdateOrganizationConfigurationResponse = D1 ('MetaData "UpdateOrganizationConfigurationResponse" "Amazonka.Detective.UpdateOrganizationConfiguration" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" 'False) (C1 ('MetaCons "UpdateOrganizationConfigurationResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) | |
newUpdateOrganizationConfigurationResponse :: UpdateOrganizationConfigurationResponse Source #
Create a value of UpdateOrganizationConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
DatasourcePackage
newtype DatasourcePackage Source #
Constructors
| DatasourcePackage' | |
Fields | |
Bundled Patterns
| pattern DatasourcePackage_DETECTIVE_CORE :: DatasourcePackage | |
| pattern DatasourcePackage_EKS_AUDIT :: DatasourcePackage |
Instances
DatasourcePackageIngestState
newtype DatasourcePackageIngestState Source #
Constructors
| DatasourcePackageIngestState' | |
Fields | |
Bundled Patterns
Instances
InvitationType
newtype InvitationType Source #
Constructors
| InvitationType' | |
Fields | |
Bundled Patterns
| pattern InvitationType_INVITATION :: InvitationType | |
| pattern InvitationType_ORGANIZATION :: InvitationType |
Instances
MemberDisabledReason
newtype MemberDisabledReason Source #
Constructors
| MemberDisabledReason' | |
Fields | |
Bundled Patterns
| pattern MemberDisabledReason_VOLUME_TOO_HIGH :: MemberDisabledReason | |
| pattern MemberDisabledReason_VOLUME_UNKNOWN :: MemberDisabledReason |
Instances
MemberStatus
newtype MemberStatus Source #
Constructors
| MemberStatus' | |
Fields | |
Bundled Patterns
| pattern MemberStatus_ACCEPTED_BUT_DISABLED :: MemberStatus | |
| pattern MemberStatus_ENABLED :: MemberStatus | |
| pattern MemberStatus_INVITED :: MemberStatus | |
| pattern MemberStatus_VERIFICATION_FAILED :: MemberStatus | |
| pattern MemberStatus_VERIFICATION_IN_PROGRESS :: MemberStatus |
Instances
Account
An Amazon Web Services account that is the administrator account of or a member of a behavior graph.
See: newAccount smart constructor.
Instances
| ToJSON Account Source # | |
Defined in Amazonka.Detective.Types.Account | |
| Generic Account Source # | |
| Read Account Source # | |
| Show Account Source # | |
| NFData Account Source # | |
Defined in Amazonka.Detective.Types.Account | |
| Eq Account Source # | |
| Hashable Account Source # | |
Defined in Amazonka.Detective.Types.Account | |
| type Rep Account Source # | |
Defined in Amazonka.Detective.Types.Account type Rep Account = D1 ('MetaData "Account" "Amazonka.Detective.Types.Account" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" 'False) (C1 ('MetaCons "Account'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Account 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:Account', account_accountId - The account identifier of the Amazon Web Services account.
$sel:emailAddress:Account', account_emailAddress - The Amazon Web Services account root user email address for the Amazon
Web Services account.
Administrator
data Administrator Source #
Information about the Detective administrator account for an organization.
See: newAdministrator smart constructor.
Instances
newAdministrator :: Administrator Source #
Create a value of Administrator 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:Administrator', administrator_accountId - The Amazon Web Services account identifier of the Detective
administrator account for the organization.
$sel:delegationTime:Administrator', administrator_delegationTime - 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.
$sel:graphArn:Administrator', administrator_graphArn - The ARN of the organization behavior graph.
DatasourcePackageIngestDetail
data DatasourcePackageIngestDetail Source #
Details about the data source packages ingested by your behavior graph.
See: newDatasourcePackageIngestDetail smart constructor.
Constructors
| DatasourcePackageIngestDetail' (Maybe DatasourcePackageIngestState) (Maybe (HashMap DatasourcePackageIngestState TimestampForCollection)) |
Instances
newDatasourcePackageIngestDetail :: DatasourcePackageIngestDetail Source #
Create a value of DatasourcePackageIngestDetail 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:datasourcePackageIngestState:DatasourcePackageIngestDetail', datasourcePackageIngestDetail_datasourcePackageIngestState - Details on which data source packages are ingested for a member account.
$sel:lastIngestStateChange:DatasourcePackageIngestDetail', datasourcePackageIngestDetail_lastIngestStateChange - The date a data source package was enabled for this account
DatasourcePackageUsageInfo
data DatasourcePackageUsageInfo Source #
Information on the usage of a data source package in the behavior graph.
See: newDatasourcePackageUsageInfo smart constructor.
Constructors
| DatasourcePackageUsageInfo' (Maybe Integer) (Maybe ISO8601) |
Instances
newDatasourcePackageUsageInfo :: DatasourcePackageUsageInfo Source #
Create a value of DatasourcePackageUsageInfo 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:volumeUsageInBytes:DatasourcePackageUsageInfo', datasourcePackageUsageInfo_volumeUsageInBytes - Total volume of data in bytes per day ingested for a given data source
package.
$sel:volumeUsageUpdateTime:DatasourcePackageUsageInfo', datasourcePackageUsageInfo_volumeUsageUpdateTime - 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
A behavior graph in Detective.
See: newGraph smart constructor.
Instances
| FromJSON Graph Source # | |
| Generic Graph Source # | |
| Read Graph Source # | |
| Show Graph Source # | |
| NFData Graph Source # | |
Defined in Amazonka.Detective.Types.Graph | |
| Eq Graph Source # | |
| Hashable Graph Source # | |
Defined in Amazonka.Detective.Types.Graph | |
| type Rep Graph Source # | |
Defined in Amazonka.Detective.Types.Graph type Rep Graph = D1 ('MetaData "Graph" "Amazonka.Detective.Types.Graph" "amazonka-detective-2.0-7OiRDHTBp2P6vp0DOMdDcL" 'False) (C1 ('MetaCons "Graph'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) | |
Create a value of Graph 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:arn:Graph', graph_arn - The ARN of the behavior graph.
$sel:createdTime:Graph', graph_createdTime - 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
data MemberDetail Source #
Details about a member account in a behavior graph.
See: newMemberDetail smart constructor.
Constructors
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.DisabledReasonprovides 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.
MembershipDatasources
data MembershipDatasources Source #
Details on data source packages for members of the behavior graph.
See: newMembershipDatasources smart constructor.
Constructors
| MembershipDatasources' (Maybe Text) (Maybe (HashMap DatasourcePackage (HashMap DatasourcePackageIngestState TimestampForCollection))) (Maybe Text) |
Instances
newMembershipDatasources :: MembershipDatasources Source #
Create a value of MembershipDatasources 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:MembershipDatasources', membershipDatasources_accountId - The account identifier of the Amazon Web Services account.
$sel:datasourcePackageIngestHistory:MembershipDatasources', membershipDatasources_datasourcePackageIngestHistory - Details on when a data source package was added to a behavior graph.
$sel:graphArn:MembershipDatasources', membershipDatasources_graphArn - The ARN of the organization behavior graph.
TimestampForCollection
data TimestampForCollection Source #
Details on when data collection began for a source package.
See: newTimestampForCollection smart constructor.
Constructors
| TimestampForCollection' (Maybe ISO8601) |
Instances
newTimestampForCollection :: TimestampForCollection Source #
Create a value of TimestampForCollection 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:timestamp:TimestampForCollection', timestampForCollection_timestamp - 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
data UnprocessedAccount Source #
A member account that was included in a request but for which the request could not be processed.
See: newUnprocessedAccount smart constructor.
Constructors
| UnprocessedAccount' (Maybe Text) (Maybe Text) |
Instances
newUnprocessedAccount :: UnprocessedAccount Source #
Create a value of UnprocessedAccount 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:UnprocessedAccount', unprocessedAccount_accountId - The Amazon Web Services account identifier of the member account that
was not processed.
$sel:reason:UnprocessedAccount', unprocessedAccount_reason - The reason that the member account request could not be processed.
UnprocessedGraph
data UnprocessedGraph Source #
Behavior graphs that could not be processed in the request.
See: newUnprocessedGraph smart constructor.
Constructors
| UnprocessedGraph' (Maybe Text) (Maybe Text) |
Instances
newUnprocessedGraph :: UnprocessedGraph Source #
Create a value of UnprocessedGraph 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:graphArn:UnprocessedGraph', unprocessedGraph_graphArn - The ARN of the organization behavior graph.
$sel:reason:UnprocessedGraph', unprocessedGraph_reason - The reason data source package information could not be processed for a
behavior graph.