Package-level declarations

Types

Link copied to clipboard

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following foundational data sources - VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event logs, EKS audit logs, DNS logs, Amazon EBS volume data, runtime activity belonging to container workloads, such as Amazon EKS, Amazon ECS (including Amazon Web Services Fargate), and Amazon EC2 instances. 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 Amazon Web Services environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances and container workloads. For example, GuardDuty can detect compromised EC2 instances and container workloads serving malware, or mining bitcoin.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.

Link copied to clipboard

Accepts the invitation to be monitored by a GuardDuty administrator account.

Link copied to clipboard

Archives GuardDuty findings that are specified by the list of finding IDs.

Link copied to clipboard

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.

Link copied to clipboard

Creates a filter using the specified finding criteria. The maximum number of saved filters per Amazon Web Services account per Region is 100. For more information, see Quotas for GuardDuty.

Link copied to clipboard
inline suspend fun GuardDutyClient.createIpSet(crossinline block: CreateIpSetRequest.Builder.() -> Unit): CreateIpSetResponse

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 Amazon Web Services 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.

Link copied to clipboard

Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.

Link copied to clipboard

Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.

Link copied to clipboard

Generates sample findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates sample findings of all supported finding types.

Link copied to clipboard

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.

Link copied to clipboard

Declines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.

Link copied to clipboard

Deletes an Amazon GuardDuty detector that is specified by the detector ID.

Link copied to clipboard

Deletes the filter specified by the filter name.

Link copied to clipboard

Deletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.

Link copied to clipboard
inline suspend fun GuardDutyClient.deleteIpSet(crossinline block: DeleteIpSetRequest.Builder.() -> Unit): DeleteIpSetResponse

Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.

Link copied to clipboard

Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by the account IDs.

Link copied to clipboard

Deletes the publishing definition with the specified destinationId.

Link copied to clipboard

Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.

Link copied to clipboard

Returns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all the member accounts.

Link copied to clipboard

Returns information about the account selected as the delegated administrator for GuardDuty.

Link copied to clipboard

Returns information about the publishing destination specified by the provided destinationId.

Link copied to clipboard

Removes the existing GuardDuty delegated administrator of the organization. Only the organization's management account can run this API operation.

Link copied to clipboard

Disassociates the current GuardDuty member account from its administrator account.

Link copied to clipboard

Disassociates the current GuardDuty member account from its administrator account.

Link copied to clipboard

Disassociates GuardDuty member accounts (from the current administrator account) specified by the account IDs.

Link copied to clipboard

Designates an Amazon Web Services account within the organization as your GuardDuty delegated administrator. Only the organization's management account can run this API operation.

Link copied to clipboard

Provides the details of the GuardDuty administrator account associated with the current GuardDuty member account.

Link copied to clipboard

Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with the active member accounts in your organization who have enabled Runtime Monitoring and have the GuardDuty security agent running on their resources.

Link copied to clipboard
inline suspend fun GuardDutyClient.getDetector(crossinline block: GetDetectorRequest.Builder.() -> Unit): GetDetectorResponse

Retrieves an Amazon GuardDuty detector specified by the detectorId.

Link copied to clipboard
inline suspend fun GuardDutyClient.getFilter(crossinline block: GetFilterRequest.Builder.() -> Unit): GetFilterResponse

Returns the details of the filter specified by the filter name.

Link copied to clipboard
inline suspend fun GuardDutyClient.getFindings(crossinline block: GetFindingsRequest.Builder.() -> Unit): GetFindingsResponse

Describes Amazon GuardDuty findings specified by finding IDs.

Link copied to clipboard

Lists Amazon GuardDuty findings statistics for the specified detector ID.

Link copied to clipboard

Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.

Link copied to clipboard
inline suspend fun GuardDutyClient.getIpSet(crossinline block: GetIpSetRequest.Builder.() -> Unit): GetIpSetResponse

Retrieves the IPSet specified by the ipSetId.

Link copied to clipboard

Returns the details of the malware scan settings.

Link copied to clipboard

Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account.

Link copied to clipboard

Describes which data sources are enabled for the member account's detector.

Link copied to clipboard
inline suspend fun GuardDutyClient.getMembers(crossinline block: GetMembersRequest.Builder.() -> Unit): GetMembersResponse

Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.

Link copied to clipboard

Retrieves how many active member accounts in your Amazon Web Services organization have each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.

Link copied to clipboard

Provides the number of days left for each data source used in the free trial period.

Link copied to clipboard

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

Link copied to clipboard

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 project usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated.

Link copied to clipboard

Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not needed. For more information, see Managing accounts with organizations.

Link copied to clipboard

Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member accounts in your organization.

Link copied to clipboard

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

Link copied to clipboard
inline suspend fun GuardDutyClient.listFilters(crossinline block: ListFiltersRequest.Builder.() -> Unit): ListFiltersResponse

Returns a paginated list of the current filters.

Link copied to clipboard

Lists GuardDuty findings for the specified detector ID.

Link copied to clipboard

Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.

Link copied to clipboard
inline suspend fun GuardDutyClient.listIpSets(crossinline block: ListIpSetsRequest.Builder.() -> Unit): ListIpSetsResponse

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.

Link copied to clipboard
inline suspend fun GuardDutyClient.listMembers(crossinline block: ListMembersRequest.Builder.() -> Unit): ListMembersResponse

Lists details about all member accounts for the current GuardDuty administrator account.

Link copied to clipboard

Lists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.

Link copied to clipboard

Returns a list of publishing destinations associated with the specified detectorId.

Link copied to clipboard

Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.

Link copied to clipboard

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.

Link copied to clipboard

Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account.

Link copied to clipboard

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.

Link copied to clipboard

Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts.

Link copied to clipboard
inline suspend fun GuardDutyClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds tags to a resource.

Link copied to clipboard

Unarchives GuardDuty findings specified by the findingIds.

Link copied to clipboard

Removes tags from a resource.

Link copied to clipboard

Updates the GuardDuty detector specified by the detectorId.

Link copied to clipboard

Updates the filter specified by the filter name.

Link copied to clipboard

Marks the specified GuardDuty findings as useful or not useful.

Link copied to clipboard
inline suspend fun GuardDutyClient.updateIpSet(crossinline block: UpdateIpSetRequest.Builder.() -> Unit): UpdateIpSetResponse

Updates the IPSet specified by the IPSet ID.

Link copied to clipboard

Updates the malware scan settings.

Link copied to clipboard

Contains information on member accounts to be updated.

Link copied to clipboard

Configures the delegated administrator account with the provided values. You must provide a value for either autoEnableOrganizationMembers or autoEnable, but not both.

Link copied to clipboard

Updates information about the publishing destination specified by the destinationId.

Link copied to clipboard

Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.