AmazonGuardDuty (AWS SDK for Java

All Known Subinterfaces:

AmazonGuardDutyAsync

All Known Implementing Classes:

AbstractAmazonGuardDuty, AbstractAmazonGuardDutyAsync, AmazonGuardDutyAsyncClient, AmazonGuardDutyClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonGuardDuty
```
Interface for accessing Amazon GuardDuty.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonGuardDuty instead.

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds (such as lists of malicious IPs and domains) and machine learning to identify unexpected, potentially unauthorized, and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances that serve malware or mine bitcoin.

GuardDuty also monitors AWS account access behavior for signs of compromise. Some examples of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region that has never been used, or unusual API calls like a password policy change to reduce password strength.

GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see the Amazon GuardDuty User Guide .

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AcceptInvitationResult`	`acceptInvitation(AcceptInvitationRequest acceptInvitationRequest)` Accepts the invitation to be monitored by a GuardDuty administrator account.
`ArchiveFindingsResult`	`archiveFindings(ArchiveFindingsRequest archiveFindingsRequest)` Archives GuardDuty findings that are specified by the list of finding IDs.
`CreateDetectorResult`	`createDetector(CreateDetectorRequest createDetectorRequest)` Creates a single Amazon GuardDuty detector.
`CreateFilterResult`	`createFilter(CreateFilterRequest createFilterRequest)` Creates a filter using the specified finding criteria.
`CreateIPSetResult`	`createIPSet(CreateIPSetRequest createIPSetRequest)` Creates a new IPSet, which is called a trusted IP list in the console user interface.
`CreateMembersResult`	`createMembers(CreateMembersRequest createMembersRequest)` Creates member accounts of the current AWS account by specifying a list of AWS account IDs.
`CreatePublishingDestinationResult`	`createPublishingDestination(CreatePublishingDestinationRequest createPublishingDestinationRequest)` Creates a publishing destination to export findings to.
`CreateSampleFindingsResult`	`createSampleFindings(CreateSampleFindingsRequest createSampleFindingsRequest)` Generates example findings of types specified by the list of finding types.
`CreateThreatIntelSetResult`	`createThreatIntelSet(CreateThreatIntelSetRequest createThreatIntelSetRequest)` Creates a new ThreatIntelSet.
`DeclineInvitationsResult`	`declineInvitations(DeclineInvitationsRequest declineInvitationsRequest)` Declines invitations sent to the current member account by AWS accounts specified by their account IDs.
`DeleteDetectorResult`	`deleteDetector(DeleteDetectorRequest deleteDetectorRequest)` Deletes an Amazon GuardDuty detector that is specified by the detector ID.
`DeleteFilterResult`	`deleteFilter(DeleteFilterRequest deleteFilterRequest)` Deletes the filter specified by the filter name.
`DeleteInvitationsResult`	`deleteInvitations(DeleteInvitationsRequest deleteInvitationsRequest)` Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.
`DeleteIPSetResult`	`deleteIPSet(DeleteIPSetRequest deleteIPSetRequest)` Deletes the IPSet specified by the `ipSetId`.
`DeleteMembersResult`	`deleteMembers(DeleteMembersRequest deleteMembersRequest)` Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
`DeletePublishingDestinationResult`	`deletePublishingDestination(DeletePublishingDestinationRequest deletePublishingDestinationRequest)` Deletes the publishing definition with the specified `destinationId`.
`DeleteThreatIntelSetResult`	`deleteThreatIntelSet(DeleteThreatIntelSetRequest deleteThreatIntelSetRequest)` Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
`DescribeOrganizationConfigurationResult`	`describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest)` Returns information about the account selected as the delegated administrator for GuardDuty.
`DescribePublishingDestinationResult`	`describePublishingDestination(DescribePublishingDestinationRequest describePublishingDestinationRequest)` Returns information about the publishing destination specified by the provided `destinationId`.
`DisableOrganizationAdminAccountResult`	`disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest)` Disables an AWS account within the Organization as the GuardDuty delegated administrator.
`DisassociateFromMasterAccountResult`	`disassociateFromMasterAccount(DisassociateFromMasterAccountRequest disassociateFromMasterAccountRequest)` Disassociates the current GuardDuty member account from its administrator account.
`DisassociateMembersResult`	`disassociateMembers(DisassociateMembersRequest disassociateMembersRequest)` Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
`EnableOrganizationAdminAccountResult`	`enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest)` Enables an AWS account within the organization as the GuardDuty delegated administrator.
`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.
`GetDetectorResult`	`getDetector(GetDetectorRequest getDetectorRequest)` Retrieves an Amazon GuardDuty detector specified by the detectorId.
`GetFilterResult`	`getFilter(GetFilterRequest getFilterRequest)` Returns the details of the filter specified by the filter name.
`GetFindingsResult`	`getFindings(GetFindingsRequest getFindingsRequest)` Describes Amazon GuardDuty findings specified by finding IDs.
`GetFindingsStatisticsResult`	`getFindingsStatistics(GetFindingsStatisticsRequest getFindingsStatisticsRequest)` Lists Amazon GuardDuty findings statistics for the specified detector ID.
`GetInvitationsCountResult`	`getInvitationsCount(GetInvitationsCountRequest getInvitationsCountRequest)` Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
`GetIPSetResult`	`getIPSet(GetIPSetRequest getIPSetRequest)` Retrieves the IPSet specified by the `ipSetId`.
`GetMasterAccountResult`	`getMasterAccount(GetMasterAccountRequest getMasterAccountRequest)` Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
`GetMemberDetectorsResult`	`getMemberDetectors(GetMemberDetectorsRequest getMemberDetectorsRequest)` Describes which data sources are enabled for the member account's detector.
`GetMembersResult`	`getMembers(GetMembersRequest getMembersRequest)` Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
`GetThreatIntelSetResult`	`getThreatIntelSet(GetThreatIntelSetRequest getThreatIntelSetRequest)` Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
`GetUsageStatisticsResult`	`getUsageStatistics(GetUsageStatisticsRequest getUsageStatisticsRequest)` Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID.
`InviteMembersResult`	`inviteMembers(InviteMembersRequest inviteMembersRequest)` Invites 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' findings on their behalf as the GuardDuty administrator account.
`ListDetectorsResult`	`listDetectors(ListDetectorsRequest listDetectorsRequest)` Lists detectorIds of all the existing Amazon GuardDuty detector resources.
`ListFiltersResult`	`listFilters(ListFiltersRequest listFiltersRequest)` Returns a paginated list of the current filters.
`ListFindingsResult`	`listFindings(ListFindingsRequest listFindingsRequest)` Lists Amazon GuardDuty findings for the specified detector ID.
`ListInvitationsResult`	`listInvitations(ListInvitationsRequest listInvitationsRequest)` Lists all GuardDuty membership invitations that were sent to the current AWS account.
`ListIPSetsResult`	`listIPSets(ListIPSetsRequest listIPSetsRequest)` Lists the IPSets of the GuardDuty service specified by the detector ID.
`ListMembersResult`	`listMembers(ListMembersRequest listMembersRequest)` Lists details about all member accounts for the current GuardDuty administrator account.
`ListOrganizationAdminAccountsResult`	`listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest)` Lists the accounts configured as GuardDuty delegated administrators.
`ListPublishingDestinationsResult`	`listPublishingDestinations(ListPublishingDestinationsRequest listPublishingDestinationsRequest)` Returns a list of publishing destinations associated with the specified `dectectorId`.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists tags for a resource.
`ListThreatIntelSetsResult`	`listThreatIntelSets(ListThreatIntelSetsRequest listThreatIntelSetsRequest)` Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartMonitoringMembersResult`	`startMonitoringMembers(StartMonitoringMembersRequest startMonitoringMembersRequest)` Turns on GuardDuty monitoring of the specified member accounts.
`StopMonitoringMembersResult`	`stopMonitoringMembers(StopMonitoringMembersRequest stopMonitoringMembersRequest)` Stops GuardDuty monitoring for the specified member accounts.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds tags to a resource.
`UnarchiveFindingsResult`	`unarchiveFindings(UnarchiveFindingsRequest unarchiveFindingsRequest)` Unarchives GuardDuty findings specified by the `findingIds`.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes tags from a resource.
`UpdateDetectorResult`	`updateDetector(UpdateDetectorRequest updateDetectorRequest)` Updates the Amazon GuardDuty detector specified by the detectorId.
`UpdateFilterResult`	`updateFilter(UpdateFilterRequest updateFilterRequest)` Updates the filter specified by the filter name.
`UpdateFindingsFeedbackResult`	`updateFindingsFeedback(UpdateFindingsFeedbackRequest updateFindingsFeedbackRequest)` Marks the specified GuardDuty findings as useful or not useful.
`UpdateIPSetResult`	`updateIPSet(UpdateIPSetRequest updateIPSetRequest)` Updates the IPSet specified by the IPSet ID.
`UpdateMemberDetectorsResult`	`updateMemberDetectors(UpdateMemberDetectorsRequest updateMemberDetectorsRequest)` Contains information on member accounts to be updated.
`UpdateOrganizationConfigurationResult`	`updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest)` Updates the delegated administrator account with the values provided.
`UpdatePublishingDestinationResult`	`updatePublishingDestination(UpdatePublishingDestinationRequest updatePublishingDestinationRequest)` Updates information about the publishing destination specified by the `destinationId`.
`UpdateThreatIntelSetResult`	`updateThreatIntelSet(UpdateThreatIntelSetRequest updateThreatIntelSetRequest)` Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - acceptInvitation
```
AcceptInvitationResult acceptInvitation(AcceptInvitationRequest acceptInvitationRequest)
```
    Accepts the invitation to be monitored by a GuardDuty administrator account.
    
    Parameters:
    
    acceptInvitationRequest -
    
    Returns:
    
    Result of the AcceptInvitation operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - archiveFindings
```
ArchiveFindingsResult archiveFindings(ArchiveFindingsRequest archiveFindingsRequest)
```
    Archives GuardDuty findings that are specified by the list of finding IDs.
    
    Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts.
    
    Parameters:
    
    archiveFindingsRequest -
    
    Returns:
    
    Result of the ArchiveFindings operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - createDetector
```
CreateDetectorResult createDetector(CreateDetectorRequest createDetectorRequest)
```
    Creates 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.
    
    Parameters:
    
    createDetectorRequest -
    
    Returns:
    
    Result of the CreateDetector operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - createFilter
```
CreateFilterResult createFilter(CreateFilterRequest createFilterRequest)
```
    Creates a filter using the specified finding criteria.
    
    Parameters:
    
    createFilterRequest -
    
    Returns:
    
    Result of the CreateFilter operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - createIPSet
```
CreateIPSetResult createIPSet(CreateIPSetRequest createIPSetRequest)
```
    Creates 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 administrator account can use this operation.
    
    Parameters:
    
    createIPSetRequest -
    
    Returns:
    
    Result of the CreateIPSet operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - createMembers
```
CreateMembersResult createMembers(CreateMembersRequest createMembersRequest)
```
    Creates 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 delegated administrator 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 .
    
    Parameters:
    
    createMembersRequest -
    
    Returns:
    
    Result of the CreateMembers operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - createPublishingDestination
```
CreatePublishingDestinationResult createPublishingDestination(CreatePublishingDestinationRequest createPublishingDestinationRequest)
```
    Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.
    
    Parameters:
    
    createPublishingDestinationRequest -
    
    Returns:
    
    Result of the CreatePublishingDestination operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - createSampleFindings
```
CreateSampleFindingsResult createSampleFindings(CreateSampleFindingsRequest createSampleFindingsRequest)
```
    Generates 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.
    
    Parameters:
    
    createSampleFindingsRequest -
    
    Returns:
    
    Result of the CreateSampleFindings operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - createThreatIntelSet
```
CreateThreatIntelSetResult createThreatIntelSet(CreateThreatIntelSetRequest createThreatIntelSetRequest)
```
    Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator account can use this operation.
    
    Parameters:
    
    createThreatIntelSetRequest -
    
    Returns:
    
    Result of the CreateThreatIntelSet operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - declineInvitations
```
DeclineInvitationsResult declineInvitations(DeclineInvitationsRequest declineInvitationsRequest)
```
    Declines invitations sent to the current member account by AWS accounts specified by their account IDs.
    
    Parameters:
    
    declineInvitationsRequest -
    
    Returns:
    
    Result of the DeclineInvitations operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - deleteDetector
```
DeleteDetectorResult deleteDetector(DeleteDetectorRequest deleteDetectorRequest)
```
    Deletes an Amazon GuardDuty detector that is specified by the detector ID.
    
    Parameters:
    
    deleteDetectorRequest -
    
    Returns:
    
    Result of the DeleteDetector operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - deleteFilter
```
DeleteFilterResult deleteFilter(DeleteFilterRequest deleteFilterRequest)
```
    Deletes the filter specified by the filter name.
    
    Parameters:
    
    deleteFilterRequest -
    
    Returns:
    
    Result of the DeleteFilter operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - deleteIPSet
```
DeleteIPSetResult deleteIPSet(DeleteIPSetRequest deleteIPSetRequest)
```
    Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.
    
    Parameters:
    
    deleteIPSetRequest -
    
    Returns:
    
    Result of the DeleteIPSet operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - deleteInvitations
```
DeleteInvitationsResult deleteInvitations(DeleteInvitationsRequest deleteInvitationsRequest)
```
    Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.
    
    Parameters:
    
    deleteInvitationsRequest -
    
    Returns:
    
    Result of the DeleteInvitations operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - deleteMembers
```
DeleteMembersResult deleteMembers(DeleteMembersRequest deleteMembersRequest)
```
    Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
    
    Parameters:
    
    deleteMembersRequest -
    
    Returns:
    
    Result of the DeleteMembers operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - deletePublishingDestination
```
DeletePublishingDestinationResult deletePublishingDestination(DeletePublishingDestinationRequest deletePublishingDestinationRequest)
```
    Deletes the publishing definition with the specified destinationId.
    
    Parameters:
    
    deletePublishingDestinationRequest -
    
    Returns:
    
    Result of the DeletePublishingDestination operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - deleteThreatIntelSet
```
DeleteThreatIntelSetResult deleteThreatIntelSet(DeleteThreatIntelSetRequest deleteThreatIntelSetRequest)
```
    Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
    
    Parameters:
    
    deleteThreatIntelSetRequest -
    
    Returns:
    
    Result of the DeleteThreatIntelSet operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - describeOrganizationConfiguration
```
DescribeOrganizationConfigurationResult describeOrganizationConfiguration(DescribeOrganizationConfigurationRequest describeOrganizationConfigurationRequest)
```
    Returns information about the account selected as the delegated administrator for GuardDuty.
    
    Parameters:
    
    describeOrganizationConfigurationRequest -
    
    Returns:
    
    Result of the DescribeOrganizationConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - describePublishingDestination
```
DescribePublishingDestinationResult describePublishingDestination(DescribePublishingDestinationRequest describePublishingDestinationRequest)
```
    Returns information about the publishing destination specified by the provided destinationId.
    
    Parameters:
    
    describePublishingDestinationRequest -
    
    Returns:
    
    Result of the DescribePublishingDestination operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - disableOrganizationAdminAccount
```
DisableOrganizationAdminAccountResult disableOrganizationAdminAccount(DisableOrganizationAdminAccountRequest disableOrganizationAdminAccountRequest)
```
    Disables an AWS account within the Organization as the GuardDuty delegated administrator.
    
    Parameters:
    
    disableOrganizationAdminAccountRequest -
    
    Returns:
    
    Result of the DisableOrganizationAdminAccount operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - disassociateFromMasterAccount
```
DisassociateFromMasterAccountResult disassociateFromMasterAccount(DisassociateFromMasterAccountRequest disassociateFromMasterAccountRequest)
```
    Disassociates the current GuardDuty member account from its administrator account.
    
    Parameters:
    
    disassociateFromMasterAccountRequest -
    
    Returns:
    
    Result of the DisassociateFromMasterAccount operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - disassociateMembers
```
DisassociateMembersResult disassociateMembers(DisassociateMembersRequest disassociateMembersRequest)
```
    Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.
    
    Parameters:
    
    disassociateMembersRequest -
    
    Returns:
    
    Result of the DisassociateMembers operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - enableOrganizationAdminAccount
```
EnableOrganizationAdminAccountResult enableOrganizationAdminAccount(EnableOrganizationAdminAccountRequest enableOrganizationAdminAccountRequest)
```
    Enables an AWS account within the organization as the GuardDuty delegated administrator.
    
    Parameters:
    
    enableOrganizationAdminAccountRequest -
    
    Returns:
    
    Result of the EnableOrganizationAdminAccount operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getDetector
```
GetDetectorResult getDetector(GetDetectorRequest getDetectorRequest)
```
    Retrieves an Amazon GuardDuty detector specified by the detectorId.
    
    Parameters:
    
    getDetectorRequest -
    
    Returns:
    
    Result of the GetDetector operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getFilter
```
GetFilterResult getFilter(GetFilterRequest getFilterRequest)
```
    Returns the details of the filter specified by the filter name.
    
    Parameters:
    
    getFilterRequest -
    
    Returns:
    
    Result of the GetFilter operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getFindings
```
GetFindingsResult getFindings(GetFindingsRequest getFindingsRequest)
```
    Describes Amazon GuardDuty findings specified by finding IDs.
    
    Parameters:
    
    getFindingsRequest -
    
    Returns:
    
    Result of the GetFindings operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getFindingsStatistics
```
GetFindingsStatisticsResult getFindingsStatistics(GetFindingsStatisticsRequest getFindingsStatisticsRequest)
```
    Lists Amazon GuardDuty findings statistics for the specified detector ID.
    
    Parameters:
    
    getFindingsStatisticsRequest -
    
    Returns:
    
    Result of the GetFindingsStatistics operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getIPSet
```
GetIPSetResult getIPSet(GetIPSetRequest getIPSetRequest)
```
    Retrieves the IPSet specified by the ipSetId.
    
    Parameters:
    
    getIPSetRequest -
    
    Returns:
    
    Result of the GetIPSet operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getInvitationsCount
```
GetInvitationsCountResult getInvitationsCount(GetInvitationsCountRequest getInvitationsCountRequest)
```
    Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
    
    Parameters:
    
    getInvitationsCountRequest -
    
    Returns:
    
    Result of the GetInvitationsCount operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getMasterAccount
```
GetMasterAccountResult getMasterAccount(GetMasterAccountRequest getMasterAccountRequest)
```
    Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.
    
    Parameters:
    
    getMasterAccountRequest -
    
    Returns:
    
    Result of the GetMasterAccount operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getMemberDetectors
```
GetMemberDetectorsResult getMemberDetectors(GetMemberDetectorsRequest getMemberDetectorsRequest)
```
    Describes which data sources are enabled for the member account's detector.
    
    Parameters:
    
    getMemberDetectorsRequest -
    
    Returns:
    
    Result of the GetMemberDetectors operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getMembers
```
GetMembersResult getMembers(GetMembersRequest getMembersRequest)
```
    Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
    
    Parameters:
    
    getMembersRequest -
    
    Returns:
    
    Result of the GetMembers operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getThreatIntelSet
```
GetThreatIntelSetResult getThreatIntelSet(GetThreatIntelSetRequest getThreatIntelSetRequest)
```
    Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
    
    Parameters:
    
    getThreatIntelSetRequest -
    
    Returns:
    
    Result of the GetThreatIntelSet operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - getUsageStatistics
```
GetUsageStatisticsResult getUsageStatistics(GetUsageStatisticsRequest getUsageStatisticsRequest)
```
    Lists 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.
    
    Parameters:
    
    getUsageStatisticsRequest -
    
    Returns:
    
    Result of the GetUsageStatistics operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - inviteMembers
```
InviteMembersResult inviteMembers(InviteMembersRequest inviteMembersRequest)
```
    Invites 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' findings on their behalf as the GuardDuty administrator account.
    
    Parameters:
    
    inviteMembersRequest -
    
    Returns:
    
    Result of the InviteMembers operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listDetectors
```
ListDetectorsResult listDetectors(ListDetectorsRequest listDetectorsRequest)
```
    Lists detectorIds of all the existing Amazon GuardDuty detector resources.
    
    Parameters:
    
    listDetectorsRequest -
    
    Returns:
    
    Result of the ListDetectors operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listFilters
```
ListFiltersResult listFilters(ListFiltersRequest listFiltersRequest)
```
    Returns a paginated list of the current filters.
    
    Parameters:
    
    listFiltersRequest -
    
    Returns:
    
    Result of the ListFilters operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listFindings
```
ListFindingsResult listFindings(ListFindingsRequest listFindingsRequest)
```
    Lists Amazon GuardDuty findings for the specified detector ID.
    
    Parameters:
    
    listFindingsRequest -
    
    Returns:
    
    Result of the ListFindings operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listIPSets
```
ListIPSetsResult listIPSets(ListIPSetsRequest listIPSetsRequest)
```
    Lists 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 administrator account.
    
    Parameters:
    
    listIPSetsRequest -
    
    Returns:
    
    Result of the ListIPSets operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listInvitations
```
ListInvitationsResult listInvitations(ListInvitationsRequest listInvitationsRequest)
```
    Lists all GuardDuty membership invitations that were sent to the current AWS account.
    
    Parameters:
    
    listInvitationsRequest -
    
    Returns:
    
    Result of the ListInvitations operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listMembers
```
ListMembersResult listMembers(ListMembersRequest listMembersRequest)
```
    Lists details about all member accounts for the current GuardDuty administrator account.
    
    Parameters:
    
    listMembersRequest -
    
    Returns:
    
    Result of the ListMembers operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listOrganizationAdminAccounts
```
ListOrganizationAdminAccountsResult listOrganizationAdminAccounts(ListOrganizationAdminAccountsRequest listOrganizationAdminAccountsRequest)
```
    Lists the accounts configured as GuardDuty delegated administrators.
    
    Parameters:
    
    listOrganizationAdminAccountsRequest -
    
    Returns:
    
    Result of the ListOrganizationAdminAccounts operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listPublishingDestinations
```
ListPublishingDestinationsResult listPublishingDestinations(ListPublishingDestinationsRequest listPublishingDestinationsRequest)
```
    Returns a list of publishing destinations associated with the specified dectectorId.
    
    Parameters:
    
    listPublishingDestinationsRequest -
    
    Returns:
    
    Result of the ListPublishingDestinations operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists 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.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - listThreatIntelSets
```
ListThreatIntelSetsResult listThreatIntelSets(ListThreatIntelSetsRequest listThreatIntelSetsRequest)
```
    Lists 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 administrator account are returned.
    
    Parameters:
    
    listThreatIntelSetsRequest -
    
    Returns:
    
    Result of the ListThreatIntelSets operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - startMonitoringMembers
```
StartMonitoringMembersResult startMonitoringMembers(StartMonitoringMembersRequest startMonitoringMembersRequest)
```
    Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.
    
    Parameters:
    
    startMonitoringMembersRequest -
    
    Returns:
    
    Result of the StartMonitoringMembers operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - stopMonitoringMembers
```
StopMonitoringMembersResult stopMonitoringMembers(StopMonitoringMembersRequest stopMonitoringMembersRequest)
```
    Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts.
    
    Parameters:
    
    stopMonitoringMembersRequest -
    
    Returns:
    
    Result of the StopMonitoringMembers operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds tags to a resource.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - unarchiveFindings
```
UnarchiveFindingsResult unarchiveFindings(UnarchiveFindingsRequest unarchiveFindingsRequest)
```
    Unarchives GuardDuty findings specified by the findingIds.
    
    Parameters:
    
    unarchiveFindingsRequest -
    
    Returns:
    
    Result of the UnarchiveFindings operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags from a resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - updateDetector
```
UpdateDetectorResult updateDetector(UpdateDetectorRequest updateDetectorRequest)
```
    Updates the Amazon GuardDuty detector specified by the detectorId.
    
    Parameters:
    
    updateDetectorRequest -
    
    Returns:
    
    Result of the UpdateDetector operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - updateFilter
```
UpdateFilterResult updateFilter(UpdateFilterRequest updateFilterRequest)
```
    Updates the filter specified by the filter name.
    
    Parameters:
    
    updateFilterRequest -
    
    Returns:
    
    Result of the UpdateFilter operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - updateFindingsFeedback
```
UpdateFindingsFeedbackResult updateFindingsFeedback(UpdateFindingsFeedbackRequest updateFindingsFeedbackRequest)
```
    Marks the specified GuardDuty findings as useful or not useful.
    
    Parameters:
    
    updateFindingsFeedbackRequest -
    
    Returns:
    
    Result of the UpdateFindingsFeedback operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - updateIPSet
```
UpdateIPSetResult updateIPSet(UpdateIPSetRequest updateIPSetRequest)
```
    Updates the IPSet specified by the IPSet ID.
    
    Parameters:
    
    updateIPSetRequest -
    
    Returns:
    
    Result of the UpdateIPSet operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - updateMemberDetectors
```
UpdateMemberDetectorsResult updateMemberDetectors(UpdateMemberDetectorsRequest updateMemberDetectorsRequest)
```
    Contains information on member accounts to be updated.
    
    Parameters:
    
    updateMemberDetectorsRequest -
    
    Returns:
    
    Result of the UpdateMemberDetectors operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - updateOrganizationConfiguration
```
UpdateOrganizationConfigurationResult updateOrganizationConfiguration(UpdateOrganizationConfigurationRequest updateOrganizationConfigurationRequest)
```
    Updates the delegated administrator account with the values provided.
    
    Parameters:
    
    updateOrganizationConfigurationRequest -
    
    Returns:
    
    Result of the UpdateOrganizationConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - updatePublishingDestination
```
UpdatePublishingDestinationResult updatePublishingDestination(UpdatePublishingDestinationRequest updatePublishingDestinationRequest)
```
    Updates information about the publishing destination specified by the destinationId.
    
    Parameters:
    
    updatePublishingDestinationRequest -
    
    Returns:
    
    Result of the UpdatePublishingDestination operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - updateThreatIntelSet
```
UpdateThreatIntelSetResult updateThreatIntelSet(UpdateThreatIntelSetRequest updateThreatIntelSetRequest)
```
    Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
    
    Parameters:
    
    updateThreatIntelSetRequest -
    
    Returns:
    
    Result of the UpdateThreatIntelSet operation returned by the service.
    
    Throws:
    
    BadRequestException - A bad request exception object.
    
    InternalServerErrorException - An internal server error exception object.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonGuardDuty

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

acceptInvitation

archiveFindings

createDetector

createFilter

createIPSet

createMembers

createPublishingDestination

createSampleFindings

createThreatIntelSet

declineInvitations

deleteDetector

deleteFilter

deleteIPSet

deleteInvitations

deleteMembers

deletePublishingDestination

deleteThreatIntelSet

describeOrganizationConfiguration

describePublishingDestination

disableOrganizationAdminAccount

disassociateFromMasterAccount

disassociateMembers

enableOrganizationAdminAccount

getDetector

getFilter

getFindings

getFindingsStatistics

getIPSet

getInvitationsCount

getMasterAccount

getMemberDetectors

getMembers

getThreatIntelSet

getUsageStatistics

inviteMembers

listDetectors

listFilters

listFindings

listIPSets

listInvitations

listMembers

listOrganizationAdminAccounts

listPublishingDestinations

listTagsForResource

listThreatIntelSets

startMonitoringMembers

stopMonitoringMembers

tagResource

unarchiveFindings

untagResource

updateDetector

updateFilter

updateFindingsFeedback

updateIPSet

updateMemberDetectors

updateOrganizationConfiguration

updatePublishingDestination

updateThreatIntelSet

shutdown

getCachedResponseMetadata