Detective ¶

Table of Contents

Detective
- Client
- Paginators

Client ¶

class Detective.Client¶

A low-level client representing Amazon Detective:

import boto3

client = boto3.client('detective')

These are the available methods:

accept_invitation()
can_paginate()
create_graph()
create_members()
delete_graph()
delete_members()
disassociate_membership()
generate_presigned_url()
get_members()
get_paginator()
get_waiter()
list_graphs()
list_invitations()
list_members()
reject_invitation()

accept_invitation(**kwargs)¶

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 .

See also: AWS API Documentation

Request Syntax

response = client.accept_invitation(
    GraphArn='string'
)

Parameters

GraphArn (string) --

[REQUIRED]

The ARN of the behavior graph that the member account is accepting the invitation for.

The member account status in the behavior graph must be INVITED .

Returns

None

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

create_graph()¶

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.

See also: AWS API Documentation

Request Syntax

response = client.create_graph()

Return type

dict

Returns

Response Syntax

{
    'GraphArn': 'string'
}

Response Structure

(dict) --
- GraphArn (string) --
  The ARN of the new behavior graph.

create_members(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.create_members(
    GraphArn='string',
    Message='string',
    Accounts=[
        {
            'AccountId': 'string',
            'EmailAddress': 'string'
        },
    ]
)

Parameters

GraphArn (string) --
[REQUIRED]

The ARN of the behavior graph to invite the member accounts to contribute their data to.
Message (string) -- Customized message text to include in the invitation email message to the invited member accounts.
Accounts (list) --
[REQUIRED]

The list of AWS accounts to invite to become member accounts in the behavior graph. For each invited account, the account list contains the account identifier and the AWS account root user email address.
- (dict) --
  Amazon Detective is currently in preview.
  
  An AWS account that is the master of or a member of a behavior graph.
  - AccountId (string) -- [REQUIRED]
    The account identifier of the AWS account.
  - EmailAddress (string) -- [REQUIRED]
    The AWS account root user email address for the AWS account.

Return type

dict

Returns

Response Syntax

{
    'Members': [
        {
            'AccountId': 'string',
            'EmailAddress': 'string',
            'GraphArn': 'string',
            'MasterId': 'string',
            'Status': 'INVITED'|'VERIFICATION_IN_PROGRESS'|'VERIFICATION_FAILED'|'ENABLED',
            'InvitedTime': datetime(2015, 1, 1),
            'UpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- Members (list) --
  
  The set of member account invitation requests that Detective was able to process. This includes accounts that are being verified, that failed verification, and that passed verification and are being sent an invitation.
  - (dict) --
    
    Amazon Detective is currently in preview.
    
    Details about a member account that was invited to contribute to a behavior graph.
    - AccountId (string) --
      
      The AWS account identifier for the member account.
    - EmailAddress (string) --
      
      The AWS account root user email address for the member account.
    - GraphArn (string) --
      
      The ARN of the behavior graph that the member account was invited to.
    - MasterId (string) --
      
      The AWS account identifier of the master account for the behavior graph.
    - Status (string) --
      
      The current membership status of the member account. The status can have one of the following values:
      - INVITED - Indicates that the member was sent an invitation but has not yet responded.
      - VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
      - VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
      - ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
      Member accounts that declined an invitation or that were removed from the behavior graph are not included.
    - InvitedTime (datetime) --
      
      The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
    - UpdatedTime (datetime) --
      
      The date and time that the member account was last updated. The value is in milliseconds since the epoch.
- UnprocessedAccounts (list) --
  
  The list of accounts for which Detective was unable to process the invitation request. For each account, the list provides the reason why the request could not be processed. The list includes accounts that are already member accounts in the behavior graph.
  - (dict) --
    
    Amazon Detective is currently in preview.
    
    A member account that was included in a request but for which the request could not be processed.
    - AccountId (string) --
      
      The AWS account identifier of the member account that was not processed.
    - Reason (string) --
      
      The reason that the member account request could not be processed.

delete_graph(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_graph(
    GraphArn='string'
)

Parameters

GraphArn (string) --

[REQUIRED]

The ARN of the behavior graph to disable.

Returns

None

delete_members(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_members(
    GraphArn='string',
    AccountIds=[
        'string',
    ]
)

Parameters

GraphArn (string) --
[REQUIRED]

The ARN of the behavior graph to delete members from.
AccountIds (list) --
[REQUIRED]

The list of AWS account identifiers for the member accounts to delete from the behavior graph.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'AccountIds': [
        'string',
    ],
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- AccountIds (list) --
  
  The list of AWS account identifiers for the member accounts that Detective successfully deleted from the behavior graph.
  - (string) --
- UnprocessedAccounts (list) --
  
  The list of member accounts that Detective was not able to delete from the behavior graph. For each member account, provides the reason that the deletion could not be processed.
  - (dict) --
    
    Amazon Detective is currently in preview.
    
    A member account that was included in a request but for which the request could not be processed.
    - AccountId (string) --
      
      The AWS account identifier of the member account that was not processed.
    - Reason (string) --
      
      The reason that the member account request could not be processed.

disassociate_membership(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_membership(
    GraphArn='string'
)

Parameters

GraphArn (string) --

[REQUIRED]

The ARN of the behavior graph to remove the member account from.

The member account's member status in the behavior graph must be ENABLED .

Returns

None

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_members(**kwargs)¶

Amazon Detective is currently in preview.

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

See also: AWS API Documentation

Request Syntax

response = client.get_members(
    GraphArn='string',
    AccountIds=[
        'string',
    ]
)

Parameters

GraphArn (string) --
[REQUIRED]

The ARN of the behavior graph for which to request the member details.
AccountIds (list) --
[REQUIRED]

The list of AWS account identifiers for the member account for which to return member details.

You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'MemberDetails': [
        {
            'AccountId': 'string',
            'EmailAddress': 'string',
            'GraphArn': 'string',
            'MasterId': 'string',
            'Status': 'INVITED'|'VERIFICATION_IN_PROGRESS'|'VERIFICATION_FAILED'|'ENABLED',
            'InvitedTime': datetime(2015, 1, 1),
            'UpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Reason': 'string'
        },
    ]
}

Response Structure

(dict) --
- MemberDetails (list) --
  
  The member account details that Detective is returning in response to the request.
  - (dict) --
    
    Amazon Detective is currently in preview.
    
    Details about a member account that was invited to contribute to a behavior graph.
    - AccountId (string) --
      
      The AWS account identifier for the member account.
    - EmailAddress (string) --
      
      The AWS account root user email address for the member account.
    - GraphArn (string) --
      
      The ARN of the behavior graph that the member account was invited to.
    - MasterId (string) --
      
      The AWS account identifier of the master account for the behavior graph.
    - Status (string) --
      
      The current membership status of the member account. The status can have one of the following values:
      - INVITED - Indicates that the member was sent an invitation but has not yet responded.
      - VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
      - VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
      - ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
      Member accounts that declined an invitation or that were removed from the behavior graph are not included.
    - InvitedTime (datetime) --
      
      The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
    - UpdatedTime (datetime) --
      
      The date and time that the member account was last updated. The value is in milliseconds since the epoch.
- UnprocessedAccounts (list) --
  
  The requested member accounts for which Detective was unable to return member details.
  
  For each account, provides the reason why the request could not be processed.
  - (dict) --
    
    Amazon Detective is currently in preview.
    
    A member account that was included in a request but for which the request could not be processed.
    - AccountId (string) --
      
      The AWS account identifier of the member account that was not processed.
    - Reason (string) --
      
      The reason that the member account request could not be processed.

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_graphs(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.list_graphs(
    NextToken='string',
    MaxResults=123
)

Parameters

NextToken (string) -- For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.
MaxResults (integer) -- The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.

Return type

dict

Returns

Response Syntax

{
    'GraphList': [
        {
            'Arn': 'string',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- GraphList (list) --
  
  A list of behavior graphs that the account is a master for.
  - (dict) --
    
    Amazon Detective is currently in preview.
    
    A behavior graph in Detective.
    - Arn (string) --
      
      The ARN of the behavior graph.
    - CreatedTime (datetime) --
      
      The date and time that the behavior graph was created. The value is in milliseconds since the epoch.
- NextToken (string) --
  
  If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.

list_invitations(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.list_invitations(
    NextToken='string',
    MaxResults=123
)

Parameters

NextToken (string) -- For requests to retrieve the next page of results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.
MaxResults (integer) -- The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

Return type

dict

Returns

Response Syntax

{
    'Invitations': [
        {
            'AccountId': 'string',
            'EmailAddress': 'string',
            'GraphArn': 'string',
            'MasterId': 'string',
            'Status': 'INVITED'|'VERIFICATION_IN_PROGRESS'|'VERIFICATION_FAILED'|'ENABLED',
            'InvitedTime': datetime(2015, 1, 1),
            'UpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Invitations (list) --
  
  The list of behavior graphs for which the member account has open or accepted invitations.
  - (dict) --
    
    Amazon Detective is currently in preview.
    
    Details about a member account that was invited to contribute to a behavior graph.
    - AccountId (string) --
      
      The AWS account identifier for the member account.
    - EmailAddress (string) --
      
      The AWS account root user email address for the member account.
    - GraphArn (string) --
      
      The ARN of the behavior graph that the member account was invited to.
    - MasterId (string) --
      
      The AWS account identifier of the master account for the behavior graph.
    - Status (string) --
      
      The current membership status of the member account. The status can have one of the following values:
      - INVITED - Indicates that the member was sent an invitation but has not yet responded.
      - VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
      - VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
      - ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
      Member accounts that declined an invitation or that were removed from the behavior graph are not included.
    - InvitedTime (datetime) --
      
      The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
    - UpdatedTime (datetime) --
      
      The date and time that the member account was last updated. The value is in milliseconds since the epoch.
- NextToken (string) --
  
  If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.

list_members(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.list_members(
    GraphArn='string',
    NextToken='string',
    MaxResults=123
)

Parameters

GraphArn (string) --
[REQUIRED]

The ARN of the behavior graph for which to retrieve the list of member accounts.
NextToken (string) -- For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.
MaxResults (integer) -- The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

Return type

dict

Returns

Response Syntax

{
    'MemberDetails': [
        {
            'AccountId': 'string',
            'EmailAddress': 'string',
            'GraphArn': 'string',
            'MasterId': 'string',
            'Status': 'INVITED'|'VERIFICATION_IN_PROGRESS'|'VERIFICATION_FAILED'|'ENABLED',
            'InvitedTime': datetime(2015, 1, 1),
            'UpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- MemberDetails (list) --
  
  The list of member accounts in the behavior graph.
  
  The results include member accounts that did not pass verification and member accounts that have not yet accepted the invitation to the behavior graph. The results do not include member accounts that were removed from the behavior graph.
  - (dict) --
    
    Amazon Detective is currently in preview.
    
    Details about a member account that was invited to contribute to a behavior graph.
    - AccountId (string) --
      
      The AWS account identifier for the member account.
    - EmailAddress (string) --
      
      The AWS account root user email address for the member account.
    - GraphArn (string) --
      
      The ARN of the behavior graph that the member account was invited to.
    - MasterId (string) --
      
      The AWS account identifier of the master account for the behavior graph.
    - Status (string) --
      
      The current membership status of the member account. The status can have one of the following values:
      - INVITED - Indicates that the member was sent an invitation but has not yet responded.
      - VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.
      - VERIFICATION_FAILED - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
      - ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior graph.
      Member accounts that declined an invitation or that were removed from the behavior graph are not included.
    - InvitedTime (datetime) --
      
      The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.
    - UpdatedTime (datetime) --
      
      The date and time that the member account was last updated. The value is in milliseconds since the epoch.
- NextToken (string) --
  
  If there are more member accounts remaining in the results, then this is the pagination token to use to request the next page of member accounts.

reject_invitation(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.reject_invitation(
    GraphArn='string'
)

Parameters

GraphArn (string) --

[REQUIRED]

The ARN of the behavior graph to reject the invitation to.

The member account's current member status in the behavior graph must be INVITED .

Returns

None

Paginators ¶

The available paginators are:

Navigation

Table Of Contents

Detective¶

Client¶

Paginators¶

Navigation

Detective ¶

Client ¶

Paginators ¶