Class: Aws::Detective::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Detective::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb
Overview
An API client for Detective. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Detective::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_invitation(params = {}) ⇒ Struct
Accepts an invitation for the member account to contribute data to a behavior graph.
-
#create_graph(params = {}) ⇒ Types::CreateGraphResponse
Creates a new behavior graph for the calling account, and sets that account as the master account.
-
#create_members(params = {}) ⇒ Types::CreateMembersResponse
Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph.
-
#delete_graph(params = {}) ⇒ Struct
Disables the specified behavior graph and queues it to be deleted.
-
#delete_members(params = {}) ⇒ Types::DeleteMembersResponse
Deletes one or more member accounts from the master account behavior graph.
-
#disassociate_membership(params = {}) ⇒ Struct
Removes the member account from the specified behavior graph.
-
#get_members(params = {}) ⇒ Types::GetMembersResponse
Returns the membership details for specified member accounts for a behavior graph.
-
#list_graphs(params = {}) ⇒ Types::ListGraphsResponse
Returns the list of behavior graphs that the calling account is a master of.
-
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
Retrieves the list of open and accepted behavior graph invitations for the member account.
-
#list_members(params = {}) ⇒ Types::ListMembersResponse
Retrieves the list of member accounts for a behavior graph.
-
#reject_invitation(params = {}) ⇒ Struct
Rejects an invitation to contribute the account data to a behavior graph.
-
#start_monitoring_member(params = {}) ⇒ Struct
Sends a request to enable data ingest for a member account that has a status of
ACCEPTED_BUT_DISABLED
.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#accept_invitation(params = {}) ⇒ Struct
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
.
356 357 358 359 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 356 def accept_invitation(params = {}, = {}) req = build_request(:accept_invitation, params) req.send_request() end |
#create_graph(params = {}) ⇒ Types::CreateGraphResponse
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.
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 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.
396 397 398 399 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 396 def create_graph(params = {}, = {}) req = build_request(:create_graph, params) req.send_request() end |
#create_members(params = {}) ⇒ Types::CreateMembersResponse
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.
474 475 476 477 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 474 def create_members(params = {}, = {}) req = build_request(:create_members, params) req.send_request() end |
#delete_graph(params = {}) ⇒ Struct
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.
501 502 503 504 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 501 def delete_graph(params = {}, = {}) req = build_request(:delete_graph, params) req.send_request() end |
#delete_members(params = {}) ⇒ Types::DeleteMembersResponse
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.
543 544 545 546 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 543 def delete_members(params = {}, = {}) req = build_request(:delete_members, params) req.send_request() end |
#disassociate_membership(params = {}) ⇒ Struct
Removes the member account from the specified behavior graph. This
operation can only be called by a member account that has the
ENABLED
status.
570 571 572 573 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 570 def disassociate_membership(params = {}, = {}) req = build_request(:disassociate_membership, params) req.send_request() end |
#get_members(params = {}) ⇒ Types::GetMembersResponse
Returns the membership details for specified member accounts for a behavior graph.
621 622 623 624 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 621 def get_members(params = {}, = {}) req = build_request(:get_members, params) req.send_request() end |
#list_graphs(params = {}) ⇒ Types::ListGraphsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
667 668 669 670 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 667 def list_graphs(params = {}, = {}) req = build_request(:list_graphs, params) req.send_request() end |
#list_invitations(params = {}) ⇒ Types::ListInvitationsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
727 728 729 730 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 727 def list_invitations(params = {}, = {}) req = build_request(:list_invitations, params) req.send_request() end |
#list_members(params = {}) ⇒ Types::ListMembersResponse
Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
783 784 785 786 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 783 def list_members(params = {}, = {}) req = build_request(:list_members, params) req.send_request() end |
#reject_invitation(params = {}) ⇒ Struct
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.
810 811 812 813 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 810 def reject_invitation(params = {}, = {}) req = build_request(:reject_invitation, params) req.send_request() end |
#start_monitoring_member(params = {}) ⇒ Struct
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
.
848 849 850 851 |
# File 'gems/aws-sdk-detective/lib/aws-sdk-detective/client.rb', line 848 def start_monitoring_member(params = {}, = {}) req = build_request(:start_monitoring_member, params) req.send_request() end |