@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonDetective extends Object implements AmazonDetective
AmazonDetective
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AcceptInvitationResult |
acceptInvitation(AcceptInvitationRequest request)
Accepts an invitation for the member account to contribute data to a behavior graph.
|
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)
Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph.
|
DeleteGraphResult |
deleteGraph(DeleteGraphRequest request)
Disables the specified behavior graph and queues it to be deleted.
|
DeleteMembersResult |
deleteMembers(DeleteMembersRequest request)
Deletes one or more member accounts from the administrator account's behavior graph.
|
DisassociateMembershipResult |
disassociateMembership(DisassociateMembershipRequest request)
Removes the member account from the specified behavior graph.
|
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.
|
GetMembersResult |
getMembers(GetMembersRequest request)
Returns the membership details for specified member accounts for a behavior graph.
|
ListGraphsResult |
listGraphs(ListGraphsRequest request)
Returns the list of behavior graphs that the calling account is an administrator account of.
|
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.
|
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.
|
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.
|
public AcceptInvitationResult acceptInvitation(AcceptInvitationRequest request)
AmazonDetective
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
.
acceptInvitation
in interface AmazonDetective
public CreateGraphResult createGraph(CreateGraphRequest request)
AmazonDetective
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.
Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable 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.
createGraph
in interface AmazonDetective
public CreateMembersResult createMembers(CreateMembersRequest request)
AmazonDetective
Sends a request to invite the specified AWS 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.
The request provides the behavior graph ARN and the list of accounts to invite.
The response separates the requested accounts into two lists:
The accounts that CreateMembers
was able to start the verification for. This list includes member
accounts that are being verified, that have passed verification and are to be invited, and that have failed
verification.
The accounts that CreateMembers
was unable to process. This list includes accounts that were already
invited to be member accounts in the behavior graph.
createMembers
in interface AmazonDetective
public DeleteGraphResult deleteGraph(DeleteGraphRequest request)
AmazonDetective
Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.
DeleteGraph
can only be called by the administrator account for a behavior graph.
deleteGraph
in interface AmazonDetective
public DeleteMembersResult deleteMembers(DeleteMembersRequest request)
AmazonDetective
Deletes one or more member accounts from the administrator account's behavior graph. This operation can only be
called by a Detective administrator account. That account cannot use DeleteMembers
to delete their
own account from the behavior graph. To disable a behavior graph, the administrator account uses the
DeleteGraph
API method.
deleteMembers
in interface AmazonDetective
public DisassociateMembershipResult disassociateMembership(DisassociateMembershipRequest request)
AmazonDetective
Removes the member account from the specified behavior graph. This operation can only be called by a member
account that has the ENABLED
status.
disassociateMembership
in interface AmazonDetective
public GetMembersResult getMembers(GetMembersRequest request)
AmazonDetective
Returns the membership details for specified member accounts for a behavior graph.
getMembers
in interface AmazonDetective
public ListGraphsResult listGraphs(ListGraphsRequest request)
AmazonDetective
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.
listGraphs
in interface AmazonDetective
public ListInvitationsResult listInvitations(ListInvitationsRequest request)
AmazonDetective
Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a 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.
listInvitations
in interface AmazonDetective
public ListMembersResult listMembers(ListMembersRequest request)
AmazonDetective
Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
listMembers
in interface AmazonDetective
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonDetective
Returns the tag values that are assigned to a behavior graph.
listTagsForResource
in interface AmazonDetective
public RejectInvitationResult rejectInvitation(RejectInvitationRequest request)
AmazonDetective
Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by a
member account that has the INVITED
status.
rejectInvitation
in interface AmazonDetective
public StartMonitoringMemberResult startMonitoringMember(StartMonitoringMemberRequest request)
AmazonDetective
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
.
startMonitoringMember
in interface AmazonDetective
public TagResourceResult tagResource(TagResourceRequest request)
AmazonDetective
Applies tag values to a behavior graph.
tagResource
in interface AmazonDetective
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonDetective
Removes tags from a behavior graph.
untagResource
in interface AmazonDetective
public void shutdown()
AmazonDetective
shutdown
in interface AmazonDetective
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonDetective
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 a request.
getCachedResponseMetadata
in interface AmazonDetective
request
- The originally executed request.