/ 
Paws-0.42
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Detective

NAME

Paws::Detective - Perl Interface to AWS Amazon Detective

SYNOPSIS

use Paws;

my $obj = Paws->service('Detective');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Amazon Detective is currently in preview. The Detective API can only be used by accounts that are admitted into the preview.

Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS 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 a master account.

Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.

A Detective master account 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.

A 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 (https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.detective-2018-10-26

METHODS

AcceptInvitation

GraphArn => Str

Each argument is described in detail in: Paws::Detective::AcceptInvitation

Returns: nothing

Amazon Detective is currently in preview.

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.

CreateGraph

=>

Each argument is described in detail in: Paws::Detective::CreateGraph

Returns: a Paws::Detective::CreateGraphResponse instance

Amazon Detective is currently in preview.

Creates a new behavior graph for the calling account, and sets that account as the master 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 master account for one behavior graph within a Region. If the same account calls CreateGraph with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.

CreateMembers

Accounts => ArrayRef[Paws::Detective::Account]
GraphArn => Str
[Message => Str]

Each argument is described in detail in: Paws::Detective::CreateMembers

Returns: a Paws::Detective::CreateMembersResponse instance

Amazon Detective is currently in preview.

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 master account for a behavior graph.

CreateMembers verifies the accounts and then sends invitations to the verified accounts.

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 being sent an invitation, 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.

DeleteGraph

GraphArn => Str

Each argument is described in detail in: Paws::Detective::DeleteGraph

Returns: nothing

Amazon Detective is currently in preview.

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 master account for a behavior graph.

DeleteMembers

AccountIds => ArrayRef[Str|Undef]
GraphArn => Str

Each argument is described in detail in: Paws::Detective::DeleteMembers

Returns: a Paws::Detective::DeleteMembersResponse instance

Amazon Detective is currently in preview.

Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use DeleteMembers to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the DeleteGraph API method.

DisassociateMembership

GraphArn => Str

Each argument is described in detail in: Paws::Detective::DisassociateMembership

Returns: nothing

Amazon Detective is currently in preview.

Removes the member account from the specified behavior graph. This operation can only be called by a member account that has the ENABLED status.

GetMembers

AccountIds => ArrayRef[Str|Undef]
GraphArn => Str

Each argument is described in detail in: Paws::Detective::GetMembers

Returns: a Paws::Detective::GetMembersResponse instance

Amazon Detective is currently in preview.

Returns the membership details for specified member accounts for a behavior graph.

ListGraphs

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Detective::ListGraphs

Returns: a Paws::Detective::ListGraphsResponse instance

Amazon Detective is currently in preview.

Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account.

Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph.

ListInvitations

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Detective::ListInvitations

Returns: a Paws::Detective::ListInvitationsResponse instance

Amazon Detective is currently in preview.

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.

ListMembers

GraphArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Detective::ListMembers

Returns: a Paws::Detective::ListMembersResponse instance

Amazon Detective is currently in preview.

Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.

RejectInvitation

GraphArn => Str

Each argument is described in detail in: Paws::Detective::RejectInvitation

Returns: nothing

Amazon Detective is currently in preview.

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues