libZSservicesZSamazonka-guarddutyZSamazonka-guardduty
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GuardDuty.Lens

Contents

Description

 
Synopsis

Operations

CreateFilter

createFilter_clientToken :: Lens' CreateFilter (Maybe Text) Source #

The idempotency token for the create request.

createFilter_action :: Lens' CreateFilter (Maybe FilterAction) Source #

Specifies the action that is to be applied to the findings that match the filter.

createFilter_description :: Lens' CreateFilter (Maybe Text) Source #

The description of the filter.

createFilter_rank :: Lens' CreateFilter (Maybe Natural) Source #

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

createFilter_tags :: Lens' CreateFilter (Maybe (HashMap Text Text)) Source #

The tags to be added to a new filter resource.

createFilter_detectorId :: Lens' CreateFilter Text Source #

The ID of the detector belonging to the GuardDuty account that you want to create a filter for.

createFilter_name :: Lens' CreateFilter Text Source #

The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

createFilter_findingCriteria :: Lens' CreateFilter FindingCriteria Source #

Represents the criteria to be used in the filter for querying findings.

You can only use the following attributes to query findings:

  • accountId
  • region
  • confidence
  • id
  • resource.accessKeyDetails.accessKeyId
  • resource.accessKeyDetails.principalId
  • resource.accessKeyDetails.userName
  • resource.accessKeyDetails.userType
  • resource.instanceDetails.iamInstanceProfile.id
  • resource.instanceDetails.imageId
  • resource.instanceDetails.instanceId
  • resource.instanceDetails.outpostArn
  • resource.instanceDetails.networkInterfaces.ipv6Addresses
  • resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
  • resource.instanceDetails.networkInterfaces.publicDnsName
  • resource.instanceDetails.networkInterfaces.publicIp
  • resource.instanceDetails.networkInterfaces.securityGroups.groupId
  • resource.instanceDetails.networkInterfaces.securityGroups.groupName
  • resource.instanceDetails.networkInterfaces.subnetId
  • resource.instanceDetails.networkInterfaces.vpcId
  • resource.instanceDetails.tags.key
  • resource.instanceDetails.tags.value
  • resource.resourceType
  • service.action.actionType
  • service.action.awsApiCallAction.api
  • service.action.awsApiCallAction.callerType
  • service.action.awsApiCallAction.errorCode
  • service.action.awsApiCallAction.remoteIpDetails.city.cityName
  • service.action.awsApiCallAction.remoteIpDetails.country.countryName
  • service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
  • service.action.awsApiCallAction.remoteIpDetails.organization.asn
  • service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
  • service.action.awsApiCallAction.serviceName
  • service.action.dnsRequestAction.domain
  • service.action.networkConnectionAction.blocked
  • service.action.networkConnectionAction.connectionDirection
  • service.action.networkConnectionAction.localPortDetails.port
  • service.action.networkConnectionAction.protocol
  • service.action.networkConnectionAction.localIpDetails.ipAddressV4
  • service.action.networkConnectionAction.remoteIpDetails.city.cityName
  • service.action.networkConnectionAction.remoteIpDetails.country.countryName
  • service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
  • service.action.networkConnectionAction.remoteIpDetails.organization.asn
  • service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
  • service.action.networkConnectionAction.remotePortDetails.port
  • service.additionalInfo.threatListName
  • service.archived

    When this attribute is set to TRUE, only archived findings are listed. When it's set to FALSE, only unarchived findings are listed. When this attribute is not set, all existing findings are listed.

  • service.resourceRole
  • severity
  • type
  • updatedAt

    Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.

createFilterResponse_name :: Lens' CreateFilterResponse Text Source #

The name of the successfully created filter.

EnableOrganizationAdminAccount

enableOrganizationAdminAccount_adminAccountId :: Lens' EnableOrganizationAdminAccount Text Source #

The AWS Account ID for the organization account to be enabled as a GuardDuty delegated administrator.

ListFindings

listFindings_findingCriteria :: Lens' ListFindings (Maybe FindingCriteria) Source #

Represents the criteria used for querying findings. Valid values include:

  • JSON field name
  • accountId
  • region
  • confidence
  • id
  • resource.accessKeyDetails.accessKeyId
  • resource.accessKeyDetails.principalId
  • resource.accessKeyDetails.userName
  • resource.accessKeyDetails.userType
  • resource.instanceDetails.iamInstanceProfile.id
  • resource.instanceDetails.imageId
  • resource.instanceDetails.instanceId
  • resource.instanceDetails.networkInterfaces.ipv6Addresses
  • resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
  • resource.instanceDetails.networkInterfaces.publicDnsName
  • resource.instanceDetails.networkInterfaces.publicIp
  • resource.instanceDetails.networkInterfaces.securityGroups.groupId
  • resource.instanceDetails.networkInterfaces.securityGroups.groupName
  • resource.instanceDetails.networkInterfaces.subnetId
  • resource.instanceDetails.networkInterfaces.vpcId
  • resource.instanceDetails.tags.key
  • resource.instanceDetails.tags.value
  • resource.resourceType
  • service.action.actionType
  • service.action.awsApiCallAction.api
  • service.action.awsApiCallAction.callerType
  • service.action.awsApiCallAction.remoteIpDetails.city.cityName
  • service.action.awsApiCallAction.remoteIpDetails.country.countryName
  • service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
  • service.action.awsApiCallAction.remoteIpDetails.organization.asn
  • service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
  • service.action.awsApiCallAction.serviceName
  • service.action.dnsRequestAction.domain
  • service.action.networkConnectionAction.blocked
  • service.action.networkConnectionAction.connectionDirection
  • service.action.networkConnectionAction.localPortDetails.port
  • service.action.networkConnectionAction.protocol
  • service.action.networkConnectionAction.remoteIpDetails.city.cityName
  • service.action.networkConnectionAction.remoteIpDetails.country.countryName
  • service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
  • service.action.networkConnectionAction.remoteIpDetails.organization.asn
  • service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
  • service.action.networkConnectionAction.remotePortDetails.port
  • service.additionalInfo.threatListName
  • service.archived

    When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.

  • service.resourceRole
  • severity
  • type
  • updatedAt

    Type: Timestamp in Unix Epoch millisecond format: 1486685375000

listFindings_sortCriteria :: Lens' ListFindings (Maybe SortCriteria) Source #

Represents the criteria used for sorting findings.

listFindings_nextToken :: Lens' ListFindings (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listFindings_maxResults :: Lens' ListFindings (Maybe Natural) Source #

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

listFindings_detectorId :: Lens' ListFindings Text Source #

The ID of the detector that specifies the GuardDuty service whose findings you want to list.

listFindingsResponse_nextToken :: Lens' ListFindingsResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

listFindingsResponse_findingIds :: Lens' ListFindingsResponse [Text] Source #

The IDs of the findings that you're listing.

ListOrganizationAdminAccounts

listOrganizationAdminAccounts_nextToken :: Lens' ListOrganizationAdminAccounts (Maybe Text) Source #

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

listOrganizationAdminAccounts_maxResults :: Lens' ListOrganizationAdminAccounts (Maybe Natural) Source #

The maximum number of results to return in the response.

listOrganizationAdminAccountsResponse_adminAccounts :: Lens' ListOrganizationAdminAccountsResponse (Maybe [AdminAccount]) Source #

A list of accounts configured as GuardDuty delegated administrators.

listOrganizationAdminAccountsResponse_nextToken :: Lens' ListOrganizationAdminAccountsResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

CreateIPSet

createIPSet_clientToken :: Lens' CreateIPSet (Maybe Text) Source #

The idempotency token for the create request.

createIPSet_tags :: Lens' CreateIPSet (Maybe (HashMap Text Text)) Source #

The tags to be added to a new IP set resource.

createIPSet_detectorId :: Lens' CreateIPSet Text Source #

The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

createIPSet_name :: Lens' CreateIPSet Text Source #

The user-friendly name to identify the IPSet.

Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).

createIPSet_format :: Lens' CreateIPSet IpSetFormat Source #

The format of the file that contains the IPSet.

createIPSet_location :: Lens' CreateIPSet Text Source #

The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

createIPSet_activate :: Lens' CreateIPSet Bool Source #

A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

DeleteThreatIntelSet

deleteThreatIntelSet_detectorId :: Lens' DeleteThreatIntelSet Text Source #

The unique ID of the detector that the threatIntelSet is associated with.

deleteThreatIntelSet_threatIntelSetId :: Lens' DeleteThreatIntelSet Text Source #

The unique ID of the threatIntelSet that you want to delete.

UpdateThreatIntelSet

updateThreatIntelSet_location :: Lens' UpdateThreatIntelSet (Maybe Text) Source #

The updated URI of the file that contains the ThreateIntelSet.

updateThreatIntelSet_activate :: Lens' UpdateThreatIntelSet (Maybe Bool) Source #

The updated Boolean value that specifies whether the ThreateIntelSet is active or not.

updateThreatIntelSet_name :: Lens' UpdateThreatIntelSet (Maybe Text) Source #

The unique ID that specifies the ThreatIntelSet that you want to update.

updateThreatIntelSet_detectorId :: Lens' UpdateThreatIntelSet Text Source #

The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.

updateThreatIntelSet_threatIntelSetId :: Lens' UpdateThreatIntelSet Text Source #

The unique ID that specifies the ThreatIntelSet that you want to update.

StopMonitoringMembers

stopMonitoringMembers_detectorId :: Lens' StopMonitoringMembers Text Source #

The unique ID of the detector associated with the GuardDuty administrator account that is monitoring member accounts.

stopMonitoringMembers_accountIds :: Lens' StopMonitoringMembers (NonEmpty Text) Source #

A list of account IDs for the member accounts to stop monitoring.

stopMonitoringMembersResponse_unprocessedAccounts :: Lens' StopMonitoringMembersResponse [UnprocessedAccount] Source #

A list of objects that contain an accountId for each account that could not be processed, and a result string that indicates why the account was not processed.

ListThreatIntelSets

listThreatIntelSets_nextToken :: Lens' ListThreatIntelSets (Maybe Text) Source #

You can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listThreatIntelSets_maxResults :: Lens' ListThreatIntelSets (Maybe Natural) Source #

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

listThreatIntelSets_detectorId :: Lens' ListThreatIntelSets Text Source #

The unique ID of the detector that the threatIntelSet is associated with.

listThreatIntelSetsResponse_nextToken :: Lens' ListThreatIntelSetsResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

CreateThreatIntelSet

createThreatIntelSet_clientToken :: Lens' CreateThreatIntelSet (Maybe Text) Source #

The idempotency token for the create request.

createThreatIntelSet_tags :: Lens' CreateThreatIntelSet (Maybe (HashMap Text Text)) Source #

The tags to be added to a new threat list resource.

createThreatIntelSet_detectorId :: Lens' CreateThreatIntelSet Text Source #

The unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for.

createThreatIntelSet_name :: Lens' CreateThreatIntelSet Text Source #

A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.

createThreatIntelSet_format :: Lens' CreateThreatIntelSet ThreatIntelSetFormat Source #

The format of the file that contains the ThreatIntelSet.

createThreatIntelSet_location :: Lens' CreateThreatIntelSet Text Source #

The URI of the file that contains the ThreatIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

createThreatIntelSet_activate :: Lens' CreateThreatIntelSet Bool Source #

A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.

DeleteMembers

deleteMembers_detectorId :: Lens' DeleteMembers Text Source #

The unique ID of the detector of the GuardDuty account whose members you want to delete.

deleteMembers_accountIds :: Lens' DeleteMembers (NonEmpty Text) Source #

A list of account IDs of the GuardDuty member accounts that you want to delete.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) for the given GuardDuty resource.

GetFindingsStatistics

getFindingsStatistics_findingCriteria :: Lens' GetFindingsStatistics (Maybe FindingCriteria) Source #

Represents the criteria that is used for querying findings.

getFindingsStatistics_detectorId :: Lens' GetFindingsStatistics Text Source #

The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.

GetIPSet

getIPSet_detectorId :: Lens' GetIPSet Text Source #

The unique ID of the detector that the IPSet is associated with.

getIPSet_ipSetId :: Lens' GetIPSet Text Source #

The unique ID of the IPSet to retrieve.

getIPSetResponse_tags :: Lens' GetIPSetResponse (Maybe (HashMap Text Text)) Source #

The tags of the IPSet resource.

getIPSetResponse_httpStatus :: Lens' GetIPSetResponse Int Source #

The response's http status code.

getIPSetResponse_name :: Lens' GetIPSetResponse Text Source #

The user-friendly name for the IPSet.

getIPSetResponse_format :: Lens' GetIPSetResponse IpSetFormat Source #

The format of the file that contains the IPSet.

getIPSetResponse_location :: Lens' GetIPSetResponse Text Source #

The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

getIPSetResponse_status :: Lens' GetIPSetResponse IpSetStatus Source #

The status of IPSet file that was uploaded.

ListInvitations

listInvitations_nextToken :: Lens' ListInvitations (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listInvitations_maxResults :: Lens' ListInvitations (Maybe Natural) Source #

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

listInvitationsResponse_nextToken :: Lens' ListInvitationsResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

UpdateMemberDetectors

updateMemberDetectors_detectorId :: Lens' UpdateMemberDetectors Text Source #

The detector ID of the administrator account.

updateMemberDetectors_accountIds :: Lens' UpdateMemberDetectors (NonEmpty Text) Source #

A list of member account IDs to be updated.

updateMemberDetectorsResponse_unprocessedAccounts :: Lens' UpdateMemberDetectorsResponse [UnprocessedAccount] Source #

A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.

GetThreatIntelSet

getThreatIntelSet_detectorId :: Lens' GetThreatIntelSet Text Source #

The unique ID of the detector that the threatIntelSet is associated with.

getThreatIntelSet_threatIntelSetId :: Lens' GetThreatIntelSet Text Source #

The unique ID of the threatIntelSet that you want to get.

getThreatIntelSetResponse_name :: Lens' GetThreatIntelSetResponse Text Source #

A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.

getThreatIntelSetResponse_location :: Lens' GetThreatIntelSetResponse Text Source #

The URI of the file that contains the ThreatIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

DeleteInvitations

deleteInvitations_accountIds :: Lens' DeleteInvitations (NonEmpty Text) Source #

A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to delete invitations from.

deleteInvitationsResponse_unprocessedAccounts :: Lens' DeleteInvitationsResponse [UnprocessedAccount] Source #

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

GetMasterAccount

getMasterAccount_detectorId :: Lens' GetMasterAccount Text Source #

The unique ID of the detector of the GuardDuty member account.

GetUsageStatistics

getUsageStatistics_nextToken :: Lens' GetUsageStatistics (Maybe Text) Source #

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

getUsageStatistics_unit :: Lens' GetUsageStatistics (Maybe Text) Source #

The currency unit you would like to view your usage statistics in. Current valid values are USD.

getUsageStatistics_maxResults :: Lens' GetUsageStatistics (Maybe Natural) Source #

The maximum number of results to return in the response.

getUsageStatistics_detectorId :: Lens' GetUsageStatistics Text Source #

The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.

getUsageStatistics_usageCriteria :: Lens' GetUsageStatistics UsageCriteria Source #

Represents the criteria used for querying usage.

getUsageStatisticsResponse_usageStatistics :: Lens' GetUsageStatisticsResponse (Maybe UsageStatistics) Source #

The usage statistics object. If a UsageStatisticType was provided, the objects representing other types will be null.

getUsageStatisticsResponse_nextToken :: Lens' GetUsageStatisticsResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

CreateDetector

createDetector_clientToken :: Lens' CreateDetector (Maybe Text) Source #

The idempotency token for the create request.

createDetector_findingPublishingFrequency :: Lens' CreateDetector (Maybe FindingPublishingFrequency) Source #

A value that specifies how frequently updated findings are exported.

createDetector_dataSources :: Lens' CreateDetector (Maybe DataSourceConfigurations) Source #

Describes which data sources will be enabled for the detector.

createDetector_tags :: Lens' CreateDetector (Maybe (HashMap Text Text)) Source #

The tags to be added to a new detector resource.

createDetector_enable :: Lens' CreateDetector Bool Source #

A Boolean value that specifies whether the detector is to be enabled.

DeclineInvitations

declineInvitations_accountIds :: Lens' DeclineInvitations (NonEmpty Text) Source #

A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to decline invitations from.

declineInvitationsResponse_unprocessedAccounts :: Lens' DeclineInvitationsResponse [UnprocessedAccount] Source #

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

DescribeOrganizationConfiguration

describeOrganizationConfiguration_detectorId :: Lens' DescribeOrganizationConfiguration Text Source #

The ID of the detector to retrieve information about the delegated administrator from.

describeOrganizationConfigurationResponse_autoEnable :: Lens' DescribeOrganizationConfigurationResponse Bool Source #

Indicates whether GuardDuty is automatically enabled for accounts added to the organization.

describeOrganizationConfigurationResponse_memberAccountLimitReached :: Lens' DescribeOrganizationConfigurationResponse Bool Source #

Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator account for your organization.

CreatePublishingDestination

createPublishingDestination_detectorId :: Lens' CreatePublishingDestination Text Source #

The ID of the GuardDuty detector associated with the publishing destination.

createPublishingDestination_destinationType :: Lens' CreatePublishingDestination DestinationType Source #

The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.

createPublishingDestination_destinationProperties :: Lens' CreatePublishingDestination DestinationProperties Source #

The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.

UpdateFilter

updateFilter_findingCriteria :: Lens' UpdateFilter (Maybe FindingCriteria) Source #

Represents the criteria to be used in the filter for querying findings.

updateFilter_action :: Lens' UpdateFilter (Maybe FilterAction) Source #

Specifies the action that is to be applied to the findings that match the filter.

updateFilter_description :: Lens' UpdateFilter (Maybe Text) Source #

The description of the filter.

updateFilter_rank :: Lens' UpdateFilter (Maybe Natural) Source #

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

updateFilter_detectorId :: Lens' UpdateFilter Text Source #

The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.

DeleteFilter

deleteFilter_detectorId :: Lens' DeleteFilter Text Source #

The unique ID of the detector that the filter is associated with.

deleteFilter_filterName :: Lens' DeleteFilter Text Source #

The name of the filter that you want to delete.

DisassociateMembers

disassociateMembers_detectorId :: Lens' DisassociateMembers Text Source #

The unique ID of the detector of the GuardDuty account whose members you want to disassociate from the administrator account.

disassociateMembers_accountIds :: Lens' DisassociateMembers (NonEmpty Text) Source #

A list of account IDs of the GuardDuty member accounts that you want to disassociate from the administrator account.

disassociateMembersResponse_unprocessedAccounts :: Lens' DisassociateMembersResponse [UnprocessedAccount] Source #

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

DisassociateFromMasterAccount

disassociateFromMasterAccount_detectorId :: Lens' DisassociateFromMasterAccount Text Source #

The unique ID of the detector of the GuardDuty member account.

AcceptInvitation

acceptInvitation_detectorId :: Lens' AcceptInvitation Text Source #

The unique ID of the detector of the GuardDuty member account.

acceptInvitation_masterId :: Lens' AcceptInvitation Text Source #

The account ID of the GuardDuty administrator account whose invitation you're accepting.

acceptInvitation_invitationId :: Lens' AcceptInvitation Text Source #

The value that is used to validate the administrator account to the member account.

ListFilters

listFilters_nextToken :: Lens' ListFilters (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listFilters_maxResults :: Lens' ListFilters (Maybe Natural) Source #

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

listFilters_detectorId :: Lens' ListFilters Text Source #

The unique ID of the detector that the filter is associated with.

listFiltersResponse_nextToken :: Lens' ListFiltersResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

ListMembers

listMembers_onlyAssociated :: Lens' ListMembers (Maybe Text) Source #

Specifies whether to only return associated members or to return all members (including members who haven't been invited yet or have been disassociated).

listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

listMembers_detectorId :: Lens' ListMembers Text Source #

The unique ID of the detector the member is associated with.

listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

ListPublishingDestinations

listPublishingDestinations_nextToken :: Lens' ListPublishingDestinations (Maybe Text) Source #

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

listPublishingDestinations_maxResults :: Lens' ListPublishingDestinations (Maybe Natural) Source #

The maximum number of results to return in the response.

listPublishingDestinations_detectorId :: Lens' ListPublishingDestinations Text Source #

The ID of the detector to retrieve publishing destinations for.

listPublishingDestinationsResponse_nextToken :: Lens' ListPublishingDestinationsResponse (Maybe Text) Source #

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

listPublishingDestinationsResponse_destinations :: Lens' ListPublishingDestinationsResponse [Destination] Source #

A Destinations object that includes information about each publishing destination returned.

DeletePublishingDestination

deletePublishingDestination_detectorId :: Lens' DeletePublishingDestination Text Source #

The unique ID of the detector associated with the publishing destination to delete.

UpdatePublishingDestination

updatePublishingDestination_destinationProperties :: Lens' UpdatePublishingDestination (Maybe DestinationProperties) Source #

A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

updatePublishingDestination_detectorId :: Lens' UpdatePublishingDestination Text Source #

The ID of the detector associated with the publishing destinations to update.

GetDetector

getDetector_detectorId :: Lens' GetDetector Text Source #

The unique ID of the detector that you want to get.

getDetectorResponse_createdAt :: Lens' GetDetectorResponse (Maybe Text) Source #

The timestamp of when the detector was created.

getDetectorResponse_dataSources :: Lens' GetDetectorResponse (Maybe DataSourceConfigurationsResult) Source #

Describes which data sources are enabled for the detector.

getDetectorResponse_updatedAt :: Lens' GetDetectorResponse (Maybe Text) Source #

The last-updated timestamp for the detector.

CreateSampleFindings

createSampleFindings_findingTypes :: Lens' CreateSampleFindings (Maybe [Text]) Source #

The types of sample findings to generate.

createSampleFindings_detectorId :: Lens' CreateSampleFindings Text Source #

The ID of the detector to create sample findings for.

ArchiveFindings

archiveFindings_detectorId :: Lens' ArchiveFindings Text Source #

The ID of the detector that specifies the GuardDuty service whose findings you want to archive.

archiveFindings_findingIds :: Lens' ArchiveFindings [Text] Source #

The IDs of the findings that you want to archive.

CreateMembers

createMembers_detectorId :: Lens' CreateMembers Text Source #

The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.

createMembers_accountDetails :: Lens' CreateMembers (NonEmpty AccountDetail) Source #

A list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account.

createMembersResponse_unprocessedAccounts :: Lens' CreateMembersResponse [UnprocessedAccount] Source #

A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.

UnarchiveFindings

unarchiveFindings_detectorId :: Lens' UnarchiveFindings Text Source #

The ID of the detector associated with the findings to unarchive.

unarchiveFindings_findingIds :: Lens' UnarchiveFindings [Text] Source #

The IDs of the findings to unarchive.

GetMemberDetectors

getMemberDetectors_detectorId :: Lens' GetMemberDetectors Text Source #

The detector ID for the administrator account.

getMemberDetectors_accountIds :: Lens' GetMemberDetectors (NonEmpty Text) Source #

The account ID of the member account.

getMemberDetectorsResponse_memberDataSourceConfigurations :: Lens' GetMemberDetectorsResponse (NonEmpty MemberDataSourceConfiguration) Source #

An object that describes which data sources are enabled for a member account.

getMemberDetectorsResponse_unprocessedAccounts :: Lens' GetMemberDetectorsResponse [UnprocessedAccount] Source #

A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.

GetInvitationsCount

StartMonitoringMembers

startMonitoringMembers_detectorId :: Lens' StartMonitoringMembers Text Source #

The unique ID of the detector of the GuardDuty administrator account associated with the member accounts to monitor.

startMonitoringMembers_accountIds :: Lens' StartMonitoringMembers (NonEmpty Text) Source #

A list of account IDs of the GuardDuty member accounts to start monitoring.

startMonitoringMembersResponse_unprocessedAccounts :: Lens' StartMonitoringMembersResponse [UnprocessedAccount] Source #

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

UpdateOrganizationConfiguration

updateOrganizationConfiguration_detectorId :: Lens' UpdateOrganizationConfiguration Text Source #

The ID of the detector to update the delegated administrator for.

updateOrganizationConfiguration_autoEnable :: Lens' UpdateOrganizationConfiguration Bool Source #

Indicates whether to automatically enable member accounts in the organization.

InviteMembers

inviteMembers_disableEmailNotification :: Lens' InviteMembers (Maybe Bool) Source #

A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.

inviteMembers_message :: Lens' InviteMembers (Maybe Text) Source #

The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.

inviteMembers_detectorId :: Lens' InviteMembers Text Source #

The unique ID of the detector of the GuardDuty account that you want to invite members with.

inviteMembers_accountIds :: Lens' InviteMembers (NonEmpty Text) Source #

A list of account IDs of the accounts that you want to invite to GuardDuty as members.

inviteMembersResponse_unprocessedAccounts :: Lens' InviteMembersResponse [UnprocessedAccount] Source #

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

DeleteIPSet

deleteIPSet_detectorId :: Lens' DeleteIPSet Text Source #

The unique ID of the detector associated with the IPSet.

deleteIPSet_ipSetId :: Lens' DeleteIPSet Text Source #

The unique ID of the IPSet to delete.

UpdateIPSet

updateIPSet_location :: Lens' UpdateIPSet (Maybe Text) Source #

The updated URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

updateIPSet_activate :: Lens' UpdateIPSet (Maybe Bool) Source #

The updated Boolean value that specifies whether the IPSet is active or not.

updateIPSet_name :: Lens' UpdateIPSet (Maybe Text) Source #

The unique ID that specifies the IPSet that you want to update.

updateIPSet_detectorId :: Lens' UpdateIPSet Text Source #

The detectorID that specifies the GuardDuty service whose IPSet you want to update.

updateIPSet_ipSetId :: Lens' UpdateIPSet Text Source #

The unique ID that specifies the IPSet that you want to update.

ListIPSets

listIPSets_nextToken :: Lens' ListIPSets (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listIPSets_maxResults :: Lens' ListIPSets (Maybe Natural) Source #

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

listIPSets_detectorId :: Lens' ListIPSets Text Source #

The unique ID of the detector that the IPSet is associated with.

listIPSetsResponse_nextToken :: Lens' ListIPSetsResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

listIPSetsResponse_ipSetIds :: Lens' ListIPSetsResponse [Text] Source #

The IDs of the IPSet resources.

GetMembers

getMembers_detectorId :: Lens' GetMembers Text Source #

The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

getMembers_accountIds :: Lens' GetMembers (NonEmpty Text) Source #

A list of account IDs of the GuardDuty member accounts that you want to describe.

getMembersResponse_unprocessedAccounts :: Lens' GetMembersResponse [UnprocessedAccount] Source #

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

DescribePublishingDestination

describePublishingDestination_detectorId :: Lens' DescribePublishingDestination Text Source #

The unique ID of the detector associated with the publishing destination to retrieve.

describePublishingDestinationResponse_destinationType :: Lens' DescribePublishingDestinationResponse DestinationType Source #

The type of publishing destination. Currently, only Amazon S3 buckets are supported.

describePublishingDestinationResponse_publishingFailureStartTimestamp :: Lens' DescribePublishingDestinationResponse Integer Source #

The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.

describePublishingDestinationResponse_destinationProperties :: Lens' DescribePublishingDestinationResponse DestinationProperties Source #

A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag to.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags to be added to a resource.

GetFindings

getFindings_sortCriteria :: Lens' GetFindings (Maybe SortCriteria) Source #

Represents the criteria used for sorting findings.

getFindings_detectorId :: Lens' GetFindings Text Source #

The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.

getFindings_findingIds :: Lens' GetFindings [Text] Source #

The IDs of the findings that you want to retrieve.

ListDetectors

listDetectors_nextToken :: Lens' ListDetectors (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listDetectors_maxResults :: Lens' ListDetectors (Maybe Natural) Source #

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

listDetectorsResponse_nextToken :: Lens' ListDetectorsResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) for the resource to remove tags from.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The tag keys to remove from the resource.

UpdateDetector

updateDetector_findingPublishingFrequency :: Lens' UpdateDetector (Maybe FindingPublishingFrequency) Source #

An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.

updateDetector_dataSources :: Lens' UpdateDetector (Maybe DataSourceConfigurations) Source #

Describes which data sources will be updated.

updateDetector_enable :: Lens' UpdateDetector (Maybe Bool) Source #

Specifies whether the detector is enabled or not enabled.

updateDetector_detectorId :: Lens' UpdateDetector Text Source #

The unique ID of the detector to update.

DeleteDetector

deleteDetector_detectorId :: Lens' DeleteDetector Text Source #

The unique ID of the detector that you want to delete.

UpdateFindingsFeedback

updateFindingsFeedback_comments :: Lens' UpdateFindingsFeedback (Maybe Text) Source #

Additional feedback about the GuardDuty findings.

updateFindingsFeedback_detectorId :: Lens' UpdateFindingsFeedback Text Source #

The ID of the detector associated with the findings to update feedback for.

updateFindingsFeedback_findingIds :: Lens' UpdateFindingsFeedback [Text] Source #

The IDs of the findings that you want to mark as useful or not useful.

GetFilter

getFilter_detectorId :: Lens' GetFilter Text Source #

The unique ID of the detector that the filter is associated with.

getFilter_filterName :: Lens' GetFilter Text Source #

The name of the filter you want to get.

getFilterResponse_rank :: Lens' GetFilterResponse (Maybe Natural) Source #

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

getFilterResponse_httpStatus :: Lens' GetFilterResponse Int Source #

The response's http status code.

getFilterResponse_action :: Lens' GetFilterResponse FilterAction Source #

Specifies the action that is to be applied to the findings that match the filter.

getFilterResponse_findingCriteria :: Lens' GetFilterResponse FindingCriteria Source #

Represents the criteria to be used in the filter for querying findings.

DisableOrganizationAdminAccount

disableOrganizationAdminAccount_adminAccountId :: Lens' DisableOrganizationAdminAccount Text Source #

The AWS Account ID for the organizations account to be disabled as a GuardDuty delegated administrator.

Types

AccessControlList

accessControlList_allowsPublicWriteAccess :: Lens' AccessControlList (Maybe Bool) Source #

A value that indicates whether public write access for the bucket is enabled through an Access Control List (ACL).

accessControlList_allowsPublicReadAccess :: Lens' AccessControlList (Maybe Bool) Source #

A value that indicates whether public read access for the bucket is enabled through an Access Control List (ACL).

AccessKeyDetails

AccountDetail

accountDetail_email :: Lens' AccountDetail Text Source #

The email address of the member account.

AccountLevelPermissions

accountLevelPermissions_blockPublicAccess :: Lens' AccountLevelPermissions (Maybe BlockPublicAccess) Source #

Describes the S3 Block Public Access settings of the bucket's parent account.

Action

action_networkConnectionAction :: Lens' Action (Maybe NetworkConnectionAction) Source #

Information about the NETWORK_CONNECTION action described in this finding.

action_portProbeAction :: Lens' Action (Maybe PortProbeAction) Source #

Information about the PORT_PROBE action described in this finding.

action_actionType :: Lens' Action (Maybe Text) Source #

The GuardDuty finding activity type.

action_dnsRequestAction :: Lens' Action (Maybe DnsRequestAction) Source #

Information about the DNS_REQUEST action described in this finding.

action_awsApiCallAction :: Lens' Action (Maybe AwsApiCallAction) Source #

Information about the AWS_API_CALL action described in this finding.

AdminAccount

adminAccount_adminAccountId :: Lens' AdminAccount (Maybe Text) Source #

The AWS account ID for the account.

adminAccount_adminStatus :: Lens' AdminAccount (Maybe AdminStatus) Source #

Indicates whether the account is enabled as the delegated administrator.

AwsApiCallAction

awsApiCallAction_remoteIpDetails :: Lens' AwsApiCallAction (Maybe RemoteIpDetails) Source #

The remote IP information of the connection that initiated the AWS API call.

awsApiCallAction_domainDetails :: Lens' AwsApiCallAction (Maybe DomainDetails) Source #

The domain information for the AWS API call.

awsApiCallAction_serviceName :: Lens' AwsApiCallAction (Maybe Text) Source #

The AWS service name whose API was invoked.

awsApiCallAction_errorCode :: Lens' AwsApiCallAction (Maybe Text) Source #

The error code of the failed AWS API action.

BlockPublicAccess

blockPublicAccess_ignorePublicAcls :: Lens' BlockPublicAccess (Maybe Bool) Source #

Indicates if S3 Block Public Access is set to IgnorePublicAcls.

blockPublicAccess_blockPublicAcls :: Lens' BlockPublicAccess (Maybe Bool) Source #

Indicates if S3 Block Public Access is set to BlockPublicAcls.

blockPublicAccess_restrictPublicBuckets :: Lens' BlockPublicAccess (Maybe Bool) Source #

Indicates if S3 Block Public Access is set to RestrictPublicBuckets.

blockPublicAccess_blockPublicPolicy :: Lens' BlockPublicAccess (Maybe Bool) Source #

Indicates if S3 Block Public Access is set to BlockPublicPolicy.

BucketLevelPermissions

bucketLevelPermissions_accessControlList :: Lens' BucketLevelPermissions (Maybe AccessControlList) Source #

Contains information on how Access Control Policies are applied to the bucket.

bucketLevelPermissions_blockPublicAccess :: Lens' BucketLevelPermissions (Maybe BlockPublicAccess) Source #

Contains information on which account level S3 Block Public Access settings are applied to the S3 bucket.

bucketLevelPermissions_bucketPolicy :: Lens' BucketLevelPermissions (Maybe BucketPolicy) Source #

Contains information on the bucket policies for the S3 bucket.

BucketPolicy

bucketPolicy_allowsPublicWriteAccess :: Lens' BucketPolicy (Maybe Bool) Source #

A value that indicates whether public write access for the bucket is enabled through a bucket policy.

bucketPolicy_allowsPublicReadAccess :: Lens' BucketPolicy (Maybe Bool) Source #

A value that indicates whether public read access for the bucket is enabled through a bucket policy.

City

city_cityName :: Lens' City (Maybe Text) Source #

The city name of the remote IP address.

CloudTrailConfigurationResult

cloudTrailConfigurationResult_status :: Lens' CloudTrailConfigurationResult DataSourceStatus Source #

Describes whether CloudTrail is enabled as a data source for the detector.

Condition

condition_eq :: Lens' Condition (Maybe [Text]) Source #

Represents the equal condition to be applied to a single field when querying for findings.

condition_lessThan :: Lens' Condition (Maybe Integer) Source #

Represents a less than condition to be applied to a single field when querying for findings.

condition_lte :: Lens' Condition (Maybe Int) Source #

Represents a less than or equal condition to be applied to a single field when querying for findings.

condition_greaterThanOrEqual :: Lens' Condition (Maybe Integer) Source #

Represents a greater than or equal condition to be applied to a single field when querying for findings.

condition_lessThanOrEqual :: Lens' Condition (Maybe Integer) Source #

Represents a less than or equal condition to be applied to a single field when querying for findings.

condition_gt :: Lens' Condition (Maybe Int) Source #

Represents a greater than condition to be applied to a single field when querying for findings.

condition_equals :: Lens' Condition (Maybe [Text]) Source #

Represents an equal ____ condition to be applied to a single field when querying for findings.

condition_neq :: Lens' Condition (Maybe [Text]) Source #

Represents the not equal condition to be applied to a single field when querying for findings.

condition_notEquals :: Lens' Condition (Maybe [Text]) Source #

Represents a not equal ____ condition to be applied to a single field when querying for findings.

condition_lt :: Lens' Condition (Maybe Int) Source #

Represents a less than condition to be applied to a single field when querying for findings.

condition_gte :: Lens' Condition (Maybe Int) Source #

Represents a greater than or equal condition to be applied to a single field when querying for findings.

condition_greaterThan :: Lens' Condition (Maybe Integer) Source #

Represents a greater than condition to be applied to a single field when querying for findings.

Country

country_countryName :: Lens' Country (Maybe Text) Source #

The country name of the remote IP address.

country_countryCode :: Lens' Country (Maybe Text) Source #

The country code of the remote IP address.

DNSLogsConfigurationResult

dNSLogsConfigurationResult_status :: Lens' DNSLogsConfigurationResult DataSourceStatus Source #

Denotes whether DNS logs is enabled as a data source.

DataSourceConfigurations

dataSourceConfigurations_s3Logs :: Lens' DataSourceConfigurations (Maybe S3LogsConfiguration) Source #

Describes whether S3 data event logs are enabled as a data source.

DataSourceConfigurationsResult

dataSourceConfigurationsResult_cloudTrail :: Lens' DataSourceConfigurationsResult CloudTrailConfigurationResult Source #

An object that contains information on the status of CloudTrail as a data source.

dataSourceConfigurationsResult_dNSLogs :: Lens' DataSourceConfigurationsResult DNSLogsConfigurationResult Source #

An object that contains information on the status of DNS logs as a data source.

dataSourceConfigurationsResult_flowLogs :: Lens' DataSourceConfigurationsResult FlowLogsConfigurationResult Source #

An object that contains information on the status of VPC flow logs as a data source.

dataSourceConfigurationsResult_s3Logs :: Lens' DataSourceConfigurationsResult S3LogsConfigurationResult Source #

An object that contains information on the status of S3 Data event logs as a data source.

DefaultServerSideEncryption

defaultServerSideEncryption_encryptionType :: Lens' DefaultServerSideEncryption (Maybe Text) Source #

The type of encryption used for objects within the S3 bucket.

defaultServerSideEncryption_kmsMasterKeyArn :: Lens' DefaultServerSideEncryption (Maybe Text) Source #

The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket EncryptionType is aws:kms.

Destination

destination_destinationId :: Lens' Destination Text Source #

The unique ID of the publishing destination.

destination_destinationType :: Lens' Destination DestinationType Source #

The type of resource used for the publishing destination. Currently, only Amazon S3 buckets are supported.

destination_status :: Lens' Destination PublishingStatus Source #

The status of the publishing destination.

DestinationProperties

destinationProperties_kmsKeyArn :: Lens' DestinationProperties (Maybe Text) Source #

The ARN of the KMS key to use for encryption.

DnsRequestAction

dnsRequestAction_domain :: Lens' DnsRequestAction (Maybe Text) Source #

The domain information for the API request.

DomainDetails

domainDetails_domain :: Lens' DomainDetails (Maybe Text) Source #

The domain information for the AWS API call.

Evidence

evidence_threatIntelligenceDetails :: Lens' Evidence (Maybe [ThreatIntelligenceDetail]) Source #

A list of threat intelligence details related to the evidence.

Finding

finding_confidence :: Lens' Finding (Maybe Double) Source #

The confidence score for the finding.

finding_partition :: Lens' Finding (Maybe Text) Source #

The partition associated with the finding.

finding_title :: Lens' Finding (Maybe Text) Source #

The title of the finding.

finding_description :: Lens' Finding (Maybe Text) Source #

The description of the finding.

finding_accountId :: Lens' Finding Text Source #

The ID of the account in which the finding was generated.

finding_arn :: Lens' Finding Text Source #

The ARN of the finding.

finding_createdAt :: Lens' Finding Text Source #

The time and date when the finding was created.

finding_id :: Lens' Finding Text Source #

The ID of the finding.

finding_region :: Lens' Finding Text Source #

The Region where the finding was generated.

finding_schemaVersion :: Lens' Finding Text Source #

The version of the schema used for the finding.

finding_severity :: Lens' Finding Double Source #

The severity of the finding.

finding_type :: Lens' Finding Text Source #

The type of finding.

finding_updatedAt :: Lens' Finding Text Source #

The time and date when the finding was last updated.

FindingCriteria

findingCriteria_criterion :: Lens' FindingCriteria (Maybe (HashMap Text Condition)) Source #

Represents a map of finding properties that match specified conditions and values when querying findings.

FindingStatistics

findingStatistics_countBySeverity :: Lens' FindingStatistics (Maybe (HashMap Text Int)) Source #

Represents a map of severity to count statistics for a set of findings.

FlowLogsConfigurationResult

flowLogsConfigurationResult_status :: Lens' FlowLogsConfigurationResult DataSourceStatus Source #

Denotes whether VPC flow logs is enabled as a data source.

GeoLocation

geoLocation_lat :: Lens' GeoLocation (Maybe Double) Source #

The latitude information of the remote IP address.

geoLocation_lon :: Lens' GeoLocation (Maybe Double) Source #

The longitude information of the remote IP address.

IamInstanceProfile

iamInstanceProfile_arn :: Lens' IamInstanceProfile (Maybe Text) Source #

The profile ARN of the EC2 instance.

iamInstanceProfile_id :: Lens' IamInstanceProfile (Maybe Text) Source #

The profile ID of the EC2 instance.

InstanceDetails

instanceDetails_platform :: Lens' InstanceDetails (Maybe Text) Source #

The platform of the EC2 instance.

instanceDetails_launchTime :: Lens' InstanceDetails (Maybe Text) Source #

The launch time of the EC2 instance.

instanceDetails_networkInterfaces :: Lens' InstanceDetails (Maybe [NetworkInterface]) Source #

The elastic network interface information of the EC2 instance.

instanceDetails_outpostArn :: Lens' InstanceDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS Outposts instances.

instanceDetails_availabilityZone :: Lens' InstanceDetails (Maybe Text) Source #

The Availability Zone of the EC2 instance.

instanceDetails_imageId :: Lens' InstanceDetails (Maybe Text) Source #

The image ID of the EC2 instance.

instanceDetails_productCodes :: Lens' InstanceDetails (Maybe [ProductCode]) Source #

The product code of the EC2 instance.

instanceDetails_tags :: Lens' InstanceDetails (Maybe [Tag]) Source #

The tags of the EC2 instance.

instanceDetails_imageDescription :: Lens' InstanceDetails (Maybe Text) Source #

The image description of the EC2 instance.

Invitation

invitation_invitedAt :: Lens' Invitation (Maybe Text) Source #

The timestamp when the invitation was sent.

invitation_relationshipStatus :: Lens' Invitation (Maybe Text) Source #

The status of the relationship between the inviter and invitee accounts.

invitation_invitationId :: Lens' Invitation (Maybe Text) Source #

The ID of the invitation. This value is used to validate the inviter account to the member account.

invitation_accountId :: Lens' Invitation (Maybe Text) Source #

The ID of the account that the invitation was sent from.

LocalIpDetails

localIpDetails_ipAddressV4 :: Lens' LocalIpDetails (Maybe Text) Source #

The IPv4 local address of the connection.

LocalPortDetails

localPortDetails_portName :: Lens' LocalPortDetails (Maybe Text) Source #

The port name of the local connection.

localPortDetails_port :: Lens' LocalPortDetails (Maybe Int) Source #

The port number of the local connection.

Master

master_invitedAt :: Lens' Master (Maybe Text) Source #

The timestamp when the invitation was sent.

master_relationshipStatus :: Lens' Master (Maybe Text) Source #

The status of the relationship between the administrator and member accounts.

master_invitationId :: Lens' Master (Maybe Text) Source #

The value used to validate the administrator account to the member account.

master_accountId :: Lens' Master (Maybe Text) Source #

The ID of the account used as the administrator account.

Member

member_invitedAt :: Lens' Member (Maybe Text) Source #

The timestamp when the invitation was sent.

member_detectorId :: Lens' Member (Maybe Text) Source #

The detector ID of the member account.

member_accountId :: Lens' Member Text Source #

The ID of the member account.

member_masterId :: Lens' Member Text Source #

The administrator account ID.

member_email :: Lens' Member Text Source #

The email address of the member account.

member_relationshipStatus :: Lens' Member Text Source #

The status of the relationship between the member and the administrator.

member_updatedAt :: Lens' Member Text Source #

The last-updated timestamp of the member.

MemberDataSourceConfiguration

memberDataSourceConfiguration_dataSources :: Lens' MemberDataSourceConfiguration DataSourceConfigurationsResult Source #

Contains information on the status of data sources for the account.

NetworkConnectionAction

networkConnectionAction_blocked :: Lens' NetworkConnectionAction (Maybe Bool) Source #

Indicates whether EC2 blocked the network connection to your instance.

NetworkInterface

networkInterface_privateIpAddresses :: Lens' NetworkInterface (Maybe [PrivateIpAddressDetails]) Source #

Other private IP address information of the EC2 instance.

networkInterface_publicDnsName :: Lens' NetworkInterface (Maybe Text) Source #

The public DNS name of the EC2 instance.

networkInterface_securityGroups :: Lens' NetworkInterface (Maybe [SecurityGroup]) Source #

The security groups associated with the EC2 instance.

networkInterface_vpcId :: Lens' NetworkInterface (Maybe Text) Source #

The VPC ID of the EC2 instance.

networkInterface_subnetId :: Lens' NetworkInterface (Maybe Text) Source #

The subnet ID of the EC2 instance.

networkInterface_privateIpAddress :: Lens' NetworkInterface (Maybe Text) Source #

The private IP address of the EC2 instance.

networkInterface_publicIp :: Lens' NetworkInterface (Maybe Text) Source #

The public IP address of the EC2 instance.

networkInterface_privateDnsName :: Lens' NetworkInterface (Maybe Text) Source #

The private DNS name of the EC2 instance.

networkInterface_ipv6Addresses :: Lens' NetworkInterface (Maybe [Text]) Source #

A list of IPv6 addresses for the EC2 instance.

Organization

organization_org :: Lens' Organization (Maybe Text) Source #

The name of the internet provider.

organization_asnOrg :: Lens' Organization (Maybe Text) Source #

The organization that registered this ASN.

organization_asn :: Lens' Organization (Maybe Text) Source #

The Autonomous System Number (ASN) of the internet provider of the remote IP address.

organization_isp :: Lens' Organization (Maybe Text) Source #

The ISP information for the internet provider.

OrganizationDataSourceConfigurations

organizationDataSourceConfigurations_s3Logs :: Lens' OrganizationDataSourceConfigurations (Maybe OrganizationS3LogsConfiguration) Source #

Describes whether S3 data event logs are enabled for new members of the organization.

OrganizationDataSourceConfigurationsResult

OrganizationS3LogsConfiguration

organizationS3LogsConfiguration_autoEnable :: Lens' OrganizationS3LogsConfiguration Bool Source #

A value that contains information on whether S3 data event logs will be enabled automatically as a data source for the organization.

OrganizationS3LogsConfigurationResult

organizationS3LogsConfigurationResult_autoEnable :: Lens' OrganizationS3LogsConfigurationResult Bool Source #

A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

Owner

owner_id :: Lens' Owner (Maybe Text) Source #

The canonical user ID of the bucket owner. For information about locating your canonical user ID see Finding Your Account Canonical User ID.

PermissionConfiguration

permissionConfiguration_bucketLevelPermissions :: Lens' PermissionConfiguration (Maybe BucketLevelPermissions) Source #

Contains information about the bucket level permissions for the S3 bucket.

permissionConfiguration_accountLevelPermissions :: Lens' PermissionConfiguration (Maybe AccountLevelPermissions) Source #

Contains information about the account level permissions on the S3 bucket.

PortProbeAction

portProbeAction_portProbeDetails :: Lens' PortProbeAction (Maybe [PortProbeDetail]) Source #

A list of objects related to port probe details.

portProbeAction_blocked :: Lens' PortProbeAction (Maybe Bool) Source #

Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.

PortProbeDetail

portProbeDetail_remoteIpDetails :: Lens' PortProbeDetail (Maybe RemoteIpDetails) Source #

The remote IP information of the connection.

portProbeDetail_localIpDetails :: Lens' PortProbeDetail (Maybe LocalIpDetails) Source #

The local IP information of the connection.

portProbeDetail_localPortDetails :: Lens' PortProbeDetail (Maybe LocalPortDetails) Source #

The local port information of the connection.

PrivateIpAddressDetails

ProductCode

productCode_code :: Lens' ProductCode (Maybe Text) Source #

The product code information.

PublicAccess

publicAccess_permissionConfiguration :: Lens' PublicAccess (Maybe PermissionConfiguration) Source #

Contains information about how permissions are configured for the S3 bucket.

publicAccess_effectivePermission :: Lens' PublicAccess (Maybe Text) Source #

Describes the effective permission on this bucket after factoring all attached policies.

RemoteIpDetails

remoteIpDetails_country :: Lens' RemoteIpDetails (Maybe Country) Source #

The country code of the remote IP address.

remoteIpDetails_city :: Lens' RemoteIpDetails (Maybe City) Source #

The city information of the remote IP address.

remoteIpDetails_ipAddressV4 :: Lens' RemoteIpDetails (Maybe Text) Source #

The IPv4 remote address of the connection.

remoteIpDetails_geoLocation :: Lens' RemoteIpDetails (Maybe GeoLocation) Source #

The location information of the remote IP address.

remoteIpDetails_organization :: Lens' RemoteIpDetails (Maybe Organization) Source #

The ISP organization information of the remote IP address.

RemotePortDetails

remotePortDetails_portName :: Lens' RemotePortDetails (Maybe Text) Source #

The port name of the remote connection.

remotePortDetails_port :: Lens' RemotePortDetails (Maybe Int) Source #

The port number of the remote connection.

Resource

resource_resourceType :: Lens' Resource (Maybe Text) Source #

The type of AWS resource.

resource_s3BucketDetails :: Lens' Resource (Maybe [S3BucketDetail]) Source #

Contains information on the S3 bucket.

resource_instanceDetails :: Lens' Resource (Maybe InstanceDetails) Source #

The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding.

resource_accessKeyDetails :: Lens' Resource (Maybe AccessKeyDetails) Source #

The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding.

S3BucketDetail

s3BucketDetail_arn :: Lens' S3BucketDetail (Maybe Text) Source #

The Amazon Resource Name (ARN) of the S3 bucket.

s3BucketDetail_createdAt :: Lens' S3BucketDetail (Maybe UTCTime) Source #

The date and time the bucket was created at.

s3BucketDetail_owner :: Lens' S3BucketDetail (Maybe Owner) Source #

The owner of the S3 bucket.

s3BucketDetail_name :: Lens' S3BucketDetail (Maybe Text) Source #

The name of the S3 bucket.

s3BucketDetail_defaultServerSideEncryption :: Lens' S3BucketDetail (Maybe DefaultServerSideEncryption) Source #

Describes the server side encryption method used in the S3 bucket.

s3BucketDetail_publicAccess :: Lens' S3BucketDetail (Maybe PublicAccess) Source #

Describes the public access policies that apply to the S3 bucket.

s3BucketDetail_type :: Lens' S3BucketDetail (Maybe Text) Source #

Describes whether the bucket is a source or destination bucket.

s3BucketDetail_tags :: Lens' S3BucketDetail (Maybe [Tag]) Source #

All tags attached to the S3 bucket

S3LogsConfiguration

s3LogsConfiguration_enable :: Lens' S3LogsConfiguration Bool Source #

The status of S3 data event logs as a data source.

S3LogsConfigurationResult

s3LogsConfigurationResult_status :: Lens' S3LogsConfigurationResult DataSourceStatus Source #

A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

SecurityGroup

securityGroup_groupId :: Lens' SecurityGroup (Maybe Text) Source #

The security group ID of the EC2 instance.

securityGroup_groupName :: Lens' SecurityGroup (Maybe Text) Source #

The security group name of the EC2 instance.

ServiceInfo

serviceInfo_count :: Lens' ServiceInfo (Maybe Int) Source #

The total count of the occurrences of this finding type.

serviceInfo_eventFirstSeen :: Lens' ServiceInfo (Maybe Text) Source #

The first-seen timestamp of the activity that prompted GuardDuty to generate this finding.

serviceInfo_action :: Lens' ServiceInfo (Maybe Action) Source #

Information about the activity that is described in a finding.

serviceInfo_detectorId :: Lens' ServiceInfo (Maybe Text) Source #

The detector ID for the GuardDuty service.

serviceInfo_serviceName :: Lens' ServiceInfo (Maybe Text) Source #

The name of the AWS service (GuardDuty) that generated a finding.

serviceInfo_userFeedback :: Lens' ServiceInfo (Maybe Text) Source #

Feedback that was submitted about the finding.

serviceInfo_evidence :: Lens' ServiceInfo (Maybe Evidence) Source #

An evidence object associated with the service.

serviceInfo_eventLastSeen :: Lens' ServiceInfo (Maybe Text) Source #

The last-seen timestamp of the activity that prompted GuardDuty to generate this finding.

serviceInfo_resourceRole :: Lens' ServiceInfo (Maybe Text) Source #

The resource role information for this finding.

serviceInfo_archived :: Lens' ServiceInfo (Maybe Bool) Source #

Indicates whether this finding is archived.

SortCriteria

sortCriteria_orderBy :: Lens' SortCriteria (Maybe OrderBy) Source #

The order by which the sorted findings are to be displayed.

sortCriteria_attributeName :: Lens' SortCriteria (Maybe Text) Source #

Represents the finding attribute (for example, accountId) to sort findings by.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

The EC2 instance tag value.

tag_key :: Lens' Tag (Maybe Text) Source #

The EC2 instance tag key.

ThreatIntelligenceDetail

threatIntelligenceDetail_threatNames :: Lens' ThreatIntelligenceDetail (Maybe [Text]) Source #

A list of names of the threats in the threat intelligence list that triggered the finding.

threatIntelligenceDetail_threatListName :: Lens' ThreatIntelligenceDetail (Maybe Text) Source #

The name of the threat intelligence list that triggered the finding.

Total

total_amount :: Lens' Total (Maybe Text) Source #

The total usage.

total_unit :: Lens' Total (Maybe Text) Source #

The currency unit that the amount is given in.

UnprocessedAccount

unprocessedAccount_result :: Lens' UnprocessedAccount Text Source #

A reason why the account hasn't been processed.

UsageAccountResult

usageAccountResult_accountId :: Lens' UsageAccountResult (Maybe Text) Source #

The Account ID that generated usage.

usageAccountResult_total :: Lens' UsageAccountResult (Maybe Total) Source #

Represents the total of usage for the Account ID.

UsageCriteria

usageCriteria_accountIds :: Lens' UsageCriteria (Maybe (NonEmpty Text)) Source #

The account IDs to aggregate usage statistics from.

usageCriteria_resources :: Lens' UsageCriteria (Maybe [Text]) Source #

The resources to aggregate usage statistics from. Only accepts exact resource names.

usageCriteria_dataSources :: Lens' UsageCriteria [DataSource] Source #

The data sources to aggregate usage statistics from.

UsageDataSourceResult

usageDataSourceResult_total :: Lens' UsageDataSourceResult (Maybe Total) Source #

Represents the total of usage for the specified data source.

UsageResourceResult

usageResourceResult_total :: Lens' UsageResourceResult (Maybe Total) Source #

Represents the sum total of usage for the specified resource type.

usageResourceResult_resource :: Lens' UsageResourceResult (Maybe Text) Source #

The AWS resource that generated usage.

UsageStatistics

usageStatistics_topResources :: Lens' UsageStatistics (Maybe [UsageResourceResult]) Source #

Lists the top 50 resources that have generated the most GuardDuty usage, in order from most to least expensive.

usageStatistics_sumByResource :: Lens' UsageStatistics (Maybe [UsageResourceResult]) Source #

The usage statistic sum organized by resource.

usageStatistics_sumByDataSource :: Lens' UsageStatistics (Maybe [UsageDataSourceResult]) Source #

The usage statistic sum organized by on data source.

usageStatistics_sumByAccount :: Lens' UsageStatistics (Maybe [UsageAccountResult]) Source #

The usage statistic sum organized by account ID.