AmazonDetectiveClient (AWS Java SDK for Amazon Detective 1.12.783 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.detective.AmazonDetectiveClient

All Implemented Interfaces:

AmazonDetective

Direct Known Subclasses:

AmazonDetectiveAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonDetectiveClient
extends AmazonWebServiceClient
implements AmazonDetective
```
Client for accessing Amazon Detective. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.detective.AmazonDetective
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcceptInvitationResult`	`acceptInvitation(AcceptInvitationRequest request)` Accepts an invitation for the member account to contribute data to a behavior graph.
`BatchGetGraphMemberDatasourcesResult`	`batchGetGraphMemberDatasources(BatchGetGraphMemberDatasourcesRequest request)` Gets data source package information for the behavior graph.
`BatchGetMembershipDatasourcesResult`	`batchGetMembershipDatasources(BatchGetMembershipDatasourcesRequest request)` Gets information on the data source package history for an account.
`static AmazonDetectiveClientBuilder`	`builder()`
`CreateGraphResult`	`createGraph(CreateGraphRequest request)` Creates a new behavior graph for the calling account, and sets that account as the administrator account.
`CreateMembersResult`	`createMembers(CreateMembersRequest request)` `CreateMembers` is used to send invitations to accounts.
`DeleteGraphResult`	`deleteGraph(DeleteGraphRequest request)` Disables the specified behavior graph and queues it to be deleted.
`DeleteMembersResult`	`deleteMembers(DeleteMembersRequest request)` Removes the specified member accounts from the behavior graph.
`DescribeOrganizationConfigurationResult`	`describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest request)` Returns information about the configuration for the organization behavior graph.
`DisableOrganizationAdminAccountResult`	`disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest request)` Removes the Detective administrator account in the current Region.
`DisassociateMembershipResult`	`disassociateMembership(DisassociateMembershipRequest request)` Removes the member account from the specified behavior graph.
`EnableOrganizationAdminAccountResult`	`enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest request)` Designates the Detective administrator account for the organization in the current Region.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetInvestigationResult`	`getInvestigation(GetInvestigationRequest request)` Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise.
`GetMembersResult`	`getMembers(GetMembersRequest request)` Returns the membership details for specified member accounts for a behavior graph.
`ListDatasourcePackagesResult`	`listDatasourcePackages(ListDatasourcePackagesRequest request)` Lists data source packages in the behavior graph.
`ListGraphsResult`	`listGraphs(ListGraphsRequest request)` Returns the list of behavior graphs that the calling account is an administrator account of.
`ListIndicatorsResult`	`listIndicators(ListIndicatorsRequest request)` Gets the indicators from an investigation.
`ListInvestigationsResult`	`listInvestigations(ListInvestigationsRequest request)` Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise.
`ListInvitationsResult`	`listInvitations(ListInvitationsRequest request)` Retrieves the list of open and accepted behavior graph invitations for the member account.
`ListMembersResult`	`listMembers(ListMembersRequest request)` Retrieves the list of member accounts for a behavior graph.
`ListOrganizationAdminAccountsResult`	`listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest request)` Returns information about the Detective administrator account for an organization.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns the tag values that are assigned to a behavior graph.
`RejectInvitationResult`	`rejectInvitation(RejectInvitationRequest request)` Rejects an invitation to contribute the account data to a behavior graph.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartInvestigationResult`	`startInvestigation(StartInvestigationRequest request)` Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise.
`StartMonitoringMemberResult`	`startMonitoringMember(StartMonitoringMemberRequest request)` Sends a request to enable data ingest for a member account that has a status of `ACCEPTED_BUT_DISABLED`.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies tag values to a behavior graph.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from a behavior graph.
`UpdateDatasourcePackagesResult`	`updateDatasourcePackages(UpdateDatasourcePackagesRequest request)` Starts a data source packages for the behavior graph.
`UpdateInvestigationStateResult`	`updateInvestigationState(UpdateInvestigationStateRequest request)` Updates the state of an investigation.
`UpdateOrganizationConfigurationResult`	`updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest request)` Updates the configuration for the Organizations integration in the current Region.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AmazonDetectiveClientBuilder builder()
```
  - acceptInvitation
```
public AcceptInvitationResult acceptInvitation(AcceptInvitationRequest request)
```
    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.
    
    Specified by:
    
    acceptInvitation in interface AmazonDetective
    
    Parameters:
    
    acceptInvitationRequest -
    
    Returns:
    
    Result of the AcceptInvitation operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    ConflictException - The request attempted an invalid action.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - batchGetGraphMemberDatasources
```
public BatchGetGraphMemberDatasourcesResult batchGetGraphMemberDatasources(BatchGetGraphMemberDatasourcesRequest request)
```
    Gets data source package information for the behavior graph.
    
    Specified by:
    
    batchGetGraphMemberDatasources in interface AmazonDetective
    
    Parameters:
    
    batchGetGraphMemberDatasourcesRequest -
    
    Returns:
    
    Result of the BatchGetGraphMemberDatasources operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - batchGetMembershipDatasources
```
public BatchGetMembershipDatasourcesResult batchGetMembershipDatasources(BatchGetMembershipDatasourcesRequest request)
```
    Gets information on the data source package history for an account.
    
    Specified by:
    
    batchGetMembershipDatasources in interface AmazonDetective
    
    Parameters:
    
    batchGetMembershipDatasourcesRequest -
    
    Returns:
    
    Result of the BatchGetMembershipDatasources operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - createGraph
```
public CreateGraphResult createGraph(CreateGraphRequest request)
```
    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.
    Specified by:
    
    createGraph in interface AmazonDetective
    
    Parameters:
    
    createGraphRequest -
    
    Returns:
    
    Result of the CreateGraph operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    ConflictException - The request attempted an invalid action.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    ServiceQuotaExceededException - This request cannot be completed for one of the following reasons.
    
    This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.
    
    This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.
    See Also:
    
    AWS API Documentation
  - createMembers
```
public CreateMembersResult createMembers(CreateMembersRequest request)
```
    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.
    Specified by:
    
    createMembers in interface AmazonDetective
    
    Parameters:
    
    createMembersRequest -
    
    Returns:
    
    Result of the CreateMembers operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    ServiceQuotaExceededException - This request cannot be completed for one of the following reasons.
    
    This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.
    
    This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.
    See Also:
    
    AWS API Documentation
  - deleteGraph
```
public DeleteGraphResult deleteGraph(DeleteGraphRequest request)
```
    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.
    
    Specified by:
    
    deleteGraph in interface AmazonDetective
    
    Parameters:
    
    deleteGraphRequest -
    
    Returns:
    
    Result of the DeleteGraph operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - deleteMembers
```
public DeleteMembersResult deleteMembers(DeleteMembersRequest request)
```
    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.
    
    Specified by:
    
    deleteMembers in interface AmazonDetective
    
    Parameters:
    
    deleteMembersRequest -
    
    Returns:
    
    Result of the DeleteMembers operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    ConflictException - The request attempted an invalid action.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - describeOrganizationConfiguration
```
public DescribeOrganizationConfigurationResult describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest request)
```
    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.
    
    Specified by:
    
    describeOrganizationConfiguration in interface AmazonDetective
    
    Parameters:
    
    describeOrganizationConfigurationRequest -
    
    Returns:
    
    Result of the DescribeOrganizationConfiguration operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - disableOrganizationAdminAccount
```
public DisableOrganizationAdminAccountResult disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest request)
```
    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.
    
    Specified by:
    
    disableOrganizationAdminAccount in interface AmazonDetective
    
    Parameters:
    
    disableOrganizationAdminAccountRequest -
    
    Returns:
    
    Result of the DisableOrganizationAdminAccount operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - disassociateMembership
```
public DisassociateMembershipResult disassociateMembership(DisassociateMembershipRequest request)
```
    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.
    
    Specified by:
    
    disassociateMembership in interface AmazonDetective
    
    Parameters:
    
    disassociateMembershipRequest -
    
    Returns:
    
    Result of the DisassociateMembership operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    ConflictException - The request attempted an invalid action.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - enableOrganizationAdminAccount
```
public EnableOrganizationAdminAccountResult enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest request)
```
    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.
    
    Specified by:
    
    enableOrganizationAdminAccount in interface AmazonDetective
    
    Parameters:
    
    enableOrganizationAdminAccountRequest -
    
    Returns:
    
    Result of the EnableOrganizationAdminAccount operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - getInvestigation
```
public GetInvestigationResult getInvestigation(GetInvestigationRequest request)
```
    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.
    
    Specified by:
    
    getInvestigation in interface AmazonDetective
    
    Parameters:
    
    getInvestigationRequest -
    
    Returns:
    
    Result of the GetInvestigation operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - getMembers
```
public GetMembersResult getMembers(GetMembersRequest request)
```
    Returns the membership details for specified member accounts for a behavior graph.
    
    Specified by:
    
    getMembers in interface AmazonDetective
    
    Parameters:
    
    getMembersRequest -
    
    Returns:
    
    Result of the GetMembers operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - listDatasourcePackages
```
public ListDatasourcePackagesResult listDatasourcePackages(ListDatasourcePackagesRequest request)
```
    Lists data source packages in the behavior graph.
    
    Specified by:
    
    listDatasourcePackages in interface AmazonDetective
    
    Parameters:
    
    listDatasourcePackagesRequest -
    
    Returns:
    
    Result of the ListDatasourcePackages operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - listGraphs
```
public ListGraphsResult listGraphs(ListGraphsRequest request)
```
    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.
    
    Specified by:
    
    listGraphs in interface AmazonDetective
    
    Parameters:
    
    listGraphsRequest -
    
    Returns:
    
    Result of the ListGraphs operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - listIndicators
```
public ListIndicatorsResult listIndicators(ListIndicatorsRequest request)
```
    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.
    
    Specified by:
    
    listIndicators in interface AmazonDetective
    
    Parameters:
    
    listIndicatorsRequest -
    
    Returns:
    
    Result of the ListIndicators operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - listInvestigations
```
public ListInvestigationsResult listInvestigations(ListInvestigationsRequest request)
```
    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.
    
    Specified by:
    
    listInvestigations in interface AmazonDetective
    
    Parameters:
    
    listInvestigationsRequest -
    
    Returns:
    
    Result of the ListInvestigations operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - listInvitations
```
public ListInvitationsResult listInvitations(ListInvitationsRequest request)
```
    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.
    
    Specified by:
    
    listInvitations in interface AmazonDetective
    
    Parameters:
    
    listInvitationsRequest -
    
    Returns:
    
    Result of the ListInvitations operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - listMembers
```
public ListMembersResult listMembers(ListMembersRequest request)
```
    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.
    
    Specified by:
    
    listMembers in interface AmazonDetective
    
    Parameters:
    
    listMembersRequest -
    
    Returns:
    
    Result of the ListMembers operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - listOrganizationAdminAccounts
```
public ListOrganizationAdminAccountsResult listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest request)
```
    Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.
    
    Specified by:
    
    listOrganizationAdminAccounts in interface AmazonDetective
    
    Parameters:
    
    listOrganizationAdminAccountsRequest -
    
    Returns:
    
    Result of the ListOrganizationAdminAccounts operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns the tag values that are assigned to a behavior graph.
    
    Specified by:
    
    listTagsForResource in interface AmazonDetective
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    See Also:
    
    AWS API Documentation
  - rejectInvitation
```
public RejectInvitationResult rejectInvitation(RejectInvitationRequest request)
```
    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.
    
    Specified by:
    
    rejectInvitation in interface AmazonDetective
    
    Parameters:
    
    rejectInvitationRequest -
    
    Returns:
    
    Result of the RejectInvitation operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    ConflictException - The request attempted an invalid action.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - startInvestigation
```
public StartInvestigationResult startInvestigation(StartInvestigationRequest request)
```
    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.
    
    Specified by:
    
    startInvestigation in interface AmazonDetective
    
    Parameters:
    
    startInvestigationRequest -
    
    Returns:
    
    Result of the StartInvestigation operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    See Also:
    
    AWS API Documentation
  - startMonitoringMember
```
public StartMonitoringMemberResult startMonitoringMember(StartMonitoringMemberRequest request)
```
    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.
    Specified by:
    
    startMonitoringMember in interface AmazonDetective
    
    Parameters:
    
    startMonitoringMemberRequest -
    
    Returns:
    
    Result of the StartMonitoringMember operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    ConflictException - The request attempted an invalid action.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    ServiceQuotaExceededException - This request cannot be completed for one of the following reasons.
    
    This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.
    
    This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Applies tag values to a behavior graph.
    
    Specified by:
    
    tagResource in interface AmazonDetective
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes tags from a behavior graph.
    
    Specified by:
    
    untagResource in interface AmazonDetective
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    See Also:
    
    AWS API Documentation
  - updateDatasourcePackages
```
public UpdateDatasourcePackagesResult updateDatasourcePackages(UpdateDatasourcePackagesRequest request)
```
    Starts a data source packages for the behavior graph.
    Specified by:
    
    updateDatasourcePackages in interface AmazonDetective
    
    Parameters:
    
    updateDatasourcePackagesRequest -
    
    Returns:
    
    Result of the UpdateDatasourcePackages operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    ServiceQuotaExceededException - This request cannot be completed for one of the following reasons.
    
    This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.
    
    This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.
    ValidationException - The request parameters are invalid.
    
    See Also:
    
    AWS API Documentation
  - updateInvestigationState
```
public UpdateInvestigationStateResult updateInvestigationState(UpdateInvestigationStateRequest request)
```
    Updates the state of an investigation.
    
    Specified by:
    
    updateInvestigationState in interface AmazonDetective
    
    Parameters:
    
    updateInvestigationStateRequest -
    
    Returns:
    
    Result of the UpdateInvestigationState operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    ResourceNotFoundException - The request refers to a nonexistent resource.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - updateOrganizationConfiguration
```
public UpdateOrganizationConfigurationResult updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest request)
```
    Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.
    
    Specified by:
    
    updateOrganizationConfiguration in interface AmazonDetective
    
    Parameters:
    
    updateOrganizationConfigurationRequest -
    
    Returns:
    
    Result of the UpdateOrganizationConfiguration operation returned by the service.
    
    Throws:
    
    AccessDeniedException - The request issuer does not have permission to access this resource or perform this operation.
    
    InternalServerException - The request was valid but failed because of a problem with the service.
    
    ValidationException - The request parameters are invalid.
    
    TooManyRequestsException - The request cannot be completed because too many other requests are occurring at the same time.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonDetective
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonDetective
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonDetective
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonDetectiveClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.detective.AmazonDetective

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Field Detail

configFactory

Method Detail

builder

acceptInvitation

batchGetGraphMemberDatasources

batchGetMembershipDatasources

createGraph

createMembers

deleteGraph

deleteMembers

describeOrganizationConfiguration

disableOrganizationAdminAccount

disassociateMembership

enableOrganizationAdminAccount

getInvestigation

getMembers

listDatasourcePackages

listGraphs

listIndicators

listInvestigations

listInvitations

listMembers

listOrganizationAdminAccounts

listTagsForResource

rejectInvitation

startInvestigation

startMonitoringMember

tagResource

untagResource

updateDatasourcePackages

updateInvestigationState

updateOrganizationConfiguration

getCachedResponseMetadata

shutdown