{"files":{"SKILL.md":"---\nname: amazon-detective\ndescription: \"Amazon Detective API skill. Use when working with Amazon Detective for invitation, graph, membership. Covers 29 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Amazon Detective\nAPI version: 2018-10-26\n\n## Auth\nAWS SigV4\n\n## Base URL\nNot specified.\n\n## Setup\n1. Configure auth: AWS SigV4\n2. GET /tags/{ResourceArn} -- returns the tag values that are assigned to a behavior graph.\n3. POST /graph/datasources/get -- create first get\n\n## Endpoints\n29 endpoints across 8 groups. See references/api-spec.lap for full details.\n\n### Invitation\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /invitation | Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.  The request provides the ARN of behavior graph. The member account status in the graph must be INVITED. |\n| POST | /invitation/removal | Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by an invited member account that has the INVITED status.  RejectInvitation cannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation. |\n\n### Graph\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /graph/datasources/get | Gets data source package information for the behavior graph. |\n| POST | /graph | Creates a new behavior graph for the calling account, and sets that account as the administrator account. This operation is called by the account that is enabling Detective. The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.  CreateGraph triggers a process to create the corresponding data tables for the new behavior graph. An account can only be the administrator account for one behavior graph within a Region. If the same account calls CreateGraph with the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph. |\n| POST | /graph/members | CreateMembers is used to send invitations to accounts. For the organization behavior graph, the Detective administrator account uses CreateMembers to enable organization accounts as member accounts. For invited accounts, CreateMembers sends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.   CreateMembers verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally. For organization accounts in the organization behavior graph, CreateMembers attempts to enable the accounts. The organization accounts do not receive invitations. The request provides the behavior graph ARN and the list of accounts to invite or to enable. The response separates the requested accounts into two lists:   The accounts that CreateMembers was able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled.   The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph. |\n| POST | /graph/removal | Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs.  DeleteGraph can only be called by the administrator account for a behavior graph. |\n| POST | /graph/members/removal | Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph. For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation. For organization accounts in the organization behavior graph, the Detective administrator account can always enable the organization account again. Organization accounts that are not enabled as member accounts are not included in the ListMembers results for the organization behavior graph. An administrator account cannot use DeleteMembers to remove their own account from the behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method. |\n| POST | /graph/members/get | Returns the membership details for specified member accounts for a behavior graph. |\n| POST | /graph/datasources/list | Lists data source packages in the behavior graph. |\n| POST | /graph/members/list | Retrieves the list of member accounts for a behavior graph. For invited accounts, 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. |\n| POST | /graph/member/monitoringstate | Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED. For valid member accounts, the status is updated as follows.   If Detective enabled the member account, then the new status is ENABLED.   If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED. |\n| POST | /graph/datasources/update | Starts a data source packages for the behavior graph. |\n\n### Membership\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /membership/datasources/get | Gets information on the data source package history for an account. |\n| POST | /membership/removal | Removes the member account from the specified behavior graph. This operation can only be called by an invited member account that has the ENABLED status.  DisassociateMembership cannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts. |\n\n### Orgs\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /orgs/describeOrganizationConfiguration | Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts. Can only be called by the Detective administrator account for the organization. |\n| POST | /orgs/disableAdminAccount | Removes the Detective administrator account in the current Region. Deletes the organization behavior graph. Can only be called by the organization management account. Removing the Detective administrator account does not affect the delegated administrator account for Detective in Organizations. To remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, except for Regions where the Detective administrator account is the organization management account. |\n| POST | /orgs/enableAdminAccount | Designates the Detective administrator account for the organization in the current Region. If the account does not have Detective enabled, then enables Detective for that account and creates a new behavior graph. Can only be called by the organization management account. If the organization has a delegated administrator account in Organizations, then the Detective administrator account must be either the delegated administrator account or the organization management account. If the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other than the organization management account, Detective calls Organizations to make that account the delegated administrator account for Detective. The organization management account cannot be the delegated administrator account. |\n| POST | /orgs/adminAccountslist | Returns information about the Detective administrator account for an organization. Can only be called by the organization management account. |\n| POST | /orgs/updateOrganizationConfiguration | Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization. |\n\n### Investigations\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /investigations/getInvestigation | Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. GetInvestigation returns the investigation results of an investigation for a behavior graph. |\n| POST | /investigations/listIndicators | Gets the indicators from an investigation. You can use the information from the indicators to determine if an IAM user and/or IAM role is involved in an unusual activity that could indicate malicious behavior and its impact. |\n| POST | /investigations/listInvestigations | Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. ListInvestigations lists all active Detective investigations. |\n| POST | /investigations/startInvestigation | Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. StartInvestigation initiates an investigation on an entity in a behavior graph. |\n| POST | /investigations/updateInvestigationState | Updates the state of an investigation. |\n\n### Graphs\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /graphs/list | Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account. Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph. |\n\n### Invitations\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /invitations/list | Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account. Open invitations are invitations that the member account has not responded to. The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from. |\n\n### Tags\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /tags/{ResourceArn} | Returns the tag values that are assigned to a behavior graph. |\n| POST | /tags/{ResourceArn} | Applies tag values to a behavior graph. |\n| DELETE | /tags/{ResourceArn} | Removes tags from a behavior graph. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Create a get?\" -> POST /graph/datasources/get\n- \"Create a graph?\" -> POST /graph\n- \"Create a member?\" -> POST /graph/members\n- \"Create a removal?\" -> POST /graph/removal\n- \"Create a describeOrganizationConfiguration?\" -> POST /orgs/describeOrganizationConfiguration\n- \"Create a disableAdminAccount?\" -> POST /orgs/disableAdminAccount\n- \"Create a enableAdminAccount?\" -> POST /orgs/enableAdminAccount\n- \"Create a getInvestigation?\" -> POST /investigations/getInvestigation\n- \"Create a list?\" -> POST /graph/datasources/list\n- \"Create a listIndicator?\" -> POST /investigations/listIndicators\n- \"Create a listInvestigation?\" -> POST /investigations/listInvestigations\n- \"Create a adminAccountslist?\" -> POST /orgs/adminAccountslist\n- \"Get tag details?\" -> GET /tags/{ResourceArn}\n- \"Create a startInvestigation?\" -> POST /investigations/startInvestigation\n- \"Create a monitoringstate?\" -> POST /graph/member/monitoringstate\n- \"Delete a tag?\" -> DELETE /tags/{ResourceArn}\n- \"Create a update?\" -> POST /graph/datasources/update\n- \"Create a updateInvestigationState?\" -> POST /investigations/updateInvestigationState\n- \"Create a updateOrganizationConfiguration?\" -> POST /orgs/updateOrganizationConfiguration\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Amazon Detective\n@version 2018-10-26\n@auth AWS SigV4\n@endpoints 29\n@hint download_for_search\n@toc invitation(2), graph(10), membership(2), orgs(5), investigations(5), graphs(1), invitations(1), tags(3)\n\n@group invitation\n@endpoint PUT /invitation\n@desc Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.  The request provides the ARN of behavior graph. The member account status in the graph must be INVITED.\n@required {GraphArn: str}\n\n@endgroup\n\n@group graph\n@endpoint POST /graph/datasources/get\n@desc Gets data source package information for the behavior graph.\n@required {GraphArn: str, AccountIds: [str]}\n@returns(200) {MemberDatasources: [MembershipDatasources]?, UnprocessedAccounts: [UnprocessedAccount]?}\n\n@endgroup\n\n@group membership\n@endpoint POST /membership/datasources/get\n@desc Gets information on the data source package history for an account.\n@required {GraphArns: [str]}\n@returns(200) {MembershipDatasources: [MembershipDatasources]?, UnprocessedGraphs: [UnprocessedGraph]?}\n\n@endgroup\n\n@group graph\n@endpoint POST /graph\n@desc Creates a new behavior graph for the calling account, and sets that account as the administrator account. This operation is called by the account that is enabling Detective. The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.  CreateGraph triggers a process to create the corresponding data tables for the new behavior graph. An account can only be the administrator account for one behavior graph within a Region. If the same account calls CreateGraph with the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph.\n@optional {Tags: map<str,str>}\n@returns(200) {GraphArn: str?}\n\n@endpoint POST /graph/members\n@desc CreateMembers is used to send invitations to accounts. For the organization behavior graph, the Detective administrator account uses CreateMembers to enable organization accounts as member accounts. For invited accounts, CreateMembers sends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.   CreateMembers verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally. For organization accounts in the organization behavior graph, CreateMembers attempts to enable the accounts. The organization accounts do not receive invitations. The request provides the behavior graph ARN and the list of accounts to invite or to enable. The response separates the requested accounts into two lists:   The accounts that CreateMembers was able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled.   The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.\n@required {GraphArn: str, Accounts: [Account]}\n@optional {Message: str, DisableEmailNotification: bool}\n@returns(200) {Members: [MemberDetail]?, UnprocessedAccounts: [UnprocessedAccount]?}\n\n@endpoint POST /graph/removal\n@desc Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs.  DeleteGraph can only be called by the administrator account for a behavior graph.\n@required {GraphArn: str}\n\n@endpoint POST /graph/members/removal\n@desc Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph. For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation. For organization accounts in the organization behavior graph, the Detective administrator account can always enable the organization account again. Organization accounts that are not enabled as member accounts are not included in the ListMembers results for the organization behavior graph. An administrator account cannot use DeleteMembers to remove their own account from the behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method.\n@required {GraphArn: str, AccountIds: [str]}\n@returns(200) {AccountIds: [str]?, UnprocessedAccounts: [UnprocessedAccount]?}\n\n@endgroup\n\n@group orgs\n@endpoint POST /orgs/describeOrganizationConfiguration\n@desc Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts. Can only be called by the Detective administrator account for the organization.\n@required {GraphArn: str}\n@returns(200) {AutoEnable: bool?}\n\n@endpoint POST /orgs/disableAdminAccount\n@desc Removes the Detective administrator account in the current Region. Deletes the organization behavior graph. Can only be called by the organization management account. Removing the Detective administrator account does not affect the delegated administrator account for Detective in Organizations. To remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, except for Regions where the Detective administrator account is the organization management account.\n\n@endgroup\n\n@group membership\n@endpoint POST /membership/removal\n@desc Removes the member account from the specified behavior graph. This operation can only be called by an invited member account that has the ENABLED status.  DisassociateMembership cannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts.\n@required {GraphArn: str}\n\n@endgroup\n\n@group orgs\n@endpoint POST /orgs/enableAdminAccount\n@desc Designates the Detective administrator account for the organization in the current Region. If the account does not have Detective enabled, then enables Detective for that account and creates a new behavior graph. Can only be called by the organization management account. If the organization has a delegated administrator account in Organizations, then the Detective administrator account must be either the delegated administrator account or the organization management account. If the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other than the organization management account, Detective calls Organizations to make that account the delegated administrator account for Detective. The organization management account cannot be the delegated administrator account.\n@required {AccountId: str}\n\n@endgroup\n\n@group investigations\n@endpoint POST /investigations/getInvestigation\n@desc Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. GetInvestigation returns the investigation results of an investigation for a behavior graph.\n@required {GraphArn: str, InvestigationId: str}\n@returns(200) {GraphArn: str?, InvestigationId: str?, EntityArn: str?, EntityType: str?, CreatedTime: str(timestamp)?, ScopeStartTime: str(timestamp)?, ScopeEndTime: str(timestamp)?, Status: str?, Severity: str?, State: str?}\n\n@endgroup\n\n@group graph\n@endpoint POST /graph/members/get\n@desc Returns the membership details for specified member accounts for a behavior graph.\n@required {GraphArn: str, AccountIds: [str]}\n@returns(200) {MemberDetails: [MemberDetail]?, UnprocessedAccounts: [UnprocessedAccount]?}\n\n@endpoint POST /graph/datasources/list\n@desc Lists data source packages in the behavior graph.\n@required {GraphArn: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {DatasourcePackages: map<str,DatasourcePackageIngestDetail>?, NextToken: str?}\n\n@endgroup\n\n@group graphs\n@endpoint POST /graphs/list\n@desc Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account. Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {GraphList: [Graph]?, NextToken: str?}\n\n@endgroup\n\n@group investigations\n@endpoint POST /investigations/listIndicators\n@desc Gets the indicators from an investigation. You can use the information from the indicators to determine if an IAM user and/or IAM role is involved in an unusual activity that could indicate malicious behavior and its impact.\n@required {GraphArn: str, InvestigationId: str}\n@optional {IndicatorType: str, NextToken: str, MaxResults: int}\n@returns(200) {GraphArn: str?, InvestigationId: str?, NextToken: str?, Indicators: [Indicator]?}\n\n@endpoint POST /investigations/listInvestigations\n@desc Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. ListInvestigations lists all active Detective investigations.\n@required {GraphArn: str}\n@optional {NextToken: str, MaxResults: int, FilterCriteria: FilterCriteria, SortCriteria: SortCriteria}\n@returns(200) {InvestigationDetails: [InvestigationDetail]?, NextToken: str?}\n\n@endgroup\n\n@group invitations\n@endpoint POST /invitations/list\n@desc Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account. Open invitations are invitations that the member account has not responded to. The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {Invitations: [MemberDetail]?, NextToken: str?}\n\n@endgroup\n\n@group graph\n@endpoint POST /graph/members/list\n@desc Retrieves the list of member accounts for a behavior graph. For invited accounts, 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.\n@required {GraphArn: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {MemberDetails: [MemberDetail]?, NextToken: str?}\n\n@endgroup\n\n@group orgs\n@endpoint POST /orgs/adminAccountslist\n@desc Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {Administrators: [Administrator]?, NextToken: str?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{ResourceArn}\n@desc Returns the tag values that are assigned to a behavior graph.\n@required {ResourceArn: str}\n@returns(200) {Tags: map<str,str>?}\n\n@endgroup\n\n@group invitation\n@endpoint POST /invitation/removal\n@desc Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by an invited member account that has the INVITED status.  RejectInvitation cannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation.\n@required {GraphArn: str}\n\n@endgroup\n\n@group investigations\n@endpoint POST /investigations/startInvestigation\n@desc Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. StartInvestigation initiates an investigation on an entity in a behavior graph.\n@required {GraphArn: str, EntityArn: str, ScopeStartTime: str(timestamp), ScopeEndTime: str(timestamp)}\n@returns(200) {InvestigationId: str?}\n\n@endgroup\n\n@group graph\n@endpoint POST /graph/member/monitoringstate\n@desc Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED. For valid member accounts, the status is updated as follows.   If Detective enabled the member account, then the new status is ENABLED.   If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.\n@required {GraphArn: str, AccountId: str}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{ResourceArn}\n@desc Applies tag values to a behavior graph.\n@required {ResourceArn: str, Tags: map<str,str>}\n\n@endpoint DELETE /tags/{ResourceArn}\n@desc Removes tags from a behavior graph.\n@required {ResourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group graph\n@endpoint POST /graph/datasources/update\n@desc Starts a data source packages for the behavior graph.\n@required {GraphArn: str, DatasourcePackages: [str]}\n\n@endgroup\n\n@group investigations\n@endpoint POST /investigations/updateInvestigationState\n@desc Updates the state of an investigation.\n@required {GraphArn: str, InvestigationId: str, State: str}\n\n@endgroup\n\n@group orgs\n@endpoint POST /orgs/updateOrganizationConfiguration\n@desc Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.\n@required {GraphArn: str}\n@optional {AutoEnable: bool}\n\n@endgroup\n\n@end\n"}}