Accepts the invitation to be monitored by a master GuardDuty account.
#archive_findings(options = {}) ⇒ StructArchives GuardDuty findings that are specified by the list of finding IDs.
Only the master account can archive findings. Member accounts don't have permission to archive findings from their accounts.
#create_detector(options = {}) ⇒ Types::CreateDetectorResponseCreates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region. All data sources are enabled in a new detector by default.
#create_ip_set(options = {}) ⇒ Types::CreateIPSetResponseCreates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with AWS infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the master account can use this operation.
#create_members(options = {}) ⇒ Types::CreateMembersResponseCreates member accounts of the current AWS account by specifying a list of AWS account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.
When using Create Members
as an organizations delegated administrator this action will enable GuardDuty in the added member accounts, with the exception of the organization master account, which must enable GuardDuty prior to being added as a member.
If you are adding accounts by invitation use this action after GuardDuty has been enabled in potential member accounts and before using Invite Members
.
Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.
#create_sample_findings(options = {}) ⇒ StructGenerates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes
, the API generates example findings of all supported finding types.
Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.
#decline_invitations(options = {}) ⇒ Types::DeclineInvitationsResponseDeclines invitations sent to the current member account by AWS accounts specified by their account IDs.
#delete_detector(options = {}) ⇒ StructDeletes an Amazon GuardDuty detector that is specified by the detector ID.
#delete_filter(options = {}) ⇒ StructDeletes the filter specified by the filter name.
#delete_invitations(options = {}) ⇒ Types::DeleteInvitationsResponseDeletes invitations sent to the current member account by AWS accounts specified by their account IDs.
#delete_ip_set(options = {}) ⇒ StructDeletes the IPSet specified by the ipSetId
. IPSets are called trusted IP lists in the console user interface.
Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
#delete_publishing_destination(options = {}) ⇒ StructDeletes the publishing definition with the specified destinationId
.
Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
#disable_organization_admin_account(options = {}) ⇒ StructDisables an AWS account within the Organization as the GuardDuty delegated administrator.
#disassociate_from_master_account(options = {}) ⇒ StructDisassociates the current GuardDuty member account from its master account.
#disassociate_members(options = {}) ⇒ Types::DisassociateMembersResponseDisassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
#enable_organization_admin_account(options = {}) ⇒ StructEnables an AWS account within the organization as the GuardDuty delegated administrator.
#get_invitations_count(options = {}) ⇒ Types::GetInvitationsCountResponseReturns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
#get_master_account(options = {}) ⇒ Types::GetMasterAccountResponseProvides the details for the GuardDuty master account associated with the current GuardDuty member account.
#get_members(options = {}) ⇒ Types::GetMembersResponseRetrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
#get_usage_statistics(options = {}) ⇒ Types::GetUsageStatisticsResponseLists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources the cost returned will include only the usage so far under 30 days, this may differ from the cost metrics in the console, which projects usage over 30 days to provide a monthly cost estimate. For more information see Understanding How Usage Costs are Calculated.
#invite_members(options = {}) ⇒ Types::InviteMembersResponseInvites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty, and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.
#list_invitations(options = {}) ⇒ Types::ListInvitationsResponseLists all GuardDuty membership invitations that were sent to the current AWS account.
#list_ip_sets(options = {}) ⇒ Types::ListIPSetsResponseLists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated master account.
#list_members(options = {}) ⇒ Types::ListMembersResponseLists details about all member accounts for the current GuardDuty master account.
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponseLists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.
#list_threat_intel_sets(options = {}) ⇒ Types::ListThreatIntelSetsResponseLists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated with the master account are returned.
#start_monitoring_members(options = {}) ⇒ Types::StartMonitoringMembersResponseTurns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers
operation.
Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers
operation to restart monitoring for those accounts.
Unarchives GuardDuty findings specified by the findingIds
.
Removes tags from a resource.
#update_detector(options = {}) ⇒ StructUpdates the Amazon GuardDuty detector specified by the detectorId.
#update_findings_feedback(options = {}) ⇒ StructMarks the specified GuardDuty findings as useful or not useful.
#update_ip_set(options = {}) ⇒ StructUpdates the IPSet specified by the IPSet ID.
#update_organization_configuration(options = {}) ⇒ StructUpdates the delegated administrator account with the values provided.
#update_publishing_destination(options = {}) ⇒ StructUpdates information about the publishing destination specified by the destinationId
.
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ BooleanWaiters polls an API operation until a resource enters a desired state.
Basic UsageWaiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)
ConfigurationYou can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:
# poll for ~25 seconds
client.wait_until(...) do |w|
w.max_attempts = 5
w.delay = 5
end
Callbacks
You can be notified before each polling attempt and before each delay. If you throw :success
or :failure
from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(...) do |w|
# disable max attempts
w.max_attempts = nil
# poll for 1 hour, instead of a number of attempts
w.before_wait do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
end
Handling Errors
When a waiter is successful, it returns true
. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:
Waiter Name Client Method Default Delay: Default Max Attempts:RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4