{ "version":"2.0", "metadata":{ "apiVersion":"2017-11-28", "endpointPrefix":"guardduty", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"Amazon GuardDuty", "serviceId":"GuardDuty", "signatureVersion":"v4", "signingName":"guardduty", "uid":"guardduty-2017-11-28" }, "operations":{ "AcceptAdministratorInvitation":{ "name":"AcceptAdministratorInvitation", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/administrator", "responseCode":200 }, "input":{"shape":"AcceptAdministratorInvitationRequest"}, "output":{"shape":"AcceptAdministratorInvitationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "AcceptInvitation":{ "name":"AcceptInvitation", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/master", "responseCode":200 }, "input":{"shape":"AcceptInvitationRequest"}, "output":{"shape":"AcceptInvitationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

", "deprecated":true, "deprecatedMessage":"This operation is deprecated, use AcceptAdministratorInvitation instead" }, "ArchiveFindings":{ "name":"ArchiveFindings", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/findings/archive", "responseCode":200 }, "input":{"shape":"ArchiveFindingsRequest"}, "output":{"shape":"ArchiveFindingsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "CreateDetector":{ "name":"CreateDetector", "http":{ "method":"POST", "requestUri":"/detector", "responseCode":200 }, "input":{"shape":"CreateDetectorRequest"}, "output":{"shape":"CreateDetectorResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "CreateFilter":{ "name":"CreateFilter", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/filter", "responseCode":200 }, "input":{"shape":"CreateFilterRequest"}, "output":{"shape":"CreateFilterResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "CreateIPSet":{ "name":"CreateIPSet", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/ipset", "responseCode":200 }, "input":{"shape":"CreateIPSetRequest"}, "output":{"shape":"CreateIPSetResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "CreateMembers":{ "name":"CreateMembers", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member", "responseCode":200 }, "input":{"shape":"CreateMembersRequest"}, "output":{"shape":"CreateMembersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

As a delegated administrator, using `CreateMembers` will enable GuardDuty in the added member accounts, with the exception of the organization delegated administrator account. A delegated administrator must enable GuardDuty prior to being added as a member.

When you use CreateMembers as an Organizations delegated administrator, GuardDuty applies your organization's auto-enable settings to the member accounts in this request, irrespective of the accounts being new or existing members. For more information about the existing auto-enable settings for your organization, see DescribeOrganizationConfiguration.

If you are adding accounts by invitation, before using InviteMembers, use `CreateMembers` after GuardDuty has been enabled in potential member accounts.

If you disassociate a member from a GuardDuty delegated administrator, the member account details obtained from this API, including the associated email addresses, will be retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.

" }, "CreatePublishingDestination":{ "name":"CreatePublishingDestination", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/publishingDestination", "responseCode":200 }, "input":{"shape":"CreatePublishingDestinationRequest"}, "output":{"shape":"CreatePublishingDestinationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "CreateSampleFindings":{ "name":"CreateSampleFindings", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/findings/create", "responseCode":200 }, "input":{"shape":"CreateSampleFindingsRequest"}, "output":{"shape":"CreateSampleFindingsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "CreateThreatIntelSet":{ "name":"CreateThreatIntelSet", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/threatintelset", "responseCode":200 }, "input":{"shape":"CreateThreatIntelSetRequest"}, "output":{"shape":"CreateThreatIntelSetResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "DeclineInvitations":{ "name":"DeclineInvitations", "http":{ "method":"POST", "requestUri":"/invitation/decline", "responseCode":200 }, "input":{"shape":"DeclineInvitationsRequest"}, "output":{"shape":"DeclineInvitationsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "DeleteDetector":{ "name":"DeleteDetector", "http":{ "method":"DELETE", "requestUri":"/detector/{detectorId}", "responseCode":200 }, "input":{"shape":"DeleteDetectorRequest"}, "output":{"shape":"DeleteDetectorResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "DeleteFilter":{ "name":"DeleteFilter", "http":{ "method":"DELETE", "requestUri":"/detector/{detectorId}/filter/{filterName}", "responseCode":200 }, "input":{"shape":"DeleteFilterRequest"}, "output":{"shape":"DeleteFilterResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Deletes the filter specified by the filter name.

" }, "DeleteIPSet":{ "name":"DeleteIPSet", "http":{ "method":"DELETE", "requestUri":"/detector/{detectorId}/ipset/{ipSetId}", "responseCode":200 }, "input":{"shape":"DeleteIPSetRequest"}, "output":{"shape":"DeleteIPSetResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "DeleteInvitations":{ "name":"DeleteInvitations", "http":{ "method":"POST", "requestUri":"/invitation/delete", "responseCode":200 }, "input":{"shape":"DeleteInvitationsRequest"}, "output":{"shape":"DeleteInvitationsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "DeleteMembers":{ "name":"DeleteMembers", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member/delete", "responseCode":200 }, "input":{"shape":"DeleteMembersRequest"}, "output":{"shape":"DeleteMembersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

With `autoEnableOrganizationMembers` configuration for your organization set to `ALL`, you'll receive an error if you attempt to disable GuardDuty for a member account in your organization.

" }, "DeletePublishingDestination":{ "name":"DeletePublishingDestination", "http":{ "method":"DELETE", "requestUri":"/detector/{detectorId}/publishingDestination/{destinationId}", "responseCode":200 }, "input":{"shape":"DeletePublishingDestinationRequest"}, "output":{"shape":"DeletePublishingDestinationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Deletes the publishing definition with the specified `destinationId`.

" }, "DeleteThreatIntelSet":{ "name":"DeleteThreatIntelSet", "http":{ "method":"DELETE", "requestUri":"/detector/{detectorId}/threatintelset/{threatIntelSetId}", "responseCode":200 }, "input":{"shape":"DeleteThreatIntelSetRequest"}, "output":{"shape":"DeleteThreatIntelSetResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.

" }, "DescribeMalwareScans":{ "name":"DescribeMalwareScans", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/malware-scans", "responseCode":200 }, "input":{"shape":"DescribeMalwareScansRequest"}, "output":{"shape":"DescribeMalwareScansResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "DescribeOrganizationConfiguration":{ "name":"DescribeOrganizationConfiguration", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/admin", "responseCode":200 }, "input":{"shape":"DescribeOrganizationConfigurationRequest"}, "output":{"shape":"DescribeOrganizationConfigurationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "DescribePublishingDestination":{ "name":"DescribePublishingDestination", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/publishingDestination/{destinationId}", "responseCode":200 }, "input":{"shape":"DescribePublishingDestinationRequest"}, "output":{"shape":"DescribePublishingDestinationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "DisableOrganizationAdminAccount":{ "name":"DisableOrganizationAdminAccount", "http":{ "method":"POST", "requestUri":"/admin/disable", "responseCode":200 }, "input":{"shape":"DisableOrganizationAdminAccountRequest"}, "output":{"shape":"DisableOrganizationAdminAccountResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "DisassociateFromAdministratorAccount":{ "name":"DisassociateFromAdministratorAccount", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/administrator/disassociate", "responseCode":200 }, "input":{"shape":"DisassociateFromAdministratorAccountRequest"}, "output":{"shape":"DisassociateFromAdministratorAccountResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Disassociates the current GuardDuty member account from its administrator account.

When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.

With `autoEnableOrganizationMembers` configuration for your organization set to `ALL`, you'll receive an error if you attempt to disable GuardDuty in a member account.

" }, "DisassociateFromMasterAccount":{ "name":"DisassociateFromMasterAccount", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/master/disassociate", "responseCode":200 }, "input":{"shape":"DisassociateFromMasterAccountRequest"}, "output":{"shape":"DisassociateFromMasterAccountResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Disassociates the current GuardDuty member account from its administrator account.

When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.

", "deprecated":true, "deprecatedMessage":"This operation is deprecated, use DisassociateFromAdministratorAccount instead" }, "DisassociateMembers":{ "name":"DisassociateMembers", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member/disassociate", "responseCode":200 }, "input":{"shape":"DisassociateMembersRequest"}, "output":{"shape":"DisassociateMembersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated administrator must invoke the DeleteMembers API.

With `autoEnableOrganizationMembers` configuration for your organization set to `ALL`, you'll receive an error if you attempt to disassociate a member account before removing them from your organization.

" }, "EnableOrganizationAdminAccount":{ "name":"EnableOrganizationAdminAccount", "http":{ "method":"POST", "requestUri":"/admin/enable", "responseCode":200 }, "input":{"shape":"EnableOrganizationAdminAccountRequest"}, "output":{"shape":"EnableOrganizationAdminAccountResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "GetAdministratorAccount":{ "name":"GetAdministratorAccount", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/administrator", "responseCode":200 }, "input":{"shape":"GetAdministratorAccountRequest"}, "output":{"shape":"GetAdministratorAccountResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

If the organization's management account or a delegated administrator runs this API, it will return success (`HTTP 200`) but no content.

" }, "GetCoverageStatistics":{ "name":"GetCoverageStatistics", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/coverage/statistics", "responseCode":200 }, "input":{"shape":"GetCoverageStatisticsRequest"}, "output":{"shape":"GetCoverageStatisticsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "GetDetector":{ "name":"GetDetector", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}", "responseCode":200 }, "input":{"shape":"GetDetectorRequest"}, "output":{"shape":"GetDetectorResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Retrieves an Amazon GuardDuty detector specified by the detectorId.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "GetFilter":{ "name":"GetFilter", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/filter/{filterName}", "responseCode":200 }, "input":{"shape":"GetFilterRequest"}, "output":{"shape":"GetFilterResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "GetFindings":{ "name":"GetFindings", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/findings/get", "responseCode":200 }, "input":{"shape":"GetFindingsRequest"}, "output":{"shape":"GetFindingsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Describes Amazon GuardDuty findings specified by finding IDs.

" }, "GetFindingsStatistics":{ "name":"GetFindingsStatistics", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/findings/statistics", "responseCode":200 }, "input":{"shape":"GetFindingsStatisticsRequest"}, "output":{"shape":"GetFindingsStatisticsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Lists Amazon GuardDuty findings statistics for the specified detector ID.

" }, "GetIPSet":{ "name":"GetIPSet", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/ipset/{ipSetId}", "responseCode":200 }, "input":{"shape":"GetIPSetRequest"}, "output":{"shape":"GetIPSetResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Retrieves the IPSet specified by the `ipSetId`.

" }, "GetInvitationsCount":{ "name":"GetInvitationsCount", "http":{ "method":"GET", "requestUri":"/invitation/count", "responseCode":200 }, "input":{"shape":"GetInvitationsCountRequest"}, "output":{"shape":"GetInvitationsCountResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "GetMalwareScanSettings":{ "name":"GetMalwareScanSettings", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/malware-scan-settings", "responseCode":200 }, "input":{"shape":"GetMalwareScanSettingsRequest"}, "output":{"shape":"GetMalwareScanSettingsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Returns the details of the malware scan settings.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "GetMasterAccount":{ "name":"GetMasterAccount", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/master", "responseCode":200 }, "input":{"shape":"GetMasterAccountRequest"}, "output":{"shape":"GetMasterAccountResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

", "deprecated":true, "deprecatedMessage":"This operation is deprecated, use GetAdministratorAccount instead" }, "GetMemberDetectors":{ "name":"GetMemberDetectors", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member/detector/get", "responseCode":200 }, "input":{"shape":"GetMemberDetectorsRequest"}, "output":{"shape":"GetMemberDetectorsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "GetMembers":{ "name":"GetMembers", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member/get", "responseCode":200 }, "input":{"shape":"GetMembersRequest"}, "output":{"shape":"GetMembersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "GetOrganizationStatistics":{ "name":"GetOrganizationStatistics", "http":{ "method":"GET", "requestUri":"/organization/statistics", "responseCode":200 }, "output":{"shape":"GetOrganizationStatisticsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

When you create a new Amazon Web Services organization, it might take up to 24 hours to generate the statistics for the entire organization.

" }, "GetRemainingFreeTrialDays":{ "name":"GetRemainingFreeTrialDays", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/freeTrial/daysRemaining", "responseCode":200 }, "input":{"shape":"GetRemainingFreeTrialDaysRequest"}, "output":{"shape":"GetRemainingFreeTrialDaysResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "GetThreatIntelSet":{ "name":"GetThreatIntelSet", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/threatintelset/{threatIntelSetId}", "responseCode":200 }, "input":{"shape":"GetThreatIntelSetRequest"}, "output":{"shape":"GetThreatIntelSetResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

" }, "GetUsageStatistics":{ "name":"GetUsageStatistics", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/usage/statistics", "responseCode":200 }, "input":{"shape":"GetUsageStatisticsRequest"}, "output":{"shape":"GetUsageStatisticsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "InviteMembers":{ "name":"InviteMembers", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member/invite", "responseCode":200 }, "input":{"shape":"InviteMembersRequest"}, "output":{"shape":"InviteMembersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API to add accounts by invitation. The invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can choose to accept the invitation from only one Amazon Web Services account. For more information, see Managing GuardDuty accounts by invitation.

After the invite has been accepted and you choose to disassociate a member account (by using DisassociateMembers) from your account, the details of the member account obtained by invoking CreateMembers, including the associated email addresses, will be retained. This is done so that you can invoke InviteMembers without the need to invoke CreateMembers again. To remove the details associated with a member account, you must also invoke DeleteMembers.

" }, "ListCoverage":{ "name":"ListCoverage", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/coverage", "responseCode":200 }, "input":{"shape":"ListCoverageRequest"}, "output":{"shape":"ListCoverageResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their resources.

" }, "ListDetectors":{ "name":"ListDetectors", "http":{ "method":"GET", "requestUri":"/detector", "responseCode":200 }, "input":{"shape":"ListDetectorsRequest"}, "output":{"shape":"ListDetectorsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

" }, "ListFilters":{ "name":"ListFilters", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/filter", "responseCode":200 }, "input":{"shape":"ListFiltersRequest"}, "output":{"shape":"ListFiltersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Returns a paginated list of the current filters.

" }, "ListFindings":{ "name":"ListFindings", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/findings", "responseCode":200 }, "input":{"shape":"ListFindingsRequest"}, "output":{"shape":"ListFindingsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Lists Amazon GuardDuty findings for the specified detector ID.

" }, "ListIPSets":{ "name":"ListIPSets", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/ipset", "responseCode":200 }, "input":{"shape":"ListIPSetsRequest"}, "output":{"shape":"ListIPSetsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "ListInvitations":{ "name":"ListInvitations", "http":{ "method":"GET", "requestUri":"/invitation", "responseCode":200 }, "input":{"shape":"ListInvitationsRequest"}, "output":{"shape":"ListInvitationsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "ListMembers":{ "name":"ListMembers", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/member", "responseCode":200 }, "input":{"shape":"ListMembersRequest"}, "output":{"shape":"ListMembersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "ListOrganizationAdminAccounts":{ "name":"ListOrganizationAdminAccounts", "http":{ "method":"GET", "requestUri":"/admin", "responseCode":200 }, "input":{"shape":"ListOrganizationAdminAccountsRequest"}, "output":{"shape":"ListOrganizationAdminAccountsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "ListPublishingDestinations":{ "name":"ListPublishingDestinations", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/publishingDestination", "responseCode":200 }, "input":{"shape":"ListPublishingDestinationsRequest"}, "output":{"shape":"ListPublishingDestinationsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "ListThreatIntelSets":{ "name":"ListThreatIntelSets", "http":{ "method":"GET", "requestUri":"/detector/{detectorId}/threatintelset", "responseCode":200 }, "input":{"shape":"ListThreatIntelSetsRequest"}, "output":{"shape":"ListThreatIntelSetsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "StartMalwareScan":{ "name":"StartMalwareScan", "http":{ "method":"POST", "requestUri":"/malware-scan/start", "responseCode":200 }, "input":{"shape":"StartMalwareScanRequest"}, "output":{"shape":"StartMalwareScanResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

" }, "StartMonitoringMembers":{ "name":"StartMonitoringMembers", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member/start", "responseCode":200 }, "input":{"shape":"StartMonitoringMembersRequest"}, "output":{"shape":"StartMonitoringMembersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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.

" }, "StopMonitoringMembers":{ "name":"StopMonitoringMembers", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member/stop", "responseCode":200 }, "input":{"shape":"StopMonitoringMembersRequest"}, "output":{"shape":"StopMonitoringMembersResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

With `autoEnableOrganizationMembers` configuration for your organization set to `ALL`, you'll receive an error if you attempt to stop monitoring the member accounts in your organization.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Adds tags to a resource.

" }, "UnarchiveFindings":{ "name":"UnarchiveFindings", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/findings/unarchive", "responseCode":200 }, "input":{"shape":"UnarchiveFindingsRequest"}, "output":{"shape":"UnarchiveFindingsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Unarchives GuardDuty findings specified by the `findingIds`.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Removes tags from a resource.

" }, "UpdateDetector":{ "name":"UpdateDetector", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}", "responseCode":200 }, "input":{"shape":"UpdateDetectorRequest"}, "output":{"shape":"UpdateDetectorResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Updates the Amazon GuardDuty detector specified by the detectorId.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "UpdateFilter":{ "name":"UpdateFilter", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/filter/{filterName}", "responseCode":200 }, "input":{"shape":"UpdateFilterRequest"}, "output":{"shape":"UpdateFilterResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Updates the filter specified by the filter name.

" }, "UpdateFindingsFeedback":{ "name":"UpdateFindingsFeedback", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/findings/feedback", "responseCode":200 }, "input":{"shape":"UpdateFindingsFeedbackRequest"}, "output":{"shape":"UpdateFindingsFeedbackResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Marks the specified GuardDuty findings as useful or not useful.

" }, "UpdateIPSet":{ "name":"UpdateIPSet", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/ipset/{ipSetId}", "responseCode":200 }, "input":{"shape":"UpdateIPSetRequest"}, "output":{"shape":"UpdateIPSetResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Updates the IPSet specified by the IPSet ID.

" }, "UpdateMalwareScanSettings":{ "name":"UpdateMalwareScanSettings", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/malware-scan-settings", "responseCode":200 }, "input":{"shape":"UpdateMalwareScanSettingsRequest"}, "output":{"shape":"UpdateMalwareScanSettingsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Updates the malware scan settings.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "UpdateMemberDetectors":{ "name":"UpdateMemberDetectors", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/member/detector/update", "responseCode":200 }, "input":{"shape":"UpdateMemberDetectorsRequest"}, "output":{"shape":"UpdateMemberDetectorsResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Contains information on member accounts to be updated.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "UpdateOrganizationConfiguration":{ "name":"UpdateOrganizationConfiguration", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/admin", "responseCode":200 }, "input":{"shape":"UpdateOrganizationConfigurationRequest"}, "output":{"shape":"UpdateOrganizationConfigurationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

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

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

" }, "UpdatePublishingDestination":{ "name":"UpdatePublishingDestination", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/publishingDestination/{destinationId}", "responseCode":200 }, "input":{"shape":"UpdatePublishingDestinationRequest"}, "output":{"shape":"UpdatePublishingDestinationResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Updates information about the publishing destination specified by the `destinationId`.

" }, "UpdateThreatIntelSet":{ "name":"UpdateThreatIntelSet", "http":{ "method":"POST", "requestUri":"/detector/{detectorId}/threatintelset/{threatIntelSetId}", "responseCode":200 }, "input":{"shape":"UpdateThreatIntelSetRequest"}, "output":{"shape":"UpdateThreatIntelSetResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"InternalServerErrorException"} ], "documentation":"

Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

" } }, "shapes":{ "AcceptAdministratorInvitationRequest":{ "type":"structure", "required":[ "DetectorId", "AdministratorId", "InvitationId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AdministratorId":{ "shape":"String", "documentation":"

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

", "locationName":"administratorId" }, "InvitationId":{ "shape":"String", "documentation":"

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

", "locationName":"invitationId" } } }, "AcceptAdministratorInvitationResponse":{ "type":"structure", "members":{ } }, "AcceptInvitationRequest":{ "type":"structure", "required":[ "DetectorId", "MasterId", "InvitationId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "MasterId":{ "shape":"String", "documentation":"

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

", "locationName":"masterId" }, "InvitationId":{ "shape":"String", "documentation":"

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

", "locationName":"invitationId" } }, "deprecated":true, "deprecatedMessage":"This input is deprecated, use AcceptAdministratorInvitationRequest instead" }, "AcceptInvitationResponse":{ "type":"structure", "members":{ }, "deprecated":true, "deprecatedMessage":"This output is deprecated, use AcceptAdministratorInvitationResponse instead" }, "AccessControlList":{ "type":"structure", "members":{ "AllowsPublicReadAccess":{ "shape":"Boolean", "documentation":"

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

", "locationName":"allowsPublicReadAccess" }, "AllowsPublicWriteAccess":{ "shape":"Boolean", "documentation":"

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

", "locationName":"allowsPublicWriteAccess" } }, "documentation":"

Contains information on the current access control policies for the bucket.

" }, "AccessDeniedException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" }, "Type":{ "shape":"String", "documentation":"

The error type.

", "locationName":"__type" } }, "documentation":"

An access denied exception object.

", "error":{"httpStatusCode":403}, "exception":true }, "AccessKeyDetails":{ "type":"structure", "members":{ "AccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the user.

", "locationName":"accessKeyId" }, "PrincipalId":{ "shape":"String", "documentation":"

The principal ID of the user.

", "locationName":"principalId" }, "UserName":{ "shape":"String", "documentation":"

The name of the user.

", "locationName":"userName" }, "UserType":{ "shape":"String", "documentation":"

The type of the user.

", "locationName":"userType" } }, "documentation":"

Contains information about the access keys.

" }, "AccountDetail":{ "type":"structure", "required":[ "AccountId", "Email" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The member account ID.

", "locationName":"accountId" }, "Email":{ "shape":"Email", "documentation":"

The email address of the member account.

", "locationName":"email" } }, "documentation":"

Contains information about the account.

" }, "AccountDetails":{ "type":"list", "member":{"shape":"AccountDetail"}, "max":50, "min":1 }, "AccountFreeTrialInfo":{ "type":"structure", "members":{ "AccountId":{ "shape":"String", "documentation":"

The account identifier of the GuardDuty member account.

", "locationName":"accountId" }, "DataSources":{ "shape":"DataSourcesFreeTrial", "documentation":"

Describes the data source enabled for the GuardDuty member account.

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Features":{ "shape":"FreeTrialFeatureConfigurationsResults", "documentation":"

A list of features enabled for the GuardDuty account.

", "locationName":"features" } }, "documentation":"

Provides details of the GuardDuty member account that uses a free trial service.

" }, "AccountFreeTrialInfos":{ "type":"list", "member":{"shape":"AccountFreeTrialInfo"} }, "AccountId":{ "type":"string", "max":12, "min":12 }, "AccountIds":{ "type":"list", "member":{"shape":"AccountId"}, "max":50, "min":1 }, "AccountLevelPermissions":{ "type":"structure", "members":{ "BlockPublicAccess":{ "shape":"BlockPublicAccess", "documentation":"

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

", "locationName":"blockPublicAccess" } }, "documentation":"

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

" }, "Action":{ "type":"structure", "members":{ "ActionType":{ "shape":"String", "documentation":"

The GuardDuty finding activity type.

", "locationName":"actionType" }, "AwsApiCallAction":{ "shape":"AwsApiCallAction", "documentation":"

Information about the AWS_API_CALL action described in this finding.

", "locationName":"awsApiCallAction" }, "DnsRequestAction":{ "shape":"DnsRequestAction", "documentation":"

Information about the DNS_REQUEST action described in this finding.

", "locationName":"dnsRequestAction" }, "NetworkConnectionAction":{ "shape":"NetworkConnectionAction", "documentation":"

Information about the NETWORK_CONNECTION action described in this finding.

", "locationName":"networkConnectionAction" }, "PortProbeAction":{ "shape":"PortProbeAction", "documentation":"

Information about the PORT_PROBE action described in this finding.

", "locationName":"portProbeAction" }, "KubernetesApiCallAction":{ "shape":"KubernetesApiCallAction", "documentation":"

Information about the Kubernetes API call action described in this finding.

", "locationName":"kubernetesApiCallAction" }, "RdsLoginAttemptAction":{ "shape":"RdsLoginAttemptAction", "documentation":"

Information about `RDS_LOGIN_ATTEMPT` action described in this finding.

", "locationName":"rdsLoginAttemptAction" }, "KubernetesPermissionCheckedDetails":{ "shape":"KubernetesPermissionCheckedDetails", "documentation":"

Information whether the user has the permission to use a specific Kubernetes API.

", "locationName":"kubernetesPermissionCheckedDetails" }, "KubernetesRoleBindingDetails":{ "shape":"KubernetesRoleBindingDetails", "documentation":"

Information about the role binding that grants the permission defined in a Kubernetes role.

", "locationName":"kubernetesRoleBindingDetails" }, "KubernetesRoleDetails":{ "shape":"KubernetesRoleDetails", "documentation":"

Information about the Kubernetes role name and role type.

", "locationName":"kubernetesRoleDetails" } }, "documentation":"

Contains information about actions.

" }, "AddonDetails":{ "type":"structure", "members":{ "AddonVersion":{ "shape":"String", "documentation":"

Version of the installed EKS add-on.

", "locationName":"addonVersion" }, "AddonStatus":{ "shape":"String", "documentation":"

Status of the installed EKS add-on.

", "locationName":"addonStatus" } }, "documentation":"

Information about the installed EKS add-on (GuardDuty security agent).

" }, "AdminAccount":{ "type":"structure", "members":{ "AdminAccountId":{ "shape":"String", "documentation":"

The Amazon Web Services account ID for the account.

", "locationName":"adminAccountId" }, "AdminStatus":{ "shape":"AdminStatus", "documentation":"

Indicates whether the account is enabled as the delegated administrator.

", "locationName":"adminStatus" } }, "documentation":"

The account within the organization specified as the GuardDuty delegated administrator.

" }, "AdminAccounts":{ "type":"list", "member":{"shape":"AdminAccount"}, "max":1, "min":0 }, "AdminStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLE_IN_PROGRESS" ], "max":300, "min":1 }, "Administrator":{ "type":"structure", "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The ID of the account used as the administrator account.

", "locationName":"accountId" }, "InvitationId":{ "shape":"String", "documentation":"

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

", "locationName":"invitationId" }, "RelationshipStatus":{ "shape":"String", "documentation":"

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

", "locationName":"relationshipStatus" }, "InvitedAt":{ "shape":"String", "documentation":"

The timestamp when the invitation was sent.

", "locationName":"invitedAt" } }, "documentation":"

Contains information about the administrator account and invitation.

" }, "AffectedResources":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "AgentDetails":{ "type":"structure", "members":{ "Version":{ "shape":"String", "documentation":"

Version of the installed GuardDuty security agent.

", "locationName":"version" } }, "documentation":"

Information about the installed GuardDuty security agent.

" }, "Anomaly":{ "type":"structure", "members":{ "Profiles":{ "shape":"AnomalyProfiles", "documentation":"

Information about the types of profiles.

", "locationName":"profiles" }, "Unusual":{ "shape":"AnomalyUnusual", "documentation":"

Information about the behavior of the anomalies.

", "locationName":"unusual" } }, "documentation":"

Contains information about the anomalies.

" }, "AnomalyObject":{ "type":"structure", "members":{ "ProfileType":{ "shape":"ProfileType", "documentation":"

The type of behavior of the profile.

", "locationName":"profileType" }, "ProfileSubtype":{ "shape":"ProfileSubtype", "documentation":"

The frequency of the anomaly.

", "locationName":"profileSubtype" }, "Observations":{ "shape":"Observations", "documentation":"

The recorded value.

", "locationName":"observations" } }, "documentation":"

Contains information about the unusual anomalies.

" }, "AnomalyProfileFeatureObjects":{ "type":"list", "member":{"shape":"AnomalyObject"} }, "AnomalyProfileFeatures":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"AnomalyProfileFeatureObjects"} }, "AnomalyProfiles":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"AnomalyProfileFeatures"} }, "AnomalyUnusual":{ "type":"structure", "members":{ "Behavior":{ "shape":"Behavior", "documentation":"

The behavior of the anomalous activity that caused GuardDuty to generate the finding.

", "locationName":"behavior" } }, "documentation":"

Contains information about the behavior of the anomaly that is new to GuardDuty.

" }, "AnomalyUnusualBehaviorFeature":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"AnomalyObject"} }, "ArchiveFindingsRequest":{ "type":"structure", "required":[ "DetectorId", "FindingIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FindingIds":{ "shape":"FindingIds", "documentation":"

The IDs of the findings that you want to archive.

", "locationName":"findingIds" } } }, "ArchiveFindingsResponse":{ "type":"structure", "members":{ } }, "AutoEnableMembers":{ "type":"string", "enum":[ "NEW", "ALL", "NONE" ] }, "AwsApiCallAction":{ "type":"structure", "members":{ "Api":{ "shape":"String", "documentation":"

The Amazon Web Services API name.

", "locationName":"api" }, "CallerType":{ "shape":"String", "documentation":"

The Amazon Web Services API caller type.

", "locationName":"callerType" }, "DomainDetails":{ "shape":"DomainDetails", "documentation":"

The domain information for the Amazon Web Services API call.

", "locationName":"domainDetails" }, "ErrorCode":{ "shape":"String", "documentation":"

The error code of the failed Amazon Web Services API action.

", "locationName":"errorCode" }, "UserAgent":{ "shape":"String", "documentation":"

The agent through which the API request was made.

", "locationName":"userAgent" }, "RemoteIpDetails":{ "shape":"RemoteIpDetails", "documentation":"

The remote IP information of the connection that initiated the Amazon Web Services API call.

", "locationName":"remoteIpDetails" }, "ServiceName":{ "shape":"String", "documentation":"

The Amazon Web Services service name whose API was invoked.

", "locationName":"serviceName" }, "RemoteAccountDetails":{ "shape":"RemoteAccountDetails", "documentation":"

The details of the Amazon Web Services account that made the API call. This field appears if the call was made from outside your account.

", "locationName":"remoteAccountDetails" }, "AffectedResources":{ "shape":"AffectedResources", "documentation":"

The details of the Amazon Web Services account that made the API call. This field identifies the resources that were affected by this API call.

", "locationName":"affectedResources" } }, "documentation":"

Contains information about the API action.

" }, "BadRequestException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" }, "Type":{ "shape":"String", "documentation":"

The error type.

", "locationName":"__type" } }, "documentation":"

A bad request exception object.

", "error":{"httpStatusCode":400}, "exception":true }, "Behavior":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"AnomalyUnusualBehaviorFeature"} }, "BlockPublicAccess":{ "type":"structure", "members":{ "IgnorePublicAcls":{ "shape":"Boolean", "documentation":"

Indicates if S3 Block Public Access is set to `IgnorePublicAcls`.

", "locationName":"ignorePublicAcls" }, "RestrictPublicBuckets":{ "shape":"Boolean", "documentation":"

Indicates if S3 Block Public Access is set to `RestrictPublicBuckets`.

", "locationName":"restrictPublicBuckets" }, "BlockPublicAcls":{ "shape":"Boolean", "documentation":"

Indicates if S3 Block Public Access is set to `BlockPublicAcls`.

", "locationName":"blockPublicAcls" }, "BlockPublicPolicy":{ "shape":"Boolean", "documentation":"

Indicates if S3 Block Public Access is set to `BlockPublicPolicy`.

", "locationName":"blockPublicPolicy" } }, "documentation":"

Contains information on how the bucker owner's S3 Block Public Access settings are being applied to the S3 bucket. See S3 Block Public Access for more information.

" }, "Boolean":{"type":"boolean"}, "BucketLevelPermissions":{ "type":"structure", "members":{ "AccessControlList":{ "shape":"AccessControlList", "documentation":"

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

", "locationName":"accessControlList" }, "BucketPolicy":{ "shape":"BucketPolicy", "documentation":"

Contains information on the bucket policies for the S3 bucket.

", "locationName":"bucketPolicy" }, "BlockPublicAccess":{ "shape":"BlockPublicAccess", "documentation":"

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

", "locationName":"blockPublicAccess" } }, "documentation":"

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

" }, "BucketPolicy":{ "type":"structure", "members":{ "AllowsPublicReadAccess":{ "shape":"Boolean", "documentation":"

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

", "locationName":"allowsPublicReadAccess" }, "AllowsPublicWriteAccess":{ "shape":"Boolean", "documentation":"

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

", "locationName":"allowsPublicWriteAccess" } }, "documentation":"

Contains information on the current bucket policies for the S3 bucket.

" }, "City":{ "type":"structure", "members":{ "CityName":{ "shape":"String", "documentation":"

The city name of the remote IP address.

", "locationName":"cityName" } }, "documentation":"

Contains information about the city associated with the IP address.

" }, "ClientToken":{ "type":"string", "max":64, "min":0 }, "CloudTrailConfigurationResult":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"DataSourceStatus", "documentation":"

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

", "locationName":"status" } }, "documentation":"

Contains information on the status of CloudTrail as a data source for the detector.

" }, "Condition":{ "type":"structure", "members":{ "Eq":{ "shape":"Eq", "documentation":"

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

", "deprecated":true, "locationName":"eq" }, "Neq":{ "shape":"Neq", "documentation":"

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

", "deprecated":true, "locationName":"neq" }, "Gt":{ "shape":"Integer", "documentation":"

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

", "deprecated":true, "locationName":"gt" }, "Gte":{ "shape":"Integer", "documentation":"

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

", "deprecated":true, "locationName":"gte" }, "Lt":{ "shape":"Integer", "documentation":"

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

", "deprecated":true, "locationName":"lt" }, "Lte":{ "shape":"Integer", "documentation":"

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

", "deprecated":true, "locationName":"lte" }, "Equals":{ "shape":"Equals", "documentation":"

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

", "locationName":"equals" }, "NotEquals":{ "shape":"NotEquals", "documentation":"

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

", "locationName":"notEquals" }, "GreaterThan":{ "shape":"Long", "documentation":"

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

", "locationName":"greaterThan" }, "GreaterThanOrEqual":{ "shape":"Long", "documentation":"

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

", "locationName":"greaterThanOrEqual" }, "LessThan":{ "shape":"Long", "documentation":"

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

", "locationName":"lessThan" }, "LessThanOrEqual":{ "shape":"Long", "documentation":"

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

", "locationName":"lessThanOrEqual" } }, "documentation":"

Contains information about the condition.

" }, "ConflictException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" }, "Type":{ "shape":"String", "documentation":"

The error type.

", "locationName":"__type" } }, "documentation":"

A request conflict exception object.

", "error":{"httpStatusCode":409}, "exception":true }, "Container":{ "type":"structure", "members":{ "ContainerRuntime":{ "shape":"String", "documentation":"

The container runtime (such as, Docker or containerd) used to run the container.

", "locationName":"containerRuntime" }, "Id":{ "shape":"String", "documentation":"

Container ID.

", "locationName":"id" }, "Name":{ "shape":"String", "documentation":"

Container name.

", "locationName":"name" }, "Image":{ "shape":"String", "documentation":"

Container image.

", "locationName":"image" }, "ImagePrefix":{ "shape":"String", "documentation":"

Part of the image name before the last slash. For example, imagePrefix for public.ecr.aws/amazonlinux/amazonlinux:latest would be public.ecr.aws/amazonlinux. If the image name is relative and does not have a slash, this field is empty.

", "locationName":"imagePrefix" }, "VolumeMounts":{ "shape":"VolumeMounts", "documentation":"

Container volume mounts.

", "locationName":"volumeMounts" }, "SecurityContext":{ "shape":"SecurityContext", "documentation":"

Container security context.

", "locationName":"securityContext" } }, "documentation":"

Details of a container.

" }, "ContainerInstanceDetails":{ "type":"structure", "members":{ "CoveredContainerInstances":{ "shape":"Long", "documentation":"

Represents the nodes in the Amazon ECS cluster that has a `HEALTHY` coverage status.

", "locationName":"coveredContainerInstances" }, "CompatibleContainerInstances":{ "shape":"Long", "documentation":"

Represents total number of nodes in the Amazon ECS cluster.

", "locationName":"compatibleContainerInstances" } }, "documentation":"

Contains information about the Amazon EC2 instance that is running the Amazon ECS container.

" }, "Containers":{ "type":"list", "member":{"shape":"Container"} }, "CountByCoverageStatus":{ "type":"map", "key":{"shape":"CoverageStatus"}, "value":{"shape":"Long"} }, "CountByResourceType":{ "type":"map", "key":{"shape":"ResourceType"}, "value":{"shape":"Long"} }, "CountBySeverity":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Integer"} }, "Country":{ "type":"structure", "members":{ "CountryCode":{ "shape":"String", "documentation":"

The country code of the remote IP address.

", "locationName":"countryCode" }, "CountryName":{ "shape":"String", "documentation":"

The country name of the remote IP address.

", "locationName":"countryName" } }, "documentation":"

Contains information about the country where the remote IP address is located.

" }, "CoverageEc2InstanceDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The Amazon EC2 instance ID.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type of the Amazon EC2 instance.

", "locationName":"instanceType" }, "ClusterArn":{ "shape":"String", "documentation":"

The cluster ARN of the Amazon ECS cluster running on the Amazon EC2 instance.

", "locationName":"clusterArn" }, "AgentDetails":{ "shape":"AgentDetails", "documentation":"

Information about the installed security agent.

", "locationName":"agentDetails" }, "ManagementType":{ "shape":"ManagementType", "documentation":"

Indicates how the GuardDuty security agent is managed for this resource.

- `AUTO_MANAGED` indicates that GuardDuty deploys and manages updates for this resource.

- `MANUAL` indicates that you are responsible to deploy, update, and manage the GuardDuty security agent updates for this resource.

The `DISABLED` status doesn't apply to Amazon EC2 instances and Amazon EKS clusters.

", "locationName":"managementType" } }, "documentation":"

This API is also used when you use GuardDuty Runtime Monitoring for your Amazon EC2 instances (currently in preview release) and is subject to change. The use of this API is subject to Section 2 of the Amazon Web Services Service Terms (\"Betas and Previews\").

Contains information about the Amazon EC2 instance runtime coverage details.

" }, "CoverageEcsClusterDetails":{ "type":"structure", "members":{ "ClusterName":{ "shape":"String", "documentation":"

The name of the Amazon ECS cluster.

", "locationName":"clusterName" }, "FargateDetails":{ "shape":"FargateDetails", "documentation":"

Information about the Fargate details associated with the Amazon ECS cluster.

", "locationName":"fargateDetails" }, "ContainerInstanceDetails":{ "shape":"ContainerInstanceDetails", "documentation":"

Information about the Amazon ECS container running on Amazon EC2 instance.

", "locationName":"containerInstanceDetails" } }, "documentation":"

Contains information about Amazon ECS cluster runtime coverage details.

" }, "CoverageEksClusterDetails":{ "type":"structure", "members":{ "ClusterName":{ "shape":"String", "documentation":"

Name of the EKS cluster.

", "locationName":"clusterName" }, "CoveredNodes":{ "shape":"Long", "documentation":"

Represents the nodes within the EKS cluster that have a `HEALTHY` coverage status.

", "locationName":"coveredNodes" }, "CompatibleNodes":{ "shape":"Long", "documentation":"

Represents all the nodes within the EKS cluster in your account.

", "locationName":"compatibleNodes" }, "AddonDetails":{ "shape":"AddonDetails", "documentation":"

Information about the installed EKS add-on.

", "locationName":"addonDetails" }, "ManagementType":{ "shape":"ManagementType", "documentation":"

Indicates how the Amazon EKS add-on GuardDuty agent is managed for this EKS cluster.

`AUTO_MANAGED` indicates GuardDuty deploys and manages updates for this resource.

`MANUAL` indicates that you are responsible to deploy, update, and manage the Amazon EKS add-on GuardDuty agent for this resource.

", "locationName":"managementType" } }, "documentation":"

Information about the EKS cluster that has a coverage status.

" }, "CoverageFilterCondition":{ "type":"structure", "members":{ "Equals":{ "shape":"Equals", "documentation":"

Represents an equal condition that is applied to a single field while retrieving the coverage details.

", "locationName":"equals" }, "NotEquals":{ "shape":"NotEquals", "documentation":"

Represents a not equal condition that is applied to a single field while retrieving the coverage details.

", "locationName":"notEquals" } }, "documentation":"

Represents a condition that when matched will be added to the response of the operation.

" }, "CoverageFilterCriteria":{ "type":"structure", "members":{ "FilterCriterion":{ "shape":"CoverageFilterCriterionList", "documentation":"

Represents a condition that when matched will be added to the response of the operation.

", "locationName":"filterCriterion" } }, "documentation":"

Represents the criteria used in the filter.

" }, "CoverageFilterCriterion":{ "type":"structure", "members":{ "CriterionKey":{ "shape":"CoverageFilterCriterionKey", "documentation":"

An enum value representing possible filter fields.

Replace the enum value `CLUSTER_NAME` with `EKS_CLUSTER_NAME`. `CLUSTER_NAME` has been deprecated.

", "locationName":"criterionKey" }, "FilterCondition":{ "shape":"CoverageFilterCondition", "documentation":"

Contains information about the condition.

", "locationName":"filterCondition" } }, "documentation":"

Represents a condition that when matched will be added to the response of the operation.

" }, "CoverageFilterCriterionKey":{ "type":"string", "enum":[ "ACCOUNT_ID", "CLUSTER_NAME", "RESOURCE_TYPE", "COVERAGE_STATUS", "ADDON_VERSION", "MANAGEMENT_TYPE", "EKS_CLUSTER_NAME", "ECS_CLUSTER_NAME", "AGENT_VERSION", "INSTANCE_ID", "CLUSTER_ARN" ] }, "CoverageFilterCriterionList":{ "type":"list", "member":{"shape":"CoverageFilterCriterion"}, "max":50, "min":0 }, "CoverageResource":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The unique ID of the resource.

", "locationName":"resourceId" }, "DetectorId":{ "shape":"DetectorId", "documentation":"

The unique ID of the GuardDuty detector associated with the resource.

", "locationName":"detectorId" }, "AccountId":{ "shape":"AccountId", "documentation":"

The unique ID of the Amazon Web Services account.

", "locationName":"accountId" }, "ResourceDetails":{ "shape":"CoverageResourceDetails", "documentation":"

Information about the resource for which the coverage statistics are retrieved.

", "locationName":"resourceDetails" }, "CoverageStatus":{ "shape":"CoverageStatus", "documentation":"

Represents the status of the EKS cluster coverage.

", "locationName":"coverageStatus" }, "Issue":{ "shape":"String", "documentation":"

Represents the reason why a coverage status was `UNHEALTHY` for the EKS cluster.

", "locationName":"issue" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp at which the coverage details for the resource were last updated. This is in UTC format.

", "locationName":"updatedAt" } }, "documentation":"

Information about the resource of the GuardDuty account.

" }, "CoverageResourceDetails":{ "type":"structure", "members":{ "EksClusterDetails":{ "shape":"CoverageEksClusterDetails", "documentation":"

EKS cluster details involved in the coverage statistics.

", "locationName":"eksClusterDetails" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The type of Amazon Web Services resource.

", "locationName":"resourceType" }, "EcsClusterDetails":{ "shape":"CoverageEcsClusterDetails", "documentation":"

Information about the Amazon ECS cluster that is assessed for runtime coverage.

", "locationName":"ecsClusterDetails" }, "Ec2InstanceDetails":{ "shape":"CoverageEc2InstanceDetails", "documentation":"

This API is also used when you use GuardDuty Runtime Monitoring for your Amazon EC2 instances (currently in preview release) and is subject to change. The use of this API is subject to Section 2 of the Amazon Web Services Service Terms (\"Betas and Previews\").

Information about the Amazon EC2 instance assessed for runtime coverage.

", "locationName":"ec2InstanceDetails" } }, "documentation":"

Information about the resource for each individual EKS cluster.

" }, "CoverageResources":{ "type":"list", "member":{"shape":"CoverageResource"} }, "CoverageSortCriteria":{ "type":"structure", "members":{ "AttributeName":{ "shape":"CoverageSortKey", "documentation":"

Represents the field name used to sort the coverage details.

Replace the enum value `CLUSTER_NAME` with `EKS_CLUSTER_NAME`. `CLUSTER_NAME` has been deprecated.

", "locationName":"attributeName" }, "OrderBy":{ "shape":"OrderBy", "documentation":"

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

", "locationName":"orderBy" } }, "documentation":"

Information about the sorting criteria used in the coverage statistics.

" }, "CoverageSortKey":{ "type":"string", "enum":[ "ACCOUNT_ID", "CLUSTER_NAME", "COVERAGE_STATUS", "ISSUE", "ADDON_VERSION", "UPDATED_AT", "EKS_CLUSTER_NAME", "ECS_CLUSTER_NAME", "INSTANCE_ID" ] }, "CoverageStatistics":{ "type":"structure", "members":{ "CountByResourceType":{ "shape":"CountByResourceType", "documentation":"

Represents coverage statistics for EKS clusters aggregated by resource type.

", "locationName":"countByResourceType" }, "CountByCoverageStatus":{ "shape":"CountByCoverageStatus", "documentation":"

Represents coverage statistics for EKS clusters aggregated by coverage status.

", "locationName":"countByCoverageStatus" } }, "documentation":"

Information about the coverage statistics for a resource.

" }, "CoverageStatisticsType":{ "type":"string", "enum":[ "COUNT_BY_RESOURCE_TYPE", "COUNT_BY_COVERAGE_STATUS" ] }, "CoverageStatisticsTypeList":{ "type":"list", "member":{"shape":"CoverageStatisticsType"} }, "CoverageStatus":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY" ] }, "CreateDetectorRequest":{ "type":"structure", "required":["Enable"], "members":{ "Enable":{ "shape":"Boolean", "documentation":"

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

", "locationName":"enable" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

The idempotency token for the create request.

", "idempotencyToken":true, "locationName":"clientToken" }, "FindingPublishingFrequency":{ "shape":"FindingPublishingFrequency", "documentation":"

A value that specifies how frequently updated findings are exported.

", "locationName":"findingPublishingFrequency" }, "DataSources":{ "shape":"DataSourceConfigurations", "documentation":"

Describes which data sources will be enabled for the detector.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags to be added to a new detector resource.

", "locationName":"tags" }, "Features":{ "shape":"DetectorFeatureConfigurations", "documentation":"

A list of features that will be configured for the detector.

", "locationName":"features" } } }, "CreateDetectorResponse":{ "type":"structure", "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The unique ID of the created detector.

", "locationName":"detectorId" }, "UnprocessedDataSources":{ "shape":"UnprocessedDataSourcesResult", "documentation":"

Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the first time.

", "locationName":"unprocessedDataSources" } } }, "CreateFilterRequest":{ "type":"structure", "required":[ "DetectorId", "Name", "FindingCriteria" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "Name":{ "shape":"FilterName", "documentation":"

The name of the filter. Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.

", "locationName":"name" }, "Description":{ "shape":"FilterDescription", "documentation":"

The description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses (`{ }`, `[ ]`, and `( )`), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.

", "locationName":"description" }, "Action":{ "shape":"FilterAction", "documentation":"

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

", "locationName":"action" }, "Rank":{ "shape":"FilterRank", "documentation":"

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.

", "locationName":"rank" }, "FindingCriteria":{ "shape":"FindingCriteria", "documentation":"

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

You can only use the following attributes to query findings:

- accountId

- id

- region

- severity

  To filter on the basis of severity, the API and CLI use the following input list for the FindingCriteria condition:

  - Low: `[\"1\", \"2\", \"3\"]`

  - Medium: `[\"4\", \"5\", \"6\"]`

  - High: `[\"7\", \"8\", \"9\"]`

  For more information, see Severity levels for GuardDuty findings.

- 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.

- resource.accessKeyDetails.accessKeyId

- resource.accessKeyDetails.principalId

- resource.accessKeyDetails.userName

- resource.accessKeyDetails.userType

- resource.instanceDetails.iamInstanceProfile.id

- resource.instanceDetails.imageId

- resource.instanceDetails.instanceId

- resource.instanceDetails.tags.key

- resource.instanceDetails.tags.value

- 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.outpostArn

- resource.resourceType

- resource.s3BucketDetails.publicAccess.effectivePermissions

- resource.s3BucketDetails.name

- resource.s3BucketDetails.tags.key

- resource.s3BucketDetails.tags.value

- resource.s3BucketDetails.type

- 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.dnsRequestAction.domainWithSuffix

- 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.action.awsApiCallAction.remoteAccountDetails.affiliated

- service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4

- service.action.kubernetesApiCallAction.namespace

- service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn

- service.action.kubernetesApiCallAction.requestUri

- service.action.kubernetesApiCallAction.statusCode

- service.action.networkConnectionAction.localIpDetails.ipAddressV4

- service.action.networkConnectionAction.protocol

- service.action.awsApiCallAction.serviceName

- service.action.awsApiCallAction.remoteAccountDetails.accountId

- service.additionalInfo.threatListName

- service.resourceRole

- resource.eksClusterDetails.name

- resource.kubernetesDetails.kubernetesWorkloadDetails.name

- resource.kubernetesDetails.kubernetesWorkloadDetails.namespace

- resource.kubernetesDetails.kubernetesUserDetails.username

- resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image

- resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix

- service.ebsVolumeScanDetails.scanId

- service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name

- service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity

- service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash

- resource.ecsClusterDetails.name

- resource.ecsClusterDetails.taskDetails.containers.image

- resource.ecsClusterDetails.taskDetails.definitionArn

- resource.containerDetails.image

- resource.rdsDbInstanceDetails.dbInstanceIdentifier

- resource.rdsDbInstanceDetails.dbClusterIdentifier

- resource.rdsDbInstanceDetails.engine

- resource.rdsDbUserDetails.user

- resource.rdsDbInstanceDetails.tags.key

- resource.rdsDbInstanceDetails.tags.value

- service.runtimeDetails.process.executableSha256

- service.runtimeDetails.process.name

- service.runtimeDetails.process.name

- resource.lambdaDetails.functionName

- resource.lambdaDetails.functionArn

- resource.lambdaDetails.tags.key

- resource.lambdaDetails.tags.value

", "locationName":"findingCriteria" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

The idempotency token for the create request.

", "idempotencyToken":true, "locationName":"clientToken" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags to be added to a new filter resource.

", "locationName":"tags" } } }, "CreateFilterResponse":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"FilterName", "documentation":"

The name of the successfully created filter.

", "locationName":"name" } } }, "CreateIPSetRequest":{ "type":"structure", "required":[ "DetectorId", "Name", "Format", "Location", "Activate" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "Name":{ "shape":"Name", "documentation":"

The user-friendly name to identify the IPSet.

Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

", "locationName":"name" }, "Format":{ "shape":"IpSetFormat", "documentation":"

The format of the file that contains the IPSet.

", "locationName":"format" }, "Location":{ "shape":"Location", "documentation":"

The URI of the file that contains the IPSet.

", "locationName":"location" }, "Activate":{ "shape":"Boolean", "documentation":"

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

", "locationName":"activate" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

The idempotency token for the create request.

", "idempotencyToken":true, "locationName":"clientToken" }, "Tags":{ "shape":"TagMap", "documentation":"

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

", "locationName":"tags" } } }, "CreateIPSetResponse":{ "type":"structure", "required":["IpSetId"], "members":{ "IpSetId":{ "shape":"String", "documentation":"

The ID of the IPSet resource.

", "locationName":"ipSetId" } } }, "CreateMembersRequest":{ "type":"structure", "required":[ "DetectorId", "AccountDetails" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AccountDetails":{ "shape":"AccountDetails", "documentation":"

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

", "locationName":"accountDetails" } } }, "CreateMembersResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "CreatePublishingDestinationRequest":{ "type":"structure", "required":[ "DetectorId", "DestinationType", "DestinationProperties" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "DestinationType":{ "shape":"DestinationType", "documentation":"

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

", "locationName":"destinationType" }, "DestinationProperties":{ "shape":"DestinationProperties", "documentation":"

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

", "locationName":"destinationProperties" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

The idempotency token for the request.

", "idempotencyToken":true, "locationName":"clientToken" } } }, "CreatePublishingDestinationResponse":{ "type":"structure", "required":["DestinationId"], "members":{ "DestinationId":{ "shape":"String", "documentation":"

The ID of the publishing destination that is created.

", "locationName":"destinationId" } } }, "CreateSampleFindingsRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The ID of the detector to create sample findings for.

", "location":"uri", "locationName":"detectorId" }, "FindingTypes":{ "shape":"FindingTypes", "documentation":"

The types of sample findings to generate.

", "locationName":"findingTypes" } } }, "CreateSampleFindingsResponse":{ "type":"structure", "members":{ } }, "CreateThreatIntelSetRequest":{ "type":"structure", "required":[ "DetectorId", "Name", "Format", "Location", "Activate" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "Name":{ "shape":"Name", "documentation":"

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

", "locationName":"name" }, "Format":{ "shape":"ThreatIntelSetFormat", "documentation":"

The format of the file that contains the ThreatIntelSet.

", "locationName":"format" }, "Location":{ "shape":"Location", "documentation":"

The URI of the file that contains the ThreatIntelSet.

", "locationName":"location" }, "Activate":{ "shape":"Boolean", "documentation":"

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

", "locationName":"activate" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

The idempotency token for the create request.

", "idempotencyToken":true, "locationName":"clientToken" }, "Tags":{ "shape":"TagMap", "documentation":"

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

", "locationName":"tags" } } }, "CreateThreatIntelSetResponse":{ "type":"structure", "required":["ThreatIntelSetId"], "members":{ "ThreatIntelSetId":{ "shape":"String", "documentation":"

The ID of the ThreatIntelSet resource.

", "locationName":"threatIntelSetId" } } }, "Criterion":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Condition"} }, "CriterionKey":{ "type":"string", "enum":[ "EC2_INSTANCE_ARN", "SCAN_ID", "ACCOUNT_ID", "GUARDDUTY_FINDING_ID", "SCAN_START_TIME", "SCAN_STATUS", "SCAN_TYPE" ] }, "DNSLogsConfigurationResult":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"DataSourceStatus", "documentation":"

Denotes whether DNS logs is enabled as a data source.

", "locationName":"status" } }, "documentation":"

Contains information on the status of DNS logs as a data source.

" }, "DataSource":{ "type":"string", "enum":[ "FLOW_LOGS", "CLOUD_TRAIL", "DNS_LOGS", "S3_LOGS", "KUBERNETES_AUDIT_LOGS", "EC2_MALWARE_SCAN" ] }, "DataSourceConfigurations":{ "type":"structure", "members":{ "S3Logs":{ "shape":"S3LogsConfiguration", "documentation":"

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

", "locationName":"s3Logs" }, "Kubernetes":{ "shape":"KubernetesConfiguration", "documentation":"

Describes whether any Kubernetes logs are enabled as data sources.

", "locationName":"kubernetes" }, "MalwareProtection":{ "shape":"MalwareProtectionConfiguration", "documentation":"

Describes whether Malware Protection is enabled as a data source.

", "locationName":"malwareProtection" } }, "documentation":"

Contains information about which data sources are enabled.

" }, "DataSourceConfigurationsResult":{ "type":"structure", "required":[ "CloudTrail", "DNSLogs", "FlowLogs", "S3Logs" ], "members":{ "CloudTrail":{ "shape":"CloudTrailConfigurationResult", "documentation":"

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

", "locationName":"cloudTrail" }, "DNSLogs":{ "shape":"DNSLogsConfigurationResult", "documentation":"

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

", "locationName":"dnsLogs" }, "FlowLogs":{ "shape":"FlowLogsConfigurationResult", "documentation":"

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

", "locationName":"flowLogs" }, "S3Logs":{ "shape":"S3LogsConfigurationResult", "documentation":"

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

", "locationName":"s3Logs" }, "Kubernetes":{ "shape":"KubernetesConfigurationResult", "documentation":"

An object that contains information on the status of all Kubernetes data sources.

", "locationName":"kubernetes" }, "MalwareProtection":{ "shape":"MalwareProtectionConfigurationResult", "documentation":"

Describes the configuration of Malware Protection data sources.

", "locationName":"malwareProtection" } }, "documentation":"

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

" }, "DataSourceFreeTrial":{ "type":"structure", "members":{ "FreeTrialDaysRemaining":{ "shape":"Integer", "documentation":"

A value that specifies the number of days left to use each enabled data source.

", "locationName":"freeTrialDaysRemaining" } }, "documentation":"

Contains information about which data sources are enabled for the GuardDuty member account.

" }, "DataSourceList":{ "type":"list", "member":{"shape":"DataSource"} }, "DataSourceStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ], "max":300, "min":1 }, "DataSourcesFreeTrial":{ "type":"structure", "members":{ "CloudTrail":{ "shape":"DataSourceFreeTrial", "documentation":"

Describes whether any Amazon Web Services CloudTrail management event logs are enabled as data sources.

", "locationName":"cloudTrail" }, "DnsLogs":{ "shape":"DataSourceFreeTrial", "documentation":"

Describes whether any DNS logs are enabled as data sources.

", "locationName":"dnsLogs" }, "FlowLogs":{ "shape":"DataSourceFreeTrial", "documentation":"

Describes whether any VPC Flow logs are enabled as data sources.

", "locationName":"flowLogs" }, "S3Logs":{ "shape":"DataSourceFreeTrial", "documentation":"

Describes whether any S3 data event logs are enabled as data sources.

", "locationName":"s3Logs" }, "Kubernetes":{ "shape":"KubernetesDataSourceFreeTrial", "documentation":"

Describes whether any Kubernetes logs are enabled as data sources.

", "locationName":"kubernetes" }, "MalwareProtection":{ "shape":"MalwareProtectionDataSourceFreeTrial", "documentation":"

Describes whether Malware Protection is enabled as a data source.

", "locationName":"malwareProtection" } }, "documentation":"

Contains information about which data sources are enabled for the GuardDuty member account.

" }, "DeclineInvitationsRequest":{ "type":"structure", "required":["AccountIds"], "members":{ "AccountIds":{ "shape":"AccountIds", "documentation":"

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

", "locationName":"accountIds" } } }, "DeclineInvitationsResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "DefaultServerSideEncryption":{ "type":"structure", "members":{ "EncryptionType":{ "shape":"String", "documentation":"

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

", "locationName":"encryptionType" }, "KmsMasterKeyArn":{ "shape":"String", "documentation":"

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

", "locationName":"kmsMasterKeyArn" } }, "documentation":"

Contains information on the server side encryption method used in the S3 bucket. See S3 Server-Side Encryption for more information.

" }, "DeleteDetectorRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" } } }, "DeleteDetectorResponse":{ "type":"structure", "members":{ } }, "DeleteFilterRequest":{ "type":"structure", "required":[ "DetectorId", "FilterName" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FilterName":{ "shape":"String", "documentation":"

The name of the filter that you want to delete.

", "location":"uri", "locationName":"filterName" } } }, "DeleteFilterResponse":{ "type":"structure", "members":{ } }, "DeleteIPSetRequest":{ "type":"structure", "required":[ "DetectorId", "IpSetId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The unique ID of the detector associated with the IPSet.

", "location":"uri", "locationName":"detectorId" }, "IpSetId":{ "shape":"String", "documentation":"

The unique ID of the IPSet to delete.

", "location":"uri", "locationName":"ipSetId" } } }, "DeleteIPSetResponse":{ "type":"structure", "members":{ } }, "DeleteInvitationsRequest":{ "type":"structure", "required":["AccountIds"], "members":{ "AccountIds":{ "shape":"AccountIds", "documentation":"

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

", "locationName":"accountIds" } } }, "DeleteInvitationsResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "DeleteMembersRequest":{ "type":"structure", "required":[ "DetectorId", "AccountIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

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

", "locationName":"accountIds" } } }, "DeleteMembersResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

The accounts that could not be processed.

", "locationName":"unprocessedAccounts" } } }, "DeletePublishingDestinationRequest":{ "type":"structure", "required":[ "DetectorId", "DestinationId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "DestinationId":{ "shape":"String", "documentation":"

The ID of the publishing destination to delete.

", "location":"uri", "locationName":"destinationId" } } }, "DeletePublishingDestinationResponse":{ "type":"structure", "members":{ } }, "DeleteThreatIntelSetRequest":{ "type":"structure", "required":[ "DetectorId", "ThreatIntelSetId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "ThreatIntelSetId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"threatIntelSetId" } } }, "DeleteThreatIntelSetResponse":{ "type":"structure", "members":{ } }, "DescribeMalwareScansRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"IntegerValueWithMax", "documentation":"

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.

", "locationName":"maxResults" }, "FilterCriteria":{ "shape":"FilterCriteria", "documentation":"

Represents the criteria to be used in the filter for describing scan entries.

", "locationName":"filterCriteria" }, "SortCriteria":{ "shape":"SortCriteria", "documentation":"

Represents the criteria used for sorting scan entries. The `attributeName` is required and it must be `scanStartTime`.

", "locationName":"sortCriteria" } } }, "DescribeMalwareScansResponse":{ "type":"structure", "required":["Scans"], "members":{ "Scans":{ "shape":"Scans", "documentation":"

Contains information about malware scans.

", "locationName":"scans" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "DescribeOrganizationConfigurationRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items that you want in the response.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "DescribeOrganizationConfigurationResponse":{ "type":"structure", "required":["MemberAccountLimitReached"], "members":{ "AutoEnable":{ "shape":"Boolean", "documentation":"

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

Even though this is still supported, we recommend using `AutoEnableOrganizationMembers` to achieve the similar results.

", "deprecated":true, "deprecatedMessage":"This field is deprecated, use AutoEnableOrganizationMembers instead", "locationName":"autoEnable" }, "MemberAccountLimitReached":{ "shape":"Boolean", "documentation":"

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

", "locationName":"memberAccountLimitReached" }, "DataSources":{ "shape":"OrganizationDataSourceConfigurationsResult", "documentation":"

Describes which data sources are enabled automatically for member accounts.

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Features":{ "shape":"OrganizationFeaturesConfigurationsResults", "documentation":"

A list of features that are configured for this organization.

", "locationName":"features" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" }, "AutoEnableOrganizationMembers":{ "shape":"AutoEnableMembers", "documentation":"

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization.

- `NEW`: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically.

- `ALL`: Indicates that all accounts in the organization have GuardDuty enabled automatically. This includes `NEW` accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

- `NONE`: Indicates that GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.

", "locationName":"autoEnableOrganizationMembers" } } }, "DescribePublishingDestinationRequest":{ "type":"structure", "required":[ "DetectorId", "DestinationId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "DestinationId":{ "shape":"String", "documentation":"

The ID of the publishing destination to retrieve.

", "location":"uri", "locationName":"destinationId" } } }, "DescribePublishingDestinationResponse":{ "type":"structure", "required":[ "DestinationId", "DestinationType", "Status", "PublishingFailureStartTimestamp", "DestinationProperties" ], "members":{ "DestinationId":{ "shape":"String", "documentation":"

The ID of the publishing destination.

", "locationName":"destinationId" }, "DestinationType":{ "shape":"DestinationType", "documentation":"

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

", "locationName":"destinationType" }, "Status":{ "shape":"PublishingStatus", "documentation":"

The status of the publishing destination.

", "locationName":"status" }, "PublishingFailureStartTimestamp":{ "shape":"Long", "documentation":"

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

", "locationName":"publishingFailureStartTimestamp" }, "DestinationProperties":{ "shape":"DestinationProperties", "documentation":"

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

", "locationName":"destinationProperties" } } }, "Destination":{ "type":"structure", "required":[ "DestinationId", "DestinationType", "Status" ], "members":{ "DestinationId":{ "shape":"String", "documentation":"

The unique ID of the publishing destination.

", "locationName":"destinationId" }, "DestinationType":{ "shape":"DestinationType", "documentation":"

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

", "locationName":"destinationType" }, "Status":{ "shape":"PublishingStatus", "documentation":"

The status of the publishing destination.

", "locationName":"status" } }, "documentation":"

Contains information about the publishing destination, including the ID, type, and status.

" }, "DestinationProperties":{ "type":"structure", "members":{ "DestinationArn":{ "shape":"String", "documentation":"

The ARN of the resource to publish to.

To specify an S3 bucket folder use the following format: `arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/`

", "locationName":"destinationArn" }, "KmsKeyArn":{ "shape":"String", "documentation":"

The ARN of the KMS key to use for encryption.

", "locationName":"kmsKeyArn" } }, "documentation":"

Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3 bucket, and the ARN of the KMS key to use to encrypt published findings.

" }, "DestinationType":{ "type":"string", "enum":["S3"], "max":300, "min":1 }, "Destinations":{ "type":"list", "member":{"shape":"Destination"} }, "Detection":{ "type":"structure", "members":{ "Anomaly":{ "shape":"Anomaly", "documentation":"

The details about the anomalous activity that caused GuardDuty to generate the finding.

", "locationName":"anomaly" } }, "documentation":"

Contains information about the detected behavior.

" }, "DetectorAdditionalConfiguration":{ "type":"structure", "members":{ "Name":{ "shape":"FeatureAdditionalConfiguration", "documentation":"

Name of the additional configuration.

", "locationName":"name" }, "Status":{ "shape":"FeatureStatus", "documentation":"

Status of the additional configuration.

", "locationName":"status" } }, "documentation":"

Information about the additional configuration for a feature in your GuardDuty account.

" }, "DetectorAdditionalConfigurationResult":{ "type":"structure", "members":{ "Name":{ "shape":"FeatureAdditionalConfiguration", "documentation":"

Name of the additional configuration.

", "locationName":"name" }, "Status":{ "shape":"FeatureStatus", "documentation":"

Status of the additional configuration.

", "locationName":"status" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp at which the additional configuration was last updated. This is in UTC format.

", "locationName":"updatedAt" } }, "documentation":"

Information about the additional configuration.

" }, "DetectorAdditionalConfigurationResults":{ "type":"list", "member":{"shape":"DetectorAdditionalConfigurationResult"} }, "DetectorAdditionalConfigurations":{ "type":"list", "member":{"shape":"DetectorAdditionalConfiguration"} }, "DetectorFeature":{ "type":"string", "enum":[ "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "EKS_RUNTIME_MONITORING", "LAMBDA_NETWORK_LOGS", "RUNTIME_MONITORING" ] }, "DetectorFeatureConfiguration":{ "type":"structure", "members":{ "Name":{ "shape":"DetectorFeature", "documentation":"

The name of the feature.

", "locationName":"name" }, "Status":{ "shape":"FeatureStatus", "documentation":"

The status of the feature.

", "locationName":"status" }, "AdditionalConfiguration":{ "shape":"DetectorAdditionalConfigurations", "documentation":"

Additional configuration for a resource.

", "locationName":"additionalConfiguration" } }, "documentation":"

Contains information about a GuardDuty feature.

" }, "DetectorFeatureConfigurationResult":{ "type":"structure", "members":{ "Name":{ "shape":"DetectorFeatureResult", "documentation":"

Indicates the name of the feature that can be enabled for the detector.

", "locationName":"name" }, "Status":{ "shape":"FeatureStatus", "documentation":"

Indicates the status of the feature that is enabled for the detector.

", "locationName":"status" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp at which the feature object was updated.

", "locationName":"updatedAt" }, "AdditionalConfiguration":{ "shape":"DetectorAdditionalConfigurationResults", "documentation":"

Additional configuration for a resource.

", "locationName":"additionalConfiguration" } }, "documentation":"

Contains information about a GuardDuty feature.

" }, "DetectorFeatureConfigurations":{ "type":"list", "member":{"shape":"DetectorFeatureConfiguration"} }, "DetectorFeatureConfigurationsResults":{ "type":"list", "member":{"shape":"DetectorFeatureConfigurationResult"} }, "DetectorFeatureResult":{ "type":"string", "enum":[ "FLOW_LOGS", "CLOUD_TRAIL", "DNS_LOGS", "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "EKS_RUNTIME_MONITORING", "LAMBDA_NETWORK_LOGS", "RUNTIME_MONITORING" ] }, "DetectorId":{ "type":"string", "max":300, "min":1 }, "DetectorIds":{ "type":"list", "member":{"shape":"DetectorId"}, "max":50, "min":0 }, "DetectorStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ], "max":300, "min":1 }, "DisableOrganizationAdminAccountRequest":{ "type":"structure", "required":["AdminAccountId"], "members":{ "AdminAccountId":{ "shape":"String", "documentation":"

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

", "locationName":"adminAccountId" } } }, "DisableOrganizationAdminAccountResponse":{ "type":"structure", "members":{ } }, "DisassociateFromAdministratorAccountRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" } } }, "DisassociateFromAdministratorAccountResponse":{ "type":"structure", "members":{ } }, "DisassociateFromMasterAccountRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" } }, "deprecated":true, "deprecatedMessage":"This input is deprecated, use DisassociateFromAdministratorAccountRequest instead" }, "DisassociateFromMasterAccountResponse":{ "type":"structure", "members":{ }, "deprecated":true, "deprecatedMessage":"This output is deprecated, use DisassociateFromAdministratorAccountResponse instead" }, "DisassociateMembersRequest":{ "type":"structure", "required":[ "DetectorId", "AccountIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

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

", "locationName":"accountIds" } } }, "DisassociateMembersResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "DnsRequestAction":{ "type":"structure", "members":{ "Domain":{ "shape":"String", "documentation":"

The domain information for the DNS query.

", "locationName":"domain" }, "Protocol":{ "shape":"String", "documentation":"

The network connection protocol observed in the activity that prompted GuardDuty to generate the finding.

", "locationName":"protocol" }, "Blocked":{ "shape":"Boolean", "documentation":"

Indicates whether the targeted port is blocked.

", "locationName":"blocked" }, "DomainWithSuffix":{ "shape":"String", "documentation":"

The second and top level domain involved in the activity that prompted GuardDuty to generate this finding.

", "locationName":"domainWithSuffix" } }, "documentation":"

Contains information about the DNS_REQUEST action described in this finding.

" }, "DomainDetails":{ "type":"structure", "members":{ "Domain":{ "shape":"String", "documentation":"

The domain information for the Amazon Web Services API call.

", "locationName":"domain" } }, "documentation":"

Contains information about the domain.

" }, "Double":{"type":"double"}, "EbsSnapshotPreservation":{ "type":"string", "enum":[ "NO_RETENTION", "RETENTION_WITH_FINDING" ] }, "EbsVolumeDetails":{ "type":"structure", "members":{ "ScannedVolumeDetails":{ "shape":"VolumeDetails", "documentation":"

List of EBS volumes that were scanned.

", "locationName":"scannedVolumeDetails" }, "SkippedVolumeDetails":{ "shape":"VolumeDetails", "documentation":"

List of EBS volumes that were skipped from the malware scan.

", "locationName":"skippedVolumeDetails" } }, "documentation":"

Contains list of scanned and skipped EBS volumes with details.

" }, "EbsVolumeScanDetails":{ "type":"structure", "members":{ "ScanId":{ "shape":"String", "documentation":"

Unique Id of the malware scan that generated the finding.

", "locationName":"scanId" }, "ScanStartedAt":{ "shape":"Timestamp", "documentation":"

Returns the start date and time of the malware scan.

", "locationName":"scanStartedAt" }, "ScanCompletedAt":{ "shape":"Timestamp", "documentation":"

Returns the completion date and time of the malware scan.

", "locationName":"scanCompletedAt" }, "TriggerFindingId":{ "shape":"String", "documentation":"

GuardDuty finding ID that triggered a malware scan.

", "locationName":"triggerFindingId" }, "Sources":{ "shape":"Sources", "documentation":"

Contains list of threat intelligence sources used to detect threats.

", "locationName":"sources" }, "ScanDetections":{ "shape":"ScanDetections", "documentation":"

Contains a complete view providing malware scan result details.

", "locationName":"scanDetections" }, "ScanType":{ "shape":"ScanType", "documentation":"

Specifies the scan type that invoked the malware scan.

", "locationName":"scanType" } }, "documentation":"

Contains details from the malware scan that created a finding.

" }, "EbsVolumesResult":{ "type":"structure", "members":{ "Status":{ "shape":"DataSourceStatus", "documentation":"

Describes whether scanning EBS volumes is enabled as a data source.

", "locationName":"status" }, "Reason":{ "shape":"String", "documentation":"

Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a data source.

", "locationName":"reason" } }, "documentation":"

Describes the configuration of scanning EBS volumes as a data source.

" }, "EcsClusterDetails":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the ECS Cluster.

", "locationName":"name" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the cluster.

", "locationName":"arn" }, "Status":{ "shape":"String", "documentation":"

The status of the ECS cluster.

", "locationName":"status" }, "ActiveServicesCount":{ "shape":"Integer", "documentation":"

The number of services that are running on the cluster in an ACTIVE state.

", "locationName":"activeServicesCount" }, "RegisteredContainerInstancesCount":{ "shape":"Integer", "documentation":"

The number of container instances registered into the cluster.

", "locationName":"registeredContainerInstancesCount" }, "RunningTasksCount":{ "shape":"Integer", "documentation":"

The number of tasks in the cluster that are in the RUNNING state.

", "locationName":"runningTasksCount" }, "Tags":{ "shape":"Tags", "documentation":"

The tags of the ECS Cluster.

", "locationName":"tags" }, "TaskDetails":{ "shape":"EcsTaskDetails", "documentation":"

Contains information about the details of the ECS Task.

", "locationName":"taskDetails" } }, "documentation":"

Contains information about the details of the ECS Cluster.

" }, "EcsTaskDetails":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task.

", "locationName":"arn" }, "DefinitionArn":{ "shape":"String", "documentation":"

The ARN of the task definition that creates the task.

", "locationName":"definitionArn" }, "Version":{ "shape":"String", "documentation":"

The version counter for the task.

", "locationName":"version" }, "TaskCreatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task was created.

", "locationName":"createdAt" }, "StartedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for the time when the task started.

", "locationName":"startedAt" }, "StartedBy":{ "shape":"String", "documentation":"

Contains the tag specified when a task is started.

", "locationName":"startedBy" }, "Tags":{ "shape":"Tags", "documentation":"

The tags of the ECS Task.

", "locationName":"tags" }, "Volumes":{ "shape":"Volumes", "documentation":"

The list of data volume definitions for the task.

", "locationName":"volumes" }, "Containers":{ "shape":"Containers", "documentation":"

The containers that's associated with the task.

", "locationName":"containers" }, "Group":{ "shape":"String", "documentation":"

The name of the task group that's associated with the task.

", "locationName":"group" } }, "documentation":"

Contains information about the task in an ECS cluster.

" }, "EksClusterDetails":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

EKS cluster name.

", "locationName":"name" }, "Arn":{ "shape":"String", "documentation":"

EKS cluster ARN.

", "locationName":"arn" }, "VpcId":{ "shape":"String", "documentation":"

The VPC ID to which the EKS cluster is attached.

", "locationName":"vpcId" }, "Status":{ "shape":"String", "documentation":"

The EKS cluster status.

", "locationName":"status" }, "Tags":{ "shape":"Tags", "documentation":"

The EKS cluster tags.

", "locationName":"tags" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp when the EKS cluster was created.

", "locationName":"createdAt" } }, "documentation":"

Details about the EKS cluster involved in a Kubernetes finding.

" }, "Email":{ "type":"string", "max":64, "min":1 }, "EnableOrganizationAdminAccountRequest":{ "type":"structure", "required":["AdminAccountId"], "members":{ "AdminAccountId":{ "shape":"String", "documentation":"

The Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated administrator.

", "locationName":"adminAccountId" } } }, "EnableOrganizationAdminAccountResponse":{ "type":"structure", "members":{ } }, "Eq":{ "type":"list", "member":{"shape":"String"} }, "Equals":{ "type":"list", "member":{"shape":"String"} }, "Evidence":{ "type":"structure", "members":{ "ThreatIntelligenceDetails":{ "shape":"ThreatIntelligenceDetails", "documentation":"

A list of threat intelligence details related to the evidence.

", "locationName":"threatIntelligenceDetails" } }, "documentation":"

Contains information about the reason that the finding was generated.

" }, "FargateDetails":{ "type":"structure", "members":{ "Issues":{ "shape":"Issues", "documentation":"

Runtime coverage issues identified for the resource running on Amazon Web Services Fargate.

", "locationName":"issues" }, "ManagementType":{ "shape":"ManagementType", "documentation":"

Indicates how the GuardDuty security agent is managed for this resource.

- `AUTO_MANAGED` indicates that GuardDuty deploys and manages updates for this resource.

- `DISABLED` indicates that the deployment of the GuardDuty security agent is disabled for this resource.

The `MANUAL` status doesn't apply to the Amazon Web Services Fargate (Amazon ECS only) woprkloads.

", "locationName":"managementType" } }, "documentation":"

Contains information about Amazon Web Services Fargate details associated with an Amazon ECS cluster.

" }, "FeatureAdditionalConfiguration":{ "type":"string", "enum":[ "EKS_ADDON_MANAGEMENT", "ECS_FARGATE_AGENT_MANAGEMENT" ] }, "FeatureStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "Feedback":{ "type":"string", "enum":[ "USEFUL", "NOT_USEFUL" ] }, "FilePaths":{ "type":"list", "member":{"shape":"ScanFilePath"} }, "FilterAction":{ "type":"string", "enum":[ "NOOP", "ARCHIVE" ], "max":300, "min":1 }, "FilterCondition":{ "type":"structure", "members":{ "EqualsValue":{ "shape":"NonEmptyString", "documentation":"

Represents an equal condition to be applied to a single field when querying for scan entries.

", "locationName":"equalsValue" }, "GreaterThan":{ "shape":"LongValue", "documentation":"

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

", "locationName":"greaterThan" }, "LessThan":{ "shape":"LongValue", "documentation":"

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

", "locationName":"lessThan" } }, "documentation":"

Contains information about the condition.

" }, "FilterCriteria":{ "type":"structure", "members":{ "FilterCriterion":{ "shape":"FilterCriterionList", "documentation":"

Represents a condition that when matched will be added to the response of the operation.

", "locationName":"filterCriterion" } }, "documentation":"

Represents the criteria to be used in the filter for describing scan entries.

" }, "FilterCriterion":{ "type":"structure", "members":{ "CriterionKey":{ "shape":"CriterionKey", "documentation":"

An enum value representing possible scan properties to match with given scan entries.

Replace the enum value `CLUSTER_NAME` with `EKS_CLUSTER_NAME`. `CLUSTER_NAME` has been deprecated.

", "locationName":"criterionKey" }, "FilterCondition":{ "shape":"FilterCondition", "documentation":"

Contains information about the condition.

", "locationName":"filterCondition" } }, "documentation":"

Represents a condition that when matched will be added to the response of the operation. Irrespective of using any filter criteria, an administrator account can view the scan entries for all of its member accounts. However, each member account can view the scan entries only for their own account.

" }, "FilterCriterionList":{ "type":"list", "member":{"shape":"FilterCriterion"}, "max":1, "min":0 }, "FilterDescription":{ "type":"string", "max":512, "min":0 }, "FilterName":{ "type":"string", "max":64, "min":3 }, "FilterNames":{ "type":"list", "member":{"shape":"FilterName"}, "max":50, "min":0 }, "FilterRank":{ "type":"integer", "max":100, "min":1 }, "Finding":{ "type":"structure", "required":[ "AccountId", "Arn", "CreatedAt", "Id", "Region", "Resource", "SchemaVersion", "Severity", "Type", "UpdatedAt" ], "members":{ "AccountId":{ "shape":"String", "documentation":"

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

", "locationName":"accountId" }, "Arn":{ "shape":"String", "documentation":"

The ARN of the finding.

", "locationName":"arn" }, "Confidence":{ "shape":"Double", "documentation":"

The confidence score for the finding.

", "locationName":"confidence" }, "CreatedAt":{ "shape":"String", "documentation":"

The time and date when the finding was created.

", "locationName":"createdAt" }, "Description":{ "shape":"String", "documentation":"

The description of the finding.

", "locationName":"description" }, "Id":{ "shape":"String", "documentation":"

The ID of the finding.

", "locationName":"id" }, "Partition":{ "shape":"String", "documentation":"

The partition associated with the finding.

", "locationName":"partition" }, "Region":{ "shape":"String", "documentation":"

The Region where the finding was generated.

", "locationName":"region" }, "Resource":{ "shape":"Resource", "locationName":"resource" }, "SchemaVersion":{ "shape":"String", "documentation":"

The version of the schema used for the finding.

", "locationName":"schemaVersion" }, "Service":{ "shape":"Service", "locationName":"service" }, "Severity":{ "shape":"Double", "documentation":"

The severity of the finding.

", "locationName":"severity" }, "Title":{ "shape":"String", "documentation":"

The title of the finding.

", "locationName":"title" }, "Type":{ "shape":"FindingType", "documentation":"

The type of finding.

", "locationName":"type" }, "UpdatedAt":{ "shape":"String", "documentation":"

The time and date when the finding was last updated.

", "locationName":"updatedAt" } }, "documentation":"

Contains information about the finding that is generated when abnormal or suspicious activity is detected.

" }, "FindingCriteria":{ "type":"structure", "members":{ "Criterion":{ "shape":"Criterion", "documentation":"

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

", "locationName":"criterion" } }, "documentation":"

Contains information about the criteria used for querying findings.

" }, "FindingId":{ "type":"string", "max":300, "min":1 }, "FindingIds":{ "type":"list", "member":{"shape":"FindingId"}, "max":50, "min":0 }, "FindingPublishingFrequency":{ "type":"string", "enum":[ "FIFTEEN_MINUTES", "ONE_HOUR", "SIX_HOURS" ] }, "FindingStatisticType":{ "type":"string", "enum":["COUNT_BY_SEVERITY"] }, "FindingStatisticTypes":{ "type":"list", "member":{"shape":"FindingStatisticType"}, "max":10, "min":0 }, "FindingStatistics":{ "type":"structure", "members":{ "CountBySeverity":{ "shape":"CountBySeverity", "documentation":"

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

", "locationName":"countBySeverity" } }, "documentation":"

Contains information about finding statistics.

" }, "FindingType":{ "type":"string", "max":50, "min":1 }, "FindingTypes":{ "type":"list", "member":{"shape":"FindingType"}, "max":50, "min":0 }, "Findings":{ "type":"list", "member":{"shape":"Finding"}, "max":50, "min":0 }, "FlagsList":{ "type":"list", "member":{"shape":"String"} }, "FlowLogsConfigurationResult":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"DataSourceStatus", "documentation":"

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

", "locationName":"status" } }, "documentation":"

Contains information on the status of VPC flow logs as a data source.

" }, "FreeTrialFeatureConfigurationResult":{ "type":"structure", "members":{ "Name":{ "shape":"FreeTrialFeatureResult", "documentation":"

The name of the feature for which the free trial is configured.

", "locationName":"name" }, "FreeTrialDaysRemaining":{ "shape":"Integer", "documentation":"

The number of the remaining free trial days for the feature.

", "locationName":"freeTrialDaysRemaining" } }, "documentation":"

Contains information about the free trial period for a feature.

" }, "FreeTrialFeatureConfigurationsResults":{ "type":"list", "member":{"shape":"FreeTrialFeatureConfigurationResult"} }, "FreeTrialFeatureResult":{ "type":"string", "enum":[ "FLOW_LOGS", "CLOUD_TRAIL", "DNS_LOGS", "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "EKS_RUNTIME_MONITORING", "LAMBDA_NETWORK_LOGS", "FARGATE_RUNTIME_MONITORING", "EC2_RUNTIME_MONITORING" ] }, "GeoLocation":{ "type":"structure", "members":{ "Lat":{ "shape":"Double", "documentation":"

The latitude information of the remote IP address.

", "locationName":"lat" }, "Lon":{ "shape":"Double", "documentation":"

The longitude information of the remote IP address.

", "locationName":"lon" } }, "documentation":"

Contains information about the location of the remote IP address.

" }, "GetAdministratorAccountRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" } } }, "GetAdministratorAccountResponse":{ "type":"structure", "required":["Administrator"], "members":{ "Administrator":{ "shape":"Administrator", "documentation":"

The administrator account details.

", "locationName":"administrator" } } }, "GetCoverageStatisticsRequest":{ "type":"structure", "required":[ "DetectorId", "StatisticsType" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The unique ID of the GuardDuty detector associated to the coverage statistics.

", "location":"uri", "locationName":"detectorId" }, "FilterCriteria":{ "shape":"CoverageFilterCriteria", "documentation":"

Represents the criteria used to filter the coverage statistics

", "locationName":"filterCriteria" }, "StatisticsType":{ "shape":"CoverageStatisticsTypeList", "documentation":"

Represents the statistics type used to aggregate the coverage details.

", "locationName":"statisticsType" } } }, "GetCoverageStatisticsResponse":{ "type":"structure", "members":{ "CoverageStatistics":{ "shape":"CoverageStatistics", "documentation":"

Represents the count aggregated by the `statusCode` and `resourceType`.

", "locationName":"coverageStatistics" } } }, "GetDetectorRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" } } }, "GetDetectorResponse":{ "type":"structure", "required":[ "ServiceRole", "Status" ], "members":{ "CreatedAt":{ "shape":"String", "documentation":"

The timestamp of when the detector was created.

", "locationName":"createdAt" }, "FindingPublishingFrequency":{ "shape":"FindingPublishingFrequency", "documentation":"

The publishing frequency of the finding.

", "locationName":"findingPublishingFrequency" }, "ServiceRole":{ "shape":"String", "documentation":"

The GuardDuty service role.

", "locationName":"serviceRole" }, "Status":{ "shape":"DetectorStatus", "documentation":"

The detector status.

", "locationName":"status" }, "UpdatedAt":{ "shape":"String", "documentation":"

The last-updated timestamp for the detector.

", "locationName":"updatedAt" }, "DataSources":{ "shape":"DataSourceConfigurationsResult", "documentation":"

Describes which data sources are enabled for the detector.

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags of the detector resource.

", "locationName":"tags" }, "Features":{ "shape":"DetectorFeatureConfigurationsResults", "documentation":"

Describes the features that have been enabled for the detector.

", "locationName":"features" } } }, "GetFilterRequest":{ "type":"structure", "required":[ "DetectorId", "FilterName" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FilterName":{ "shape":"String", "documentation":"

The name of the filter you want to get.

", "location":"uri", "locationName":"filterName" } } }, "GetFilterResponse":{ "type":"structure", "required":[ "Name", "Action", "FindingCriteria" ], "members":{ "Name":{ "shape":"FilterName", "documentation":"

The name of the filter.

", "locationName":"name" }, "Description":{ "shape":"FilterDescription", "documentation":"

The description of the filter.

", "locationName":"description" }, "Action":{ "shape":"FilterAction", "documentation":"

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

", "locationName":"action" }, "Rank":{ "shape":"FilterRank", "documentation":"

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.

", "locationName":"rank" }, "FindingCriteria":{ "shape":"FindingCriteria", "documentation":"

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

", "locationName":"findingCriteria" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags of the filter resource.

", "locationName":"tags" } } }, "GetFindingsRequest":{ "type":"structure", "required":[ "DetectorId", "FindingIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FindingIds":{ "shape":"FindingIds", "documentation":"

The IDs of the findings that you want to retrieve.

", "locationName":"findingIds" }, "SortCriteria":{ "shape":"SortCriteria", "documentation":"

Represents the criteria used for sorting findings.

", "locationName":"sortCriteria" } } }, "GetFindingsResponse":{ "type":"structure", "required":["Findings"], "members":{ "Findings":{ "shape":"Findings", "documentation":"

A list of findings.

", "locationName":"findings" } } }, "GetFindingsStatisticsRequest":{ "type":"structure", "required":[ "DetectorId", "FindingStatisticTypes" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FindingStatisticTypes":{ "shape":"FindingStatisticTypes", "documentation":"

The types of finding statistics to retrieve.

", "locationName":"findingStatisticTypes" }, "FindingCriteria":{ "shape":"FindingCriteria", "documentation":"

Represents the criteria that is used for querying findings.

", "locationName":"findingCriteria" } } }, "GetFindingsStatisticsResponse":{ "type":"structure", "required":["FindingStatistics"], "members":{ "FindingStatistics":{ "shape":"FindingStatistics", "documentation":"

The finding statistics object.

", "locationName":"findingStatistics" } } }, "GetIPSetRequest":{ "type":"structure", "required":[ "DetectorId", "IpSetId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "IpSetId":{ "shape":"String", "documentation":"

The unique ID of the IPSet to retrieve.

", "location":"uri", "locationName":"ipSetId" } } }, "GetIPSetResponse":{ "type":"structure", "required":[ "Name", "Format", "Location", "Status" ], "members":{ "Name":{ "shape":"Name", "documentation":"

The user-friendly name for the IPSet.

", "locationName":"name" }, "Format":{ "shape":"IpSetFormat", "documentation":"

The format of the file that contains the IPSet.

", "locationName":"format" }, "Location":{ "shape":"Location", "documentation":"

The URI of the file that contains the IPSet.

", "locationName":"location" }, "Status":{ "shape":"IpSetStatus", "documentation":"

The status of IPSet file that was uploaded.

", "locationName":"status" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags of the IPSet resource.

", "locationName":"tags" } } }, "GetInvitationsCountRequest":{ "type":"structure", "members":{ } }, "GetInvitationsCountResponse":{ "type":"structure", "members":{ "InvitationsCount":{ "shape":"Integer", "documentation":"

The number of received invitations.

", "locationName":"invitationsCount" } } }, "GetMalwareScanSettingsRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The unique ID of the detector that the scan setting is associated with.

", "location":"uri", "locationName":"detectorId" } } }, "GetMalwareScanSettingsResponse":{ "type":"structure", "members":{ "ScanResourceCriteria":{ "shape":"ScanResourceCriteria", "documentation":"

Represents the criteria to be used in the filter for scanning resources.

", "locationName":"scanResourceCriteria" }, "EbsSnapshotPreservation":{ "shape":"EbsSnapshotPreservation", "documentation":"

An enum value representing possible snapshot preservation settings.

", "locationName":"ebsSnapshotPreservation" } } }, "GetMasterAccountRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" } }, "deprecated":true, "deprecatedMessage":"This input is deprecated, use GetAdministratorAccountRequest instead" }, "GetMasterAccountResponse":{ "type":"structure", "required":["Master"], "members":{ "Master":{ "shape":"Master", "documentation":"

The administrator account details.

", "locationName":"master" } }, "deprecated":true, "deprecatedMessage":"This output is deprecated, use GetAdministratorAccountResponse instead" }, "GetMemberDetectorsRequest":{ "type":"structure", "required":[ "DetectorId", "AccountIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The detector ID for the administrator account.

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

The account ID of the member account.

", "locationName":"accountIds" } } }, "GetMemberDetectorsResponse":{ "type":"structure", "required":[ "MemberDataSourceConfigurations", "UnprocessedAccounts" ], "members":{ "MemberDataSourceConfigurations":{ "shape":"MemberDataSourceConfigurations", "documentation":"

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

", "locationName":"members" }, "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "GetMembersRequest":{ "type":"structure", "required":[ "DetectorId", "AccountIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

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

", "locationName":"accountIds" } } }, "GetMembersResponse":{ "type":"structure", "required":[ "Members", "UnprocessedAccounts" ], "members":{ "Members":{ "shape":"Members", "documentation":"

A list of members.

", "locationName":"members" }, "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "GetOrganizationStatisticsResponse":{ "type":"structure", "members":{ "OrganizationDetails":{ "shape":"OrganizationDetails", "documentation":"

Information about the statistics report for your organization.

", "locationName":"organizationDetails" } } }, "GetRemainingFreeTrialDaysRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

A list of account identifiers of the GuardDuty member account.

", "locationName":"accountIds" } } }, "GetRemainingFreeTrialDaysResponse":{ "type":"structure", "members":{ "Accounts":{ "shape":"AccountFreeTrialInfos", "documentation":"

The member accounts which were included in a request and were processed successfully.

", "locationName":"accounts" }, "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

The member account that was included in a request but for which the request could not be processed.

", "locationName":"unprocessedAccounts" } } }, "GetThreatIntelSetRequest":{ "type":"structure", "required":[ "DetectorId", "ThreatIntelSetId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "ThreatIntelSetId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"threatIntelSetId" } } }, "GetThreatIntelSetResponse":{ "type":"structure", "required":[ "Name", "Format", "Location", "Status" ], "members":{ "Name":{ "shape":"Name", "documentation":"

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

", "locationName":"name" }, "Format":{ "shape":"ThreatIntelSetFormat", "documentation":"

The format of the threatIntelSet.

", "locationName":"format" }, "Location":{ "shape":"Location", "documentation":"

The URI of the file that contains the ThreatIntelSet.

", "locationName":"location" }, "Status":{ "shape":"ThreatIntelSetStatus", "documentation":"

The status of threatIntelSet file uploaded.

", "locationName":"status" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags of the threat list resource.

", "locationName":"tags" } } }, "GetUsageStatisticsRequest":{ "type":"structure", "required":[ "DetectorId", "UsageStatisticType", "UsageCriteria" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "UsageStatisticType":{ "shape":"UsageStatisticType", "documentation":"

The type of usage statistics to retrieve.

", "locationName":"usageStatisticsType" }, "UsageCriteria":{ "shape":"UsageCriteria", "documentation":"

Represents the criteria used for querying usage.

", "locationName":"usageCriteria" }, "Unit":{ "shape":"String", "documentation":"

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

", "locationName":"unit" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in the response.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "locationName":"nextToken" } } }, "GetUsageStatisticsResponse":{ "type":"structure", "members":{ "UsageStatistics":{ "shape":"UsageStatistics", "documentation":"

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

", "locationName":"usageStatistics" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "Groups":{ "type":"list", "member":{"shape":"String"} }, "GuardDutyArn":{ "type":"string", "pattern":"^arn:[A-Za-z_.-]{1,20}:guardduty:[A-Za-z0-9_/.-]{0,63}:\\d+:detector/[A-Za-z0-9_/.-]{32,264}$" }, "HighestSeverityThreatDetails":{ "type":"structure", "members":{ "Severity":{ "shape":"String", "documentation":"

Severity level of the highest severity threat detected.

", "locationName":"severity" }, "ThreatName":{ "shape":"String", "documentation":"

Threat name of the highest severity threat detected as part of the malware scan.

", "locationName":"threatName" }, "Count":{ "shape":"Integer", "documentation":"

Total number of infected files with the highest severity threat detected.

", "locationName":"count" } }, "documentation":"

Contains details of the highest severity threat detected during scan and number of infected files.

" }, "HostPath":{ "type":"structure", "members":{ "Path":{ "shape":"String", "documentation":"

Path of the file or directory on the host that the volume maps to.

", "locationName":"path" } }, "documentation":"

Represents a pre-existing file or directory on the host machine that the volume maps to.

" }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The profile ARN of the EC2 instance.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The profile ID of the EC2 instance.

", "locationName":"id" } }, "documentation":"

Contains information about the EC2 instance profile.

" }, "ImpersonatedUser":{ "type":"structure", "members":{ "Username":{ "shape":"String", "documentation":"

Information about the `username` that was being impersonated.

", "locationName":"username" }, "Groups":{ "shape":"Groups", "documentation":"

The `group` to which the user name belongs.

", "locationName":"groups" } }, "documentation":"

Contains information about the impersonated user.

" }, "InstanceArn":{ "type":"string", "pattern":"^arn:(aws|aws-cn|aws-us-gov):[a-z]+:[a-z]+(-[0-9]+|-[a-z]+)+:([0-9]{12}):[a-z\\-]+\\/[a-zA-Z0-9]*$" }, "InstanceDetails":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the EC2 instance.

", "locationName":"availabilityZone" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The profile information of the EC2 instance.

", "locationName":"iamInstanceProfile" }, "ImageDescription":{ "shape":"String", "documentation":"

The image description of the EC2 instance.

", "locationName":"imageDescription" }, "ImageId":{ "shape":"String", "documentation":"

The image ID of the EC2 instance.

", "locationName":"imageId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the EC2 instance.

", "locationName":"instanceId" }, "InstanceState":{ "shape":"String", "documentation":"

The state of the EC2 instance.

", "locationName":"instanceState" }, "InstanceType":{ "shape":"String", "documentation":"

The type of the EC2 instance.

", "locationName":"instanceType" }, "OutpostArn":{ "shape":"String", "documentation":"

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

", "locationName":"outpostArn" }, "LaunchTime":{ "shape":"String", "documentation":"

The launch time of the EC2 instance.

", "locationName":"launchTime" }, "NetworkInterfaces":{ "shape":"NetworkInterfaces", "documentation":"

The elastic network interface information of the EC2 instance.

", "locationName":"networkInterfaces" }, "Platform":{ "shape":"String", "documentation":"

The platform of the EC2 instance.

", "locationName":"platform" }, "ProductCodes":{ "shape":"ProductCodes", "documentation":"

The product code of the EC2 instance.

", "locationName":"productCodes" }, "Tags":{ "shape":"Tags", "documentation":"

The tags of the EC2 instance.

", "locationName":"tags" } }, "documentation":"

Contains information about the details of an instance.

" }, "Integer":{"type":"integer"}, "IntegerValueWithMax":{ "type":"integer", "max":50, "min":1 }, "InternalServerErrorException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" }, "Type":{ "shape":"String", "documentation":"

The error type.

", "locationName":"__type" } }, "documentation":"

An internal server error exception object.

", "error":{"httpStatusCode":500}, "exception":true }, "Invitation":{ "type":"structure", "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

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

", "locationName":"accountId" }, "InvitationId":{ "shape":"String", "documentation":"

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

", "locationName":"invitationId" }, "RelationshipStatus":{ "shape":"String", "documentation":"

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

", "locationName":"relationshipStatus" }, "InvitedAt":{ "shape":"String", "documentation":"

The timestamp when the invitation was sent.

", "locationName":"invitedAt" } }, "documentation":"

Contains information about the invitation to become a member account.

" }, "Invitations":{ "type":"list", "member":{"shape":"Invitation"}, "max":50, "min":0 }, "InviteMembersRequest":{ "type":"structure", "required":[ "DetectorId", "AccountIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

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

", "locationName":"accountIds" }, "DisableEmailNotification":{ "shape":"Boolean", "documentation":"

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

", "locationName":"disableEmailNotification" }, "Message":{ "shape":"String", "documentation":"

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

", "locationName":"message" } } }, "InviteMembersResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "IpSetFormat":{ "type":"string", "enum":[ "TXT", "STIX", "OTX_CSV", "ALIEN_VAULT", "PROOF_POINT", "FIRE_EYE" ], "max":300, "min":1 }, "IpSetIds":{ "type":"list", "member":{"shape":"String"}, "max":50, "min":0 }, "IpSetStatus":{ "type":"string", "enum":[ "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "ERROR", "DELETE_PENDING", "DELETED" ], "max":300, "min":1 }, "Ipv6Addresses":{ "type":"list", "member":{"shape":"String"} }, "Issues":{ "type":"list", "member":{"shape":"String"}, "max":50, "min":0 }, "KubernetesApiCallAction":{ "type":"structure", "members":{ "RequestUri":{ "shape":"String", "documentation":"

The Kubernetes API request URI.

", "locationName":"requestUri" }, "Verb":{ "shape":"String", "documentation":"

The Kubernetes API request HTTP verb.

", "locationName":"verb" }, "SourceIps":{ "shape":"SourceIps", "documentation":"

The IP of the Kubernetes API caller and the IPs of any proxies or load balancers between the caller and the API endpoint.

", "locationName":"sourceIps" }, "UserAgent":{ "shape":"String", "documentation":"

The user agent of the caller of the Kubernetes API.

", "locationName":"userAgent" }, "RemoteIpDetails":{ "shape":"RemoteIpDetails", "locationName":"remoteIpDetails" }, "StatusCode":{ "shape":"Integer", "documentation":"

The resulting HTTP response code of the Kubernetes API call action.

", "locationName":"statusCode" }, "Parameters":{ "shape":"String", "documentation":"

Parameters related to the Kubernetes API call action.

", "locationName":"parameters" }, "Resource":{ "shape":"String", "documentation":"

The resource component in the Kubernetes API call action.

", "locationName":"resource" }, "Subresource":{ "shape":"String", "documentation":"

The name of the sub-resource in the Kubernetes API call action.

", "locationName":"subresource" }, "Namespace":{ "shape":"String", "documentation":"

The name of the namespace where the Kubernetes API call action takes place.

", "locationName":"namespace" }, "ResourceName":{ "shape":"String", "documentation":"

The name of the resource in the Kubernetes API call action.

", "locationName":"resourceName" } }, "documentation":"

Information about the Kubernetes API call action described in this finding.

" }, "KubernetesAuditLogsConfiguration":{ "type":"structure", "required":["Enable"], "members":{ "Enable":{ "shape":"Boolean", "documentation":"

The status of Kubernetes audit logs as a data source.

", "locationName":"enable" } }, "documentation":"

Describes whether Kubernetes audit logs are enabled as a data source.

" }, "KubernetesAuditLogsConfigurationResult":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"DataSourceStatus", "documentation":"

A value that describes whether Kubernetes audit logs are enabled as a data source.

", "locationName":"status" } }, "documentation":"

Describes whether Kubernetes audit logs are enabled as a data source.

" }, "KubernetesConfiguration":{ "type":"structure", "required":["AuditLogs"], "members":{ "AuditLogs":{ "shape":"KubernetesAuditLogsConfiguration", "documentation":"

The status of Kubernetes audit logs as a data source.

", "locationName":"auditLogs" } }, "documentation":"

Describes whether any Kubernetes data sources are enabled.

" }, "KubernetesConfigurationResult":{ "type":"structure", "required":["AuditLogs"], "members":{ "AuditLogs":{ "shape":"KubernetesAuditLogsConfigurationResult", "documentation":"

Describes whether Kubernetes audit logs are enabled as a data source.

", "locationName":"auditLogs" } }, "documentation":"

Describes whether any Kubernetes logs will be enabled as a data source.

" }, "KubernetesDataSourceFreeTrial":{ "type":"structure", "members":{ "AuditLogs":{ "shape":"DataSourceFreeTrial", "documentation":"

Describes whether Kubernetes audit logs are enabled as a data source.

", "locationName":"auditLogs" } }, "documentation":"

Provides details about the Kubernetes resources when it is enabled as a data source.

" }, "KubernetesDetails":{ "type":"structure", "members":{ "KubernetesUserDetails":{ "shape":"KubernetesUserDetails", "documentation":"

Details about the Kubernetes user involved in a Kubernetes finding.

", "locationName":"kubernetesUserDetails" }, "KubernetesWorkloadDetails":{ "shape":"KubernetesWorkloadDetails", "documentation":"

Details about the Kubernetes workload involved in a Kubernetes finding.

", "locationName":"kubernetesWorkloadDetails" } }, "documentation":"

Details about Kubernetes resources such as a Kubernetes user or workload resource involved in a Kubernetes finding.

" }, "KubernetesPermissionCheckedDetails":{ "type":"structure", "members":{ "Verb":{ "shape":"String", "documentation":"

The verb component of the Kubernetes API call. For example, when you check whether or not you have the permission to call the `CreatePod` API, the verb component will be `Create`.

", "locationName":"verb" }, "Resource":{ "shape":"String", "documentation":"

The Kubernetes resource with which your Kubernetes API call will interact.

", "locationName":"resource" }, "Namespace":{ "shape":"String", "documentation":"

The namespace where the Kubernetes API action will take place.

", "locationName":"namespace" }, "Allowed":{ "shape":"Boolean", "documentation":"

Information whether the user has the permission to call the Kubernetes API.

", "locationName":"allowed" } }, "documentation":"

Information about the Kubernetes API for which you check if you have permission to call.

" }, "KubernetesRoleBindingDetails":{ "type":"structure", "members":{ "Kind":{ "shape":"String", "documentation":"

The kind of the role. For role binding, this value will be `RoleBinding`.

", "locationName":"kind" }, "Name":{ "shape":"String", "documentation":"

The name of the `RoleBinding`.

", "locationName":"name" }, "Uid":{ "shape":"String", "documentation":"

The unique identifier of the role binding.

", "locationName":"uid" }, "RoleRefName":{ "shape":"String", "documentation":"

The name of the role being referenced. This must match the name of the `Role` or `ClusterRole` that you want to bind to.

", "locationName":"roleRefName" }, "RoleRefKind":{ "shape":"String", "documentation":"

The type of the role being referenced. This could be either `Role` or `ClusterRole`.

", "locationName":"roleRefKind" } }, "documentation":"

Contains information about the role binding that grants the permission defined in a Kubernetes role.

" }, "KubernetesRoleDetails":{ "type":"structure", "members":{ "Kind":{ "shape":"String", "documentation":"

The kind of role. For this API, the value of `kind` will be `Role`.

", "locationName":"kind" }, "Name":{ "shape":"String", "documentation":"

The name of the Kubernetes role.

", "locationName":"name" }, "Uid":{ "shape":"String", "documentation":"

The unique identifier of the Kubernetes role name.

", "locationName":"uid" } }, "documentation":"

Information about the Kubernetes role name and role type.

" }, "KubernetesUserDetails":{ "type":"structure", "members":{ "Username":{ "shape":"String", "documentation":"

The username of the user who called the Kubernetes API.

", "locationName":"username" }, "Uid":{ "shape":"String", "documentation":"

The user ID of the user who called the Kubernetes API.

", "locationName":"uid" }, "Groups":{ "shape":"Groups", "documentation":"

The groups that include the user who called the Kubernetes API.

", "locationName":"groups" }, "SessionName":{ "shape":"SessionNameList", "documentation":"

Entity that assumes the IAM role when Kubernetes RBAC permissions are assigned to that role.

", "locationName":"sessionName" }, "ImpersonatedUser":{ "shape":"ImpersonatedUser", "documentation":"

Information about the impersonated user.

", "locationName":"impersonatedUser" } }, "documentation":"

Details about the Kubernetes user involved in a Kubernetes finding.

" }, "KubernetesWorkloadDetails":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

Kubernetes workload name.

", "locationName":"name" }, "Type":{ "shape":"String", "documentation":"

Kubernetes workload type (e.g. Pod, Deployment, etc.).

", "locationName":"type" }, "Uid":{ "shape":"String", "documentation":"

Kubernetes workload ID.

", "locationName":"uid" }, "Namespace":{ "shape":"String", "documentation":"

Kubernetes namespace that the workload is part of.

", "locationName":"namespace" }, "HostNetwork":{ "shape":"Boolean", "documentation":"

Whether the hostNetwork flag is enabled for the pods included in the workload.

", "locationName":"hostNetwork" }, "Containers":{ "shape":"Containers", "documentation":"

Containers running as part of the Kubernetes workload.

", "locationName":"containers" }, "Volumes":{ "shape":"Volumes", "documentation":"

Volumes used by the Kubernetes workload.

", "locationName":"volumes" }, "ServiceAccountName":{ "shape":"String", "documentation":"

The service account name that is associated with a Kubernetes workload.

", "locationName":"serviceAccountName" }, "HostIPC":{ "shape":"Boolean", "documentation":"

Whether the host IPC flag is enabled for the pods in the workload.

", "locationName":"hostIPC" }, "HostPID":{ "shape":"Boolean", "documentation":"

Whether the host PID flag is enabled for the pods in the workload.

", "locationName":"hostPID" } }, "documentation":"

Details about the Kubernetes workload involved in a Kubernetes finding.

" }, "LambdaDetails":{ "type":"structure", "members":{ "FunctionArn":{ "shape":"String", "documentation":"

Amazon Resource Name (ARN) of the Lambda function.

", "locationName":"functionArn" }, "FunctionName":{ "shape":"String", "documentation":"

Name of the Lambda function.

", "locationName":"functionName" }, "Description":{ "shape":"String", "documentation":"

Description of the Lambda function.

", "locationName":"description" }, "LastModifiedAt":{ "shape":"Timestamp", "documentation":"

The timestamp when the Lambda function was last modified. This field is in the UTC date string format `(2023-03-22T19:37:20.168Z)`.

", "locationName":"lastModifiedAt" }, "RevisionId":{ "shape":"String", "documentation":"

The revision ID of the Lambda function version.

", "locationName":"revisionId" }, "FunctionVersion":{ "shape":"String", "documentation":"

The version of the Lambda function.

", "locationName":"functionVersion" }, "Role":{ "shape":"String", "documentation":"

The execution role of the Lambda function.

", "locationName":"role" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"

Amazon Virtual Private Cloud configuration details associated with your Lambda function.

", "locationName":"vpcConfig" }, "Tags":{ "shape":"Tags", "documentation":"

A list of tags attached to this resource, listed in the format of `key`:`value` pair.

", "locationName":"tags" } }, "documentation":"

Information about the Lambda function involved in the finding.

" }, "Lineage":{ "type":"list", "member":{"shape":"LineageObject"} }, "LineageObject":{ "type":"structure", "members":{ "StartTime":{ "shape":"Timestamp", "documentation":"

The time when the process started. This is in UTC format.

", "locationName":"startTime" }, "NamespacePid":{ "shape":"Integer", "documentation":"

The process ID of the child process.

", "locationName":"namespacePid" }, "UserId":{ "shape":"Integer", "documentation":"

The user ID of the user that executed the process.

", "locationName":"userId" }, "Name":{ "shape":"String", "documentation":"

The name of the process.

", "locationName":"name" }, "Pid":{ "shape":"Integer", "documentation":"

The ID of the process.

", "locationName":"pid" }, "Uuid":{ "shape":"String", "documentation":"

The unique ID assigned to the process by GuardDuty.

", "locationName":"uuid" }, "ExecutablePath":{ "shape":"String", "documentation":"

The absolute path of the process executable file.

", "locationName":"executablePath" }, "Euid":{ "shape":"Integer", "documentation":"

The effective user ID that was used to execute the process.

", "locationName":"euid" }, "ParentUuid":{ "shape":"String", "documentation":"

The unique ID of the parent process. This ID is assigned to the parent process by GuardDuty.

", "locationName":"parentUuid" } }, "documentation":"

Information about the runtime process details.

" }, "ListCoverageRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The unique ID of the detector whose coverage details you want to retrieve.

", "location":"uri", "locationName":"detectorId" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in the response.

", "locationName":"maxResults" }, "FilterCriteria":{ "shape":"CoverageFilterCriteria", "documentation":"

Represents the criteria used to filter the coverage details.

", "locationName":"filterCriteria" }, "SortCriteria":{ "shape":"CoverageSortCriteria", "documentation":"

Represents the criteria used to sort the coverage details.

", "locationName":"sortCriteria" } } }, "ListCoverageResponse":{ "type":"structure", "required":["Resources"], "members":{ "Resources":{ "shape":"CoverageResources", "documentation":"

A list of resources and their attributes providing cluster details.

", "locationName":"resources" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "ListDetectorsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListDetectorsResponse":{ "type":"structure", "required":["DetectorIds"], "members":{ "DetectorIds":{ "shape":"DetectorIds", "documentation":"

A list of detector IDs.

", "locationName":"detectorIds" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "ListFiltersRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListFiltersResponse":{ "type":"structure", "required":["FilterNames"], "members":{ "FilterNames":{ "shape":"FilterNames", "documentation":"

A list of filter names.

", "locationName":"filterNames" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "ListFindingsRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FindingCriteria":{ "shape":"FindingCriteria", "documentation":"

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.dnsRequestAction.domainWithSuffix

- service.action.networkConnectionAction.blocked

- service.action.networkConnectionAction.connectionDirection

- service.action.networkConnectionAction.localPortDetails.port

- service.action.networkConnectionAction.protocol

- 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

", "locationName":"findingCriteria" }, "SortCriteria":{ "shape":"SortCriteria", "documentation":"

Represents the criteria used for sorting findings.

", "locationName":"sortCriteria" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "locationName":"nextToken" } } }, "ListFindingsResponse":{ "type":"structure", "required":["FindingIds"], "members":{ "FindingIds":{ "shape":"FindingIds", "documentation":"

The IDs of the findings that you're listing.

", "locationName":"findingIds" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "ListIPSetsRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListIPSetsResponse":{ "type":"structure", "required":["IpSetIds"], "members":{ "IpSetIds":{ "shape":"IpSetIds", "documentation":"

The IDs of the IPSet resources.

", "locationName":"ipSetIds" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "ListInvitationsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListInvitationsResponse":{ "type":"structure", "members":{ "Invitations":{ "shape":"Invitations", "documentation":"

A list of invitation descriptions.

", "locationName":"invitations" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "ListMembersRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "OnlyAssociated":{ "shape":"String", "documentation":"

Specifies whether to only return associated members or to return all members (including members who haven't been invited yet or have been disassociated). Member accounts must have been previously associated with the GuardDuty administrator account using `Create Members` .

", "location":"querystring", "locationName":"onlyAssociated" } } }, "ListMembersResponse":{ "type":"structure", "members":{ "Members":{ "shape":"Members", "documentation":"

A list of members.

The values for `email` and `invitedAt` are available only if the member accounts are added by invitation.

", "locationName":"members" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "ListOrganizationAdminAccountsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in the response.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListOrganizationAdminAccountsResponse":{ "type":"structure", "members":{ "AdminAccounts":{ "shape":"AdminAccounts", "documentation":"

A list of accounts configured as GuardDuty delegated administrators.

", "locationName":"adminAccounts" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "ListPublishingDestinationsRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The ID of the detector to retrieve publishing destinations for.

", "location":"uri", "locationName":"detectorId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in the response.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListPublishingDestinationsResponse":{ "type":"structure", "required":["Destinations"], "members":{ "Destinations":{ "shape":"Destinations", "documentation":"

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

", "locationName":"destinations" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "locationName":"nextToken" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"GuardDutyArn", "documentation":"

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

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagMap", "documentation":"

The tags associated with the resource.

", "locationName":"tags" } } }, "ListThreatIntelSetsRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListThreatIntelSetsResponse":{ "type":"structure", "required":["ThreatIntelSetIds"], "members":{ "ThreatIntelSetIds":{ "shape":"ThreatIntelSetIds", "documentation":"

The IDs of the ThreatIntelSet resources.

", "locationName":"threatIntelSetIds" }, "NextToken":{ "shape":"String", "documentation":"

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

", "locationName":"nextToken" } } }, "LocalIpDetails":{ "type":"structure", "members":{ "IpAddressV4":{ "shape":"String", "documentation":"

The IPv4 local address of the connection.

", "locationName":"ipAddressV4" } }, "documentation":"

Contains information about the local IP address of the connection.

" }, "LocalPortDetails":{ "type":"structure", "members":{ "Port":{ "shape":"Integer", "documentation":"

The port number of the local connection.

", "locationName":"port" }, "PortName":{ "shape":"String", "documentation":"

The port name of the local connection.

", "locationName":"portName" } }, "documentation":"

Contains information about the port for the local connection.

" }, "Location":{ "type":"string", "max":300, "min":1 }, "LoginAttribute":{ "type":"structure", "members":{ "User":{ "shape":"String", "documentation":"

Indicates the user name which attempted to log in.

", "locationName":"user" }, "Application":{ "shape":"String", "documentation":"

Indicates the application name used to attempt log in.

", "locationName":"application" }, "FailedLoginAttempts":{ "shape":"Integer", "documentation":"

Represents the sum of failed (unsuccessful) login attempts made to establish a connection to the database instance.

", "locationName":"failedLoginAttempts" }, "SuccessfulLoginAttempts":{ "shape":"Integer", "documentation":"

Represents the sum of successful connections (a correct combination of login attributes) made to the database instance by the actor.

", "locationName":"successfulLoginAttempts" } }, "documentation":"

Information about the login attempts.

" }, "LoginAttributes":{ "type":"list", "member":{"shape":"LoginAttribute"} }, "Long":{"type":"long"}, "LongValue":{"type":"long"}, "MalwareProtectionConfiguration":{ "type":"structure", "members":{ "ScanEc2InstanceWithFindings":{ "shape":"ScanEc2InstanceWithFindings", "documentation":"

Describes the configuration of Malware Protection for EC2 instances with findings.

", "locationName":"scanEc2InstanceWithFindings" } }, "documentation":"

Describes whether Malware Protection will be enabled as a data source.

" }, "MalwareProtectionConfigurationResult":{ "type":"structure", "members":{ "ScanEc2InstanceWithFindings":{ "shape":"ScanEc2InstanceWithFindingsResult", "documentation":"

Describes the configuration of Malware Protection for EC2 instances with findings.

", "locationName":"scanEc2InstanceWithFindings" }, "ServiceRole":{ "shape":"String", "documentation":"

The GuardDuty Malware Protection service role.

", "locationName":"serviceRole" } }, "documentation":"

An object that contains information on the status of all Malware Protection data sources.

" }, "MalwareProtectionDataSourceFreeTrial":{ "type":"structure", "members":{ "ScanEc2InstanceWithFindings":{ "shape":"DataSourceFreeTrial", "documentation":"

Describes whether Malware Protection for EC2 instances with findings is enabled as a data source.

", "locationName":"scanEc2InstanceWithFindings" } }, "documentation":"

Provides details about Malware Protection when it is enabled as a data source.

" }, "ManagementType":{ "type":"string", "enum":[ "AUTO_MANAGED", "MANUAL", "DISABLED" ] }, "MapEquals":{ "type":"list", "member":{"shape":"ScanConditionPair"} }, "Master":{ "type":"structure", "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The ID of the account used as the administrator account.

", "locationName":"accountId" }, "InvitationId":{ "shape":"String", "documentation":"

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

", "locationName":"invitationId" }, "RelationshipStatus":{ "shape":"String", "documentation":"

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

", "locationName":"relationshipStatus" }, "InvitedAt":{ "shape":"String", "documentation":"

The timestamp when the invitation was sent.

", "locationName":"invitedAt" } }, "documentation":"

Contains information about the administrator account and invitation.

" }, "MaxResults":{ "type":"integer", "max":50, "min":1 }, "Member":{ "type":"structure", "required":[ "AccountId", "MasterId", "Email", "RelationshipStatus", "UpdatedAt" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The ID of the member account.

", "locationName":"accountId" }, "DetectorId":{ "shape":"DetectorId", "documentation":"

The detector ID of the member account.

", "locationName":"detectorId" }, "MasterId":{ "shape":"String", "documentation":"

The administrator account ID.

", "locationName":"masterId" }, "Email":{ "shape":"Email", "documentation":"

The email address of the member account.

", "locationName":"email" }, "RelationshipStatus":{ "shape":"String", "documentation":"

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

", "locationName":"relationshipStatus" }, "InvitedAt":{ "shape":"String", "documentation":"

The timestamp when the invitation was sent.

", "locationName":"invitedAt" }, "UpdatedAt":{ "shape":"String", "documentation":"

The last-updated timestamp of the member.

", "locationName":"updatedAt" }, "AdministratorId":{ "shape":"String", "documentation":"

The administrator account ID.

", "locationName":"administratorId" } }, "documentation":"

Contains information about the member account.

" }, "MemberAdditionalConfiguration":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeatureAdditionalConfiguration", "documentation":"

Name of the additional configuration.

", "locationName":"name" }, "Status":{ "shape":"FeatureStatus", "documentation":"

Status of the additional configuration.

", "locationName":"status" } }, "documentation":"

Information about the additional configuration for the member account.

" }, "MemberAdditionalConfigurationResult":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeatureAdditionalConfiguration", "documentation":"

Indicates the name of the additional configuration that is set for the member account.

", "locationName":"name" }, "Status":{ "shape":"FeatureStatus", "documentation":"

Indicates the status of the additional configuration that is set for the member account.

", "locationName":"status" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp at which the additional configuration was set for the member account. This is in UTC format.

", "locationName":"updatedAt" } }, "documentation":"

Information about the additional configuration for the member account.

" }, "MemberAdditionalConfigurationResults":{ "type":"list", "member":{"shape":"MemberAdditionalConfigurationResult"} }, "MemberAdditionalConfigurations":{ "type":"list", "member":{"shape":"MemberAdditionalConfiguration"} }, "MemberDataSourceConfiguration":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The account ID for the member account.

", "locationName":"accountId" }, "DataSources":{ "shape":"DataSourceConfigurationsResult", "documentation":"

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

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Features":{ "shape":"MemberFeaturesConfigurationsResults", "documentation":"

Contains information about the status of the features for the member account.

", "locationName":"features" } }, "documentation":"

Contains information on which data sources are enabled for a member account.

" }, "MemberDataSourceConfigurations":{ "type":"list", "member":{"shape":"MemberDataSourceConfiguration"}, "max":50, "min":1 }, "MemberFeaturesConfiguration":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeature", "documentation":"

The name of the feature.

", "locationName":"name" }, "Status":{ "shape":"FeatureStatus", "documentation":"

The status of the feature.

", "locationName":"status" }, "AdditionalConfiguration":{ "shape":"MemberAdditionalConfigurations", "documentation":"

Additional configuration of the feature for the member account.

", "locationName":"additionalConfiguration" } }, "documentation":"

Contains information about the features for the member account.

" }, "MemberFeaturesConfigurationResult":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeature", "documentation":"

Indicates the name of the feature that is enabled for the detector.

", "locationName":"name" }, "Status":{ "shape":"FeatureStatus", "documentation":"

Indicates the status of the feature that is enabled for the detector.

", "locationName":"status" }, "UpdatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp at which the feature object was updated.

", "locationName":"updatedAt" }, "AdditionalConfiguration":{ "shape":"MemberAdditionalConfigurationResults", "documentation":"

Indicates the additional configuration of the feature that is configured for the member account.

", "locationName":"additionalConfiguration" } }, "documentation":"

Contains information about the features for the member account.

" }, "MemberFeaturesConfigurations":{ "type":"list", "member":{"shape":"MemberFeaturesConfiguration"} }, "MemberFeaturesConfigurationsResults":{ "type":"list", "member":{"shape":"MemberFeaturesConfigurationResult"} }, "Members":{ "type":"list", "member":{"shape":"Member"}, "max":50, "min":0 }, "MemoryRegionsList":{ "type":"list", "member":{"shape":"String"} }, "Name":{ "type":"string", "max":300, "min":1 }, "Neq":{ "type":"list", "member":{"shape":"String"} }, "NetworkConnectionAction":{ "type":"structure", "members":{ "Blocked":{ "shape":"Boolean", "documentation":"

Indicates whether EC2 blocked the network connection to your instance.

", "locationName":"blocked" }, "ConnectionDirection":{ "shape":"String", "documentation":"

The network connection direction.

", "locationName":"connectionDirection" }, "LocalPortDetails":{ "shape":"LocalPortDetails", "documentation":"

The local port information of the connection.

", "locationName":"localPortDetails" }, "Protocol":{ "shape":"String", "documentation":"

The network connection protocol.

", "locationName":"protocol" }, "LocalIpDetails":{ "shape":"LocalIpDetails", "documentation":"

The local IP information of the connection.

", "locationName":"localIpDetails" }, "RemoteIpDetails":{ "shape":"RemoteIpDetails", "documentation":"

The remote IP information of the connection.

", "locationName":"remoteIpDetails" }, "RemotePortDetails":{ "shape":"RemotePortDetails", "documentation":"

The remote port information of the connection.

", "locationName":"remotePortDetails" } }, "documentation":"

Contains information about the NETWORK_CONNECTION action described in the finding.

" }, "NetworkInterface":{ "type":"structure", "members":{ "Ipv6Addresses":{ "shape":"Ipv6Addresses", "documentation":"

A list of IPv6 addresses for the EC2 instance.

", "locationName":"ipv6Addresses" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name of the EC2 instance.

", "locationName":"privateDnsName" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the EC2 instance.

", "locationName":"privateIpAddress" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddresses", "documentation":"

Other private IP address information of the EC2 instance.

", "locationName":"privateIpAddresses" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name of the EC2 instance.

", "locationName":"publicDnsName" }, "PublicIp":{ "shape":"String", "documentation":"

The public IP address of the EC2 instance.

", "locationName":"publicIp" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The security groups associated with the EC2 instance.

", "locationName":"securityGroups" }, "SubnetId":{ "shape":"String", "documentation":"

The subnet ID of the EC2 instance.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The VPC ID of the EC2 instance.

", "locationName":"vpcId" } }, "documentation":"

Contains information about the elastic network interface of the EC2 instance.

" }, "NetworkInterfaces":{ "type":"list", "member":{"shape":"NetworkInterface"} }, "NonEmptyString":{ "type":"string", "max":200, "min":1 }, "NotEquals":{ "type":"list", "member":{"shape":"String"} }, "ObservationTexts":{ "type":"list", "member":{"shape":"String"} }, "Observations":{ "type":"structure", "members":{ "Text":{ "shape":"ObservationTexts", "documentation":"

The text that was unusual.

", "locationName":"text" } }, "documentation":"

Contains information about the observed behavior.

" }, "OrderBy":{ "type":"string", "enum":[ "ASC", "DESC" ] }, "OrgFeature":{ "type":"string", "enum":[ "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "EKS_RUNTIME_MONITORING", "LAMBDA_NETWORK_LOGS", "RUNTIME_MONITORING" ] }, "OrgFeatureAdditionalConfiguration":{ "type":"string", "enum":[ "EKS_ADDON_MANAGEMENT", "ECS_FARGATE_AGENT_MANAGEMENT" ] }, "OrgFeatureStatus":{ "type":"string", "enum":[ "NEW", "NONE", "ALL" ] }, "Organization":{ "type":"structure", "members":{ "Asn":{ "shape":"String", "documentation":"

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

", "locationName":"asn" }, "AsnOrg":{ "shape":"String", "documentation":"

The organization that registered this ASN.

", "locationName":"asnOrg" }, "Isp":{ "shape":"String", "documentation":"

The ISP information for the internet provider.

", "locationName":"isp" }, "Org":{ "shape":"String", "documentation":"

The name of the internet provider.

", "locationName":"org" } }, "documentation":"

Contains information about the ISP organization of the remote IP address.

" }, "OrganizationAdditionalConfiguration":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeatureAdditionalConfiguration", "documentation":"

The name of the additional configuration that will be configured for the organization.

", "locationName":"name" }, "AutoEnable":{ "shape":"OrgFeatureStatus", "documentation":"

The status of the additional configuration that will be configured for the organization. Use one of the following values to configure the feature status for the entire organization:

- `NEW`: Indicates that when a new account joins the organization, they will have the additional configuration enabled automatically.

- `ALL`: Indicates that all accounts in the organization have the additional configuration enabled automatically. This includes `NEW` accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

  It may take up to 24 hours to update the configuration for all the member accounts.

- `NONE`: Indicates that the additional configuration will not be automatically enabled for any account in the organization. The administrator must manage the additional configuration for each account individually.

", "locationName":"autoEnable" } }, "documentation":"

A list of additional configurations which will be configured for the organization.

" }, "OrganizationAdditionalConfigurationResult":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeatureAdditionalConfiguration", "documentation":"

The name of the additional configuration that is configured for the member accounts within the organization.

", "locationName":"name" }, "AutoEnable":{ "shape":"OrgFeatureStatus", "documentation":"

Describes the status of the additional configuration that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:

- `NEW`: Indicates that when a new account joins the organization, they will have the additional configuration enabled automatically.

- `ALL`: Indicates that all accounts in the organization have the additional configuration enabled automatically. This includes `NEW` accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

  It may take up to 24 hours to update the configuration for all the member accounts.

- `NONE`: Indicates that the additional configuration will not be automatically enabled for any account in the organization. The administrator must manage the additional configuration for each account individually.

", "locationName":"autoEnable" } }, "documentation":"

A list of additional configuration which will be configured for the organization.

" }, "OrganizationAdditionalConfigurationResults":{ "type":"list", "member":{"shape":"OrganizationAdditionalConfigurationResult"} }, "OrganizationAdditionalConfigurations":{ "type":"list", "member":{"shape":"OrganizationAdditionalConfiguration"} }, "OrganizationDataSourceConfigurations":{ "type":"structure", "members":{ "S3Logs":{ "shape":"OrganizationS3LogsConfiguration", "documentation":"

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

", "locationName":"s3Logs" }, "Kubernetes":{ "shape":"OrganizationKubernetesConfiguration", "documentation":"

Describes the configuration of Kubernetes data sources for new members of the organization.

", "locationName":"kubernetes" }, "MalwareProtection":{ "shape":"OrganizationMalwareProtectionConfiguration", "documentation":"

Describes the configuration of Malware Protection for new members of the organization.

", "locationName":"malwareProtection" } }, "documentation":"

An object that contains information on which data sources will be configured to be automatically enabled for new members within the organization.

" }, "OrganizationDataSourceConfigurationsResult":{ "type":"structure", "required":["S3Logs"], "members":{ "S3Logs":{ "shape":"OrganizationS3LogsConfigurationResult", "documentation":"

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

", "locationName":"s3Logs" }, "Kubernetes":{ "shape":"OrganizationKubernetesConfigurationResult", "documentation":"

Describes the configuration of Kubernetes data sources.

", "locationName":"kubernetes" }, "MalwareProtection":{ "shape":"OrganizationMalwareProtectionConfigurationResult", "documentation":"

Describes the configuration of Malware Protection data source for an organization.

", "locationName":"malwareProtection" } }, "documentation":"

An object that contains information on which data sources are automatically enabled for new members within the organization.

" }, "OrganizationDetails":{ "type":"structure", "members":{ "UpdatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp at which the organization statistics was last updated. This is in UTC format.

", "locationName":"updatedAt" }, "OrganizationStatistics":{ "shape":"OrganizationStatistics", "documentation":"

Information about the GuardDuty coverage statistics for members in your Amazon Web Services organization.

", "locationName":"organizationStatistics" } }, "documentation":"

Information about GuardDuty coverage statistics for members in your Amazon Web Services organization.

" }, "OrganizationEbsVolumes":{ "type":"structure", "members":{ "AutoEnable":{ "shape":"Boolean", "documentation":"

Whether scanning EBS volumes should be auto-enabled for new members joining the organization.

", "locationName":"autoEnable" } }, "documentation":"

Organization-wide EBS volumes scan configuration.

" }, "OrganizationEbsVolumesResult":{ "type":"structure", "members":{ "AutoEnable":{ "shape":"Boolean", "documentation":"

An object that contains the status of whether scanning EBS volumes should be auto-enabled for new members joining the organization.

", "locationName":"autoEnable" } }, "documentation":"

An object that contains information on the status of whether EBS volumes scanning will be enabled as a data source for an organization.

" }, "OrganizationFeatureConfiguration":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeature", "documentation":"

The name of the feature that will be configured for the organization.

", "locationName":"name" }, "AutoEnable":{ "shape":"OrgFeatureStatus", "documentation":"

Describes the status of the feature that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:

- `NEW`: Indicates that when a new account joins the organization, they will have the feature enabled automatically.

- `ALL`: Indicates that all accounts in the organization have the feature enabled automatically. This includes `NEW` accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

  It may take up to 24 hours to update the configuration for all the member accounts.

- `NONE`: Indicates that the feature will not be automatically enabled for any account in the organization. The administrator must manage the feature for each account individually.

", "locationName":"autoEnable" }, "AdditionalConfiguration":{ "shape":"OrganizationAdditionalConfigurations", "documentation":"

The additional information that will be configured for the organization.

", "locationName":"additionalConfiguration" } }, "documentation":"

A list of features which will be configured for the organization.

" }, "OrganizationFeatureConfigurationResult":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeature", "documentation":"

The name of the feature that is configured for the member accounts within the organization.

", "locationName":"name" }, "AutoEnable":{ "shape":"OrgFeatureStatus", "documentation":"

Describes the status of the feature that is configured for the member accounts within the organization.

- `NEW`: Indicates that when a new account joins the organization, they will have the feature enabled automatically.

- `ALL`: Indicates that all accounts in the organization have the feature enabled automatically. This includes `NEW` accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

- `NONE`: Indicates that the feature will not be automatically enabled for any account in the organization. In this case, each account will be managed individually by the administrator.

", "locationName":"autoEnable" }, "AdditionalConfiguration":{ "shape":"OrganizationAdditionalConfigurationResults", "documentation":"

The additional configuration that is configured for the member accounts within the organization.

", "locationName":"additionalConfiguration" } }, "documentation":"

A list of features which will be configured for the organization.

" }, "OrganizationFeatureStatistics":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeature", "documentation":"

Name of the feature.

", "locationName":"name" }, "EnabledAccountsCount":{ "shape":"Integer", "documentation":"

Total number of accounts that have enabled a specific feature.

", "locationName":"enabledAccountsCount" }, "AdditionalConfiguration":{ "shape":"OrganizationFeatureStatisticsAdditionalConfigurations", "documentation":"

Name of the additional configuration.

", "locationName":"additionalConfiguration" } }, "documentation":"

Information about the number of accounts that have enabled a specific feature.

" }, "OrganizationFeatureStatisticsAdditionalConfiguration":{ "type":"structure", "members":{ "Name":{ "shape":"OrgFeatureAdditionalConfiguration", "documentation":"

Name of the additional configuration within a feature.

", "locationName":"name" }, "EnabledAccountsCount":{ "shape":"Integer", "documentation":"

Total number of accounts that have enabled the additional configuration.

", "locationName":"enabledAccountsCount" } }, "documentation":"

Information about the coverage statistic for the additional configuration of the feature.

" }, "OrganizationFeatureStatisticsAdditionalConfigurations":{ "type":"list", "member":{"shape":"OrganizationFeatureStatisticsAdditionalConfiguration"} }, "OrganizationFeatureStatisticsResults":{ "type":"list", "member":{"shape":"OrganizationFeatureStatistics"} }, "OrganizationFeaturesConfigurations":{ "type":"list", "member":{"shape":"OrganizationFeatureConfiguration"} }, "OrganizationFeaturesConfigurationsResults":{ "type":"list", "member":{"shape":"OrganizationFeatureConfigurationResult"} }, "OrganizationKubernetesAuditLogsConfiguration":{ "type":"structure", "required":["AutoEnable"], "members":{ "AutoEnable":{ "shape":"Boolean", "documentation":"

A value that contains information on whether Kubernetes audit logs should be enabled automatically as a data source for the organization.

", "locationName":"autoEnable" } }, "documentation":"

Organization-wide Kubernetes audit logs configuration.

" }, "OrganizationKubernetesAuditLogsConfigurationResult":{ "type":"structure", "required":["AutoEnable"], "members":{ "AutoEnable":{ "shape":"Boolean", "documentation":"

Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization.

", "locationName":"autoEnable" } }, "documentation":"

The current configuration of Kubernetes audit logs as a data source for the organization.

" }, "OrganizationKubernetesConfiguration":{ "type":"structure", "required":["AuditLogs"], "members":{ "AuditLogs":{ "shape":"OrganizationKubernetesAuditLogsConfiguration", "documentation":"

Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization.

", "locationName":"auditLogs" } }, "documentation":"

Organization-wide Kubernetes data sources configurations.

" }, "OrganizationKubernetesConfigurationResult":{ "type":"structure", "required":["AuditLogs"], "members":{ "AuditLogs":{ "shape":"OrganizationKubernetesAuditLogsConfigurationResult", "documentation":"

The current configuration of Kubernetes audit logs as a data source for the organization.

", "locationName":"auditLogs" } }, "documentation":"

The current configuration of all Kubernetes data sources for the organization.

" }, "OrganizationMalwareProtectionConfiguration":{ "type":"structure", "members":{ "ScanEc2InstanceWithFindings":{ "shape":"OrganizationScanEc2InstanceWithFindings", "documentation":"

Whether Malware Protection for EC2 instances with findings should be auto-enabled for new members joining the organization.

", "locationName":"scanEc2InstanceWithFindings" } }, "documentation":"

Organization-wide Malware Protection configurations.

" }, "OrganizationMalwareProtectionConfigurationResult":{ "type":"structure", "members":{ "ScanEc2InstanceWithFindings":{ "shape":"OrganizationScanEc2InstanceWithFindingsResult", "documentation":"

Describes the configuration for scanning EC2 instances with findings for an organization.

", "locationName":"scanEc2InstanceWithFindings" } }, "documentation":"

An object that contains information on the status of all Malware Protection data source for an organization.

" }, "OrganizationS3LogsConfiguration":{ "type":"structure", "required":["AutoEnable"], "members":{ "AutoEnable":{ "shape":"Boolean", "documentation":"

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

", "locationName":"autoEnable" } }, "documentation":"

Describes whether S3 data event logs will be automatically enabled for new members of the organization.

" }, "OrganizationS3LogsConfigurationResult":{ "type":"structure", "required":["AutoEnable"], "members":{ "AutoEnable":{ "shape":"Boolean", "documentation":"

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

", "locationName":"autoEnable" } }, "documentation":"

The current configuration of S3 data event logs as a data source for the organization.

" }, "OrganizationScanEc2InstanceWithFindings":{ "type":"structure", "members":{ "EbsVolumes":{ "shape":"OrganizationEbsVolumes", "documentation":"

Whether scanning EBS volumes should be auto-enabled for new members joining the organization.

", "locationName":"ebsVolumes" } }, "documentation":"

Organization-wide EC2 instances with findings scan configuration.

" }, "OrganizationScanEc2InstanceWithFindingsResult":{ "type":"structure", "members":{ "EbsVolumes":{ "shape":"OrganizationEbsVolumesResult", "documentation":"

Describes the configuration for scanning EBS volumes for an organization.

", "locationName":"ebsVolumes" } }, "documentation":"

An object that contains information on the status of scanning EC2 instances with findings for an organization.

" }, "OrganizationStatistics":{ "type":"structure", "members":{ "TotalAccountsCount":{ "shape":"Integer", "documentation":"

Total number of accounts in your Amazon Web Services organization.

", "locationName":"totalAccountsCount" }, "MemberAccountsCount":{ "shape":"Integer", "documentation":"

Total number of accounts in your Amazon Web Services organization that are associated with GuardDuty.

", "locationName":"memberAccountsCount" }, "ActiveAccountsCount":{ "shape":"Integer", "documentation":"

Total number of active accounts in your Amazon Web Services organization that are associated with GuardDuty.

", "locationName":"activeAccountsCount" }, "EnabledAccountsCount":{ "shape":"Integer", "documentation":"

Total number of accounts that have enabled GuardDuty.

", "locationName":"enabledAccountsCount" }, "CountByFeature":{ "shape":"OrganizationFeatureStatisticsResults", "documentation":"

Retrieves the coverage statistics for each feature.

", "locationName":"countByFeature" } }, "documentation":"

Information about the coverage statistics of the features for the entire Amazon Web Services organization.

When you create a new Amazon Web Services organization, it might take up to 24 hours to generate the statistics summary for this organization.

" }, "Owner":{ "type":"structure", "members":{ "Id":{ "shape":"String", "documentation":"

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

", "locationName":"id" } }, "documentation":"

Contains information on the owner of the bucket.

" }, "PermissionConfiguration":{ "type":"structure", "members":{ "BucketLevelPermissions":{ "shape":"BucketLevelPermissions", "documentation":"

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

", "locationName":"bucketLevelPermissions" }, "AccountLevelPermissions":{ "shape":"AccountLevelPermissions", "documentation":"

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

", "locationName":"accountLevelPermissions" } }, "documentation":"

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

" }, "PortProbeAction":{ "type":"structure", "members":{ "Blocked":{ "shape":"Boolean", "documentation":"

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

", "locationName":"blocked" }, "PortProbeDetails":{ "shape":"PortProbeDetails", "documentation":"

A list of objects related to port probe details.

", "locationName":"portProbeDetails" } }, "documentation":"

Contains information about the PORT_PROBE action described in the finding.

" }, "PortProbeDetail":{ "type":"structure", "members":{ "LocalPortDetails":{ "shape":"LocalPortDetails", "documentation":"

The local port information of the connection.

", "locationName":"localPortDetails" }, "LocalIpDetails":{ "shape":"LocalIpDetails", "documentation":"

The local IP information of the connection.

", "locationName":"localIpDetails" }, "RemoteIpDetails":{ "shape":"RemoteIpDetails", "documentation":"

The remote IP information of the connection.

", "locationName":"remoteIpDetails" } }, "documentation":"

Contains information about the port probe details.

" }, "PortProbeDetails":{ "type":"list", "member":{"shape":"PortProbeDetail"} }, "PositiveLong":{ "type":"long", "min":0 }, "PrivateIpAddressDetails":{ "type":"structure", "members":{ "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name of the EC2 instance.

", "locationName":"privateDnsName" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the EC2 instance.

", "locationName":"privateIpAddress" } }, "documentation":"

Contains other private IP address information of the EC2 instance.

" }, "PrivateIpAddresses":{ "type":"list", "member":{"shape":"PrivateIpAddressDetails"} }, "ProcessDetails":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the process.

", "locationName":"name" }, "ExecutablePath":{ "shape":"String", "documentation":"

The absolute path of the process executable file.

", "locationName":"executablePath" }, "ExecutableSha256":{ "shape":"String", "documentation":"

The `SHA256` hash of the process executable.

", "locationName":"executableSha256" }, "NamespacePid":{ "shape":"Integer", "documentation":"

The ID of the child process.

", "locationName":"namespacePid" }, "Pwd":{ "shape":"String", "documentation":"

The present working directory of the process.

", "locationName":"pwd" }, "Pid":{ "shape":"Integer", "documentation":"

The ID of the process.

", "locationName":"pid" }, "StartTime":{ "shape":"Timestamp", "documentation":"

The time when the process started. This is in UTC format.

", "locationName":"startTime" }, "Uuid":{ "shape":"String", "documentation":"

The unique ID assigned to the process by GuardDuty.

", "locationName":"uuid" }, "ParentUuid":{ "shape":"String", "documentation":"

The unique ID of the parent process. This ID is assigned to the parent process by GuardDuty.

", "locationName":"parentUuid" }, "User":{ "shape":"String", "documentation":"

The user that executed the process.

", "locationName":"user" }, "UserId":{ "shape":"Integer", "documentation":"

The unique ID of the user that executed the process.

", "locationName":"userId" }, "Euid":{ "shape":"Integer", "documentation":"

The effective user ID of the user that executed the process.

", "locationName":"euid" }, "Lineage":{ "shape":"Lineage", "documentation":"

Information about the process's lineage.

", "locationName":"lineage" } }, "documentation":"

Information about the observed process.

" }, "ProductCode":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The product code information.

", "locationName":"productCodeId" }, "ProductType":{ "shape":"String", "documentation":"

The product code type.

", "locationName":"productCodeType" } }, "documentation":"

Contains information about the product code for the EC2 instance.

" }, "ProductCodes":{ "type":"list", "member":{"shape":"ProductCode"} }, "ProfileSubtype":{ "type":"string", "enum":[ "FREQUENT", "INFREQUENT", "UNSEEN", "RARE" ] }, "ProfileType":{ "type":"string", "enum":["FREQUENCY"] }, "PublicAccess":{ "type":"structure", "members":{ "PermissionConfiguration":{ "shape":"PermissionConfiguration", "documentation":"

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

", "locationName":"permissionConfiguration" }, "EffectivePermission":{ "shape":"String", "documentation":"

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

", "locationName":"effectivePermission" } }, "documentation":"

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

" }, "PublishingStatus":{ "type":"string", "enum":[ "PENDING_VERIFICATION", "PUBLISHING", "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY", "STOPPED" ], "max":300, "min":1 }, "RdsDbInstanceDetails":{ "type":"structure", "members":{ "DbInstanceIdentifier":{ "shape":"String", "documentation":"

The identifier associated to the database instance that was involved in the finding.

", "locationName":"dbInstanceIdentifier" }, "Engine":{ "shape":"String", "documentation":"

The database engine of the database instance involved in the finding.

", "locationName":"engine" }, "EngineVersion":{ "shape":"String", "documentation":"

The version of the database engine that was involved in the finding.

", "locationName":"engineVersion" }, "DbClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the database cluster that contains the database instance ID involved in the finding.

", "locationName":"dbClusterIdentifier" }, "DbInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the database instance involved in the finding.

", "locationName":"dbInstanceArn" }, "Tags":{ "shape":"Tags", "documentation":"

Instance tag key-value pairs associated with the database instance ID.

", "locationName":"tags" } }, "documentation":"

Contains information about the resource type `RDSDBInstance` involved in a GuardDuty finding.

" }, "RdsDbUserDetails":{ "type":"structure", "members":{ "User":{ "shape":"String", "documentation":"

The user name used in the anomalous login attempt.

", "locationName":"user" }, "Application":{ "shape":"String", "documentation":"

The application name used in the anomalous login attempt.

", "locationName":"application" }, "Database":{ "shape":"String", "documentation":"

The name of the database instance involved in the anomalous login attempt.

", "locationName":"database" }, "Ssl":{ "shape":"String", "documentation":"

The version of the Secure Socket Layer (SSL) used for the network.

", "locationName":"ssl" }, "AuthMethod":{ "shape":"String", "documentation":"

The authentication method used by the user involved in the finding.

", "locationName":"authMethod" } }, "documentation":"

Contains information about the user and authentication details for a database instance involved in the finding.

" }, "RdsLoginAttemptAction":{ "type":"structure", "members":{ "RemoteIpDetails":{ "shape":"RemoteIpDetails", "locationName":"remoteIpDetails" }, "LoginAttributes":{ "shape":"LoginAttributes", "documentation":"

Indicates the login attributes used in the login attempt.

" } }, "documentation":"

Indicates that a login attempt was made to the potentially compromised database from a remote IP address.

" }, "RemoteAccountDetails":{ "type":"structure", "members":{ "AccountId":{ "shape":"String", "documentation":"

The Amazon Web Services account ID of the remote API caller.

", "locationName":"accountId" }, "Affiliated":{ "shape":"Boolean", "documentation":"

Details on whether the Amazon Web Services account of the remote API caller is related to your GuardDuty environment. If this value is `True` the API caller is affiliated to your account in some way. If it is `False` the API caller is from outside your environment.

", "locationName":"affiliated" } }, "documentation":"

Contains details about the remote Amazon Web Services account that made the API call.

" }, "RemoteIpDetails":{ "type":"structure", "members":{ "City":{ "shape":"City", "documentation":"

The city information of the remote IP address.

", "locationName":"city" }, "Country":{ "shape":"Country", "documentation":"

The country code of the remote IP address.

", "locationName":"country" }, "GeoLocation":{ "shape":"GeoLocation", "documentation":"

The location information of the remote IP address.

", "locationName":"geoLocation" }, "IpAddressV4":{ "shape":"String", "documentation":"

The IPv4 remote address of the connection.

", "locationName":"ipAddressV4" }, "Organization":{ "shape":"Organization", "documentation":"

The ISP organization information of the remote IP address.

", "locationName":"organization" } }, "documentation":"

Contains information about the remote IP address of the connection.

" }, "RemotePortDetails":{ "type":"structure", "members":{ "Port":{ "shape":"Integer", "documentation":"

The port number of the remote connection.

", "locationName":"port" }, "PortName":{ "shape":"String", "documentation":"

The port name of the remote connection.

", "locationName":"portName" } }, "documentation":"

Contains information about the remote port.

" }, "Resource":{ "type":"structure", "members":{ "AccessKeyDetails":{ "shape":"AccessKeyDetails", "documentation":"

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

", "locationName":"accessKeyDetails" }, "S3BucketDetails":{ "shape":"S3BucketDetails", "documentation":"

Contains information on the S3 bucket.

", "locationName":"s3BucketDetails" }, "InstanceDetails":{ "shape":"InstanceDetails", "documentation":"

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

", "locationName":"instanceDetails" }, "EksClusterDetails":{ "shape":"EksClusterDetails", "documentation":"

Details about the EKS cluster involved in a Kubernetes finding.

", "locationName":"eksClusterDetails" }, "KubernetesDetails":{ "shape":"KubernetesDetails", "documentation":"

Details about the Kubernetes user and workload involved in a Kubernetes finding.

", "locationName":"kubernetesDetails" }, "ResourceType":{ "shape":"String", "documentation":"

The type of Amazon Web Services resource.

", "locationName":"resourceType" }, "EbsVolumeDetails":{ "shape":"EbsVolumeDetails", "documentation":"

Contains list of scanned and skipped EBS volumes with details.

", "locationName":"ebsVolumeDetails" }, "EcsClusterDetails":{ "shape":"EcsClusterDetails", "documentation":"

Contains information about the details of the ECS Cluster.

", "locationName":"ecsClusterDetails" }, "ContainerDetails":{ "shape":"Container", "locationName":"containerDetails" }, "RdsDbInstanceDetails":{ "shape":"RdsDbInstanceDetails", "documentation":"

Contains information about the database instance to which an anomalous login attempt was made.

", "locationName":"rdsDbInstanceDetails" }, "RdsDbUserDetails":{ "shape":"RdsDbUserDetails", "documentation":"

Contains information about the user details through which anomalous login attempt was made.

", "locationName":"rdsDbUserDetails" }, "LambdaDetails":{ "shape":"LambdaDetails", "documentation":"

Contains information about the Lambda function that was involved in a finding.

", "locationName":"lambdaDetails" } }, "documentation":"

Contains information about the Amazon Web Services resource associated with the activity that prompted GuardDuty to generate a finding.

" }, "ResourceArn":{ "type":"string", "pattern":"^arn:[A-Za-z-]+:[A-Za-z0-9]+:[A-Za-z0-9-]+:\\d+:(([A-Za-z0-9-]+)[:\\/])?[A-Za-z0-9-]*$" }, "ResourceDetails":{ "type":"structure", "members":{ "InstanceArn":{ "shape":"InstanceArn", "documentation":"

InstanceArn that was scanned in the scan entry.

", "locationName":"instanceArn" } }, "documentation":"

Represents the resources that were scanned in the scan entry.

" }, "ResourceList":{ "type":"list", "member":{"shape":"String"} }, "ResourceType":{ "type":"string", "enum":[ "EKS", "ECS", "EC2" ] }, "RuntimeContext":{ "type":"structure", "members":{ "ModifyingProcess":{ "shape":"ProcessDetails", "documentation":"

Information about the process that modified the current process. This is available for multiple finding types.

", "locationName":"modifyingProcess" }, "ModifiedAt":{ "shape":"Timestamp", "documentation":"

The timestamp at which the process modified the current process. The timestamp is in UTC date string format.

", "locationName":"modifiedAt" }, "ScriptPath":{ "shape":"String", "documentation":"

The path to the script that was executed.

", "locationName":"scriptPath" }, "LibraryPath":{ "shape":"String", "documentation":"

The path to the new library that was loaded.

", "locationName":"libraryPath" }, "LdPreloadValue":{ "shape":"String", "documentation":"

The value of the LD_PRELOAD environment variable.

", "locationName":"ldPreloadValue" }, "SocketPath":{ "shape":"String", "documentation":"

The path to the docket socket that was accessed.

", "locationName":"socketPath" }, "RuncBinaryPath":{ "shape":"String", "documentation":"

The path to the leveraged `runc` implementation.

", "locationName":"runcBinaryPath" }, "ReleaseAgentPath":{ "shape":"String", "documentation":"

The path in the container that modified the release agent file.

", "locationName":"releaseAgentPath" }, "MountSource":{ "shape":"String", "documentation":"

The path on the host that is mounted by the container.

", "locationName":"mountSource" }, "MountTarget":{ "shape":"String", "documentation":"

The path in the container that is mapped to the host directory.

", "locationName":"mountTarget" }, "FileSystemType":{ "shape":"String", "documentation":"

Represents the type of mounted fileSystem.

", "locationName":"fileSystemType" }, "Flags":{ "shape":"FlagsList", "documentation":"

Represents options that control the behavior of a runtime operation or action. For example, a filesystem mount operation may contain a read-only flag.

", "locationName":"flags" }, "ModuleName":{ "shape":"String", "documentation":"

The name of the module loaded into the kernel.

", "locationName":"moduleName" }, "ModuleFilePath":{ "shape":"String", "documentation":"

The path to the module loaded into the kernel.

", "locationName":"moduleFilePath" }, "ModuleSha256":{ "shape":"String", "documentation":"

The `SHA256` hash of the module.

", "locationName":"moduleSha256" }, "ShellHistoryFilePath":{ "shape":"String", "documentation":"

The path to the modified shell history file.

", "locationName":"shellHistoryFilePath" }, "TargetProcess":{ "shape":"ProcessDetails", "documentation":"

Information about the process that had its memory overwritten by the current process.

", "locationName":"targetProcess" }, "AddressFamily":{ "shape":"String", "documentation":"

Represents the communication protocol associated with the address. For example, the address family `AF_INET` is used for IP version of 4 protocol.

", "locationName":"addressFamily" }, "IanaProtocolNumber":{ "shape":"Integer", "documentation":"

Specifies a particular protocol within the address family. Usually there is a single protocol in address families. For example, the address family `AF_INET` only has the IP protocol.

", "locationName":"ianaProtocolNumber" }, "MemoryRegions":{ "shape":"MemoryRegionsList", "documentation":"

Specifies the Region of a process's address space such as stack and heap.

", "locationName":"memoryRegions" } }, "documentation":"

Additional information about the suspicious activity.

" }, "RuntimeDetails":{ "type":"structure", "members":{ "Process":{ "shape":"ProcessDetails", "documentation":"

Information about the observed process.

", "locationName":"process" }, "Context":{ "shape":"RuntimeContext", "documentation":"

Additional information about the suspicious activity.

", "locationName":"context" } }, "documentation":"

Information about the process and any required context values for a specific finding.

" }, "S3BucketDetail":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

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

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the S3 bucket.

", "locationName":"name" }, "Type":{ "shape":"String", "documentation":"

Describes whether the bucket is a source or destination bucket.

", "locationName":"type" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"

The date and time the bucket was created at.

", "locationName":"createdAt" }, "Owner":{ "shape":"Owner", "documentation":"

The owner of the S3 bucket.

", "locationName":"owner" }, "Tags":{ "shape":"Tags", "documentation":"

All tags attached to the S3 bucket

", "locationName":"tags" }, "DefaultServerSideEncryption":{ "shape":"DefaultServerSideEncryption", "documentation":"

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

", "locationName":"defaultServerSideEncryption" }, "PublicAccess":{ "shape":"PublicAccess", "documentation":"

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

", "locationName":"publicAccess" } }, "documentation":"

Contains information on the S3 bucket.

" }, "S3BucketDetails":{ "type":"list", "member":{"shape":"S3BucketDetail"} }, "S3LogsConfiguration":{ "type":"structure", "required":["Enable"], "members":{ "Enable":{ "shape":"Boolean", "documentation":"

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

", "locationName":"enable" } }, "documentation":"

Describes whether S3 data event logs will be enabled as a data source.

" }, "S3LogsConfigurationResult":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"DataSourceStatus", "documentation":"

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

", "locationName":"status" } }, "documentation":"

Describes whether S3 data event logs will be enabled as a data source.

" }, "Scan":{ "type":"structure", "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "locationName":"detectorId" }, "AdminDetectorId":{ "shape":"DetectorId", "documentation":"

The unique detector ID of the administrator account that the request is associated with. Note that this value will be the same as the one used for `DetectorId` if the account is an administrator.

", "locationName":"adminDetectorId" }, "ScanId":{ "shape":"NonEmptyString", "documentation":"

The unique scan ID associated with a scan entry.

", "locationName":"scanId" }, "ScanStatus":{ "shape":"ScanStatus", "documentation":"

An enum value representing possible scan statuses.

", "locationName":"scanStatus" }, "FailureReason":{ "shape":"NonEmptyString", "documentation":"

Represents the reason for FAILED scan status.

", "locationName":"failureReason" }, "ScanStartTime":{ "shape":"Timestamp", "documentation":"

The timestamp of when the scan was triggered.

", "locationName":"scanStartTime" }, "ScanEndTime":{ "shape":"Timestamp", "documentation":"

The timestamp of when the scan was finished.

", "locationName":"scanEndTime" }, "TriggerDetails":{ "shape":"TriggerDetails", "documentation":"

Specifies the reason why the scan was initiated.

", "locationName":"triggerDetails" }, "ResourceDetails":{ "shape":"ResourceDetails", "documentation":"

Represents the resources that were scanned in the scan entry.

", "locationName":"resourceDetails" }, "ScanResultDetails":{ "shape":"ScanResultDetails", "documentation":"

Represents the result of the scan.

", "locationName":"scanResultDetails" }, "AccountId":{ "shape":"AccountId", "documentation":"

The ID for the account that belongs to the scan.

", "locationName":"accountId" }, "TotalBytes":{ "shape":"PositiveLong", "documentation":"

Represents total bytes that were scanned.

", "locationName":"totalBytes" }, "FileCount":{ "shape":"PositiveLong", "documentation":"

Represents the number of files that were scanned.

", "locationName":"fileCount" }, "AttachedVolumes":{ "shape":"VolumeDetails", "documentation":"

List of volumes that were attached to the original instance to be scanned.

", "locationName":"attachedVolumes" }, "ScanType":{ "shape":"ScanType", "documentation":"

Specifies the scan type that invoked the malware scan.

", "locationName":"scanType" } }, "documentation":"

Contains information about a malware scan.

" }, "ScanCondition":{ "type":"structure", "required":["MapEquals"], "members":{ "MapEquals":{ "shape":"MapEquals", "documentation":"

Represents an mapEqual condition to be applied to a single field when triggering for malware scan.

", "locationName":"mapEquals" } }, "documentation":"

Contains information about the condition.

" }, "ScanConditionPair":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

Represents the key in the map condition.

", "locationName":"key" }, "Value":{ "shape":"TagValue", "documentation":"

Represents optional value in the map condition. If not specified, only the key will be matched.

", "locationName":"value" } }, "documentation":"

Represents the `key:value` pair to be matched against given resource property.

" }, "ScanCriterion":{ "type":"map", "key":{"shape":"ScanCriterionKey"}, "value":{"shape":"ScanCondition"}, "documentation":"

Represents a map of resource properties that match specified conditions and values when triggering malware scans.

" }, "ScanCriterionKey":{ "type":"string", "documentation":"

An enum value representing possible resource properties to match with given scan condition.

", "enum":["EC2_INSTANCE_TAG"] }, "ScanDetections":{ "type":"structure", "members":{ "ScannedItemCount":{ "shape":"ScannedItemCount", "documentation":"

Total number of scanned files.

", "locationName":"scannedItemCount" }, "ThreatsDetectedItemCount":{ "shape":"ThreatsDetectedItemCount", "documentation":"

Total number of infected files.

", "locationName":"threatsDetectedItemCount" }, "HighestSeverityThreatDetails":{ "shape":"HighestSeverityThreatDetails", "documentation":"

Details of the highest severity threat detected during malware scan and number of infected files.

", "locationName":"highestSeverityThreatDetails" }, "ThreatDetectedByName":{ "shape":"ThreatDetectedByName", "documentation":"

Contains details about identified threats organized by threat name.

", "locationName":"threatDetectedByName" } }, "documentation":"

Contains a complete view providing malware scan result details.

" }, "ScanEc2InstanceWithFindings":{ "type":"structure", "members":{ "EbsVolumes":{ "shape":"Boolean", "documentation":"

Describes the configuration for scanning EBS volumes as data source.

", "locationName":"ebsVolumes" } }, "documentation":"

Describes whether Malware Protection for EC2 instances with findings will be enabled as a data source.

" }, "ScanEc2InstanceWithFindingsResult":{ "type":"structure", "members":{ "EbsVolumes":{ "shape":"EbsVolumesResult", "documentation":"

Describes the configuration of scanning EBS volumes as a data source.

", "locationName":"ebsVolumes" } }, "documentation":"

An object that contains information on the status of whether Malware Protection for EC2 instances with findings will be enabled as a data source.

" }, "ScanFilePath":{ "type":"structure", "members":{ "FilePath":{ "shape":"String", "documentation":"

The file path of the infected file.

", "locationName":"filePath" }, "VolumeArn":{ "shape":"String", "documentation":"

EBS volume Arn details of the infected file.

", "locationName":"volumeArn" }, "Hash":{ "shape":"String", "documentation":"

The hash value of the infected file.

", "locationName":"hash" }, "FileName":{ "shape":"String", "documentation":"

File name of the infected file.

", "locationName":"fileName" } }, "documentation":"

Contains details of infected file including name, file path and hash.

" }, "ScanResourceCriteria":{ "type":"structure", "members":{ "Include":{ "shape":"ScanCriterion", "documentation":"

Represents condition that when matched will allow a malware scan for a certain resource.

", "locationName":"include" }, "Exclude":{ "shape":"ScanCriterion", "documentation":"

Represents condition that when matched will prevent a malware scan for a certain resource.

", "locationName":"exclude" } }, "documentation":"

Contains information about criteria used to filter resources before triggering malware scan.

" }, "ScanResult":{ "type":"string", "enum":[ "CLEAN", "INFECTED" ] }, "ScanResultDetails":{ "type":"structure", "members":{ "ScanResult":{ "shape":"ScanResult", "documentation":"

An enum value representing possible scan results.

", "locationName":"scanResult" } }, "documentation":"

Represents the result of the scan.

" }, "ScanStatus":{ "type":"string", "enum":[ "RUNNING", "COMPLETED", "FAILED", "SKIPPED" ] }, "ScanThreatName":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the identified threat.

", "locationName":"name" }, "Severity":{ "shape":"String", "documentation":"

Severity of threat identified as part of the malware scan.

", "locationName":"severity" }, "ItemCount":{ "shape":"Integer", "documentation":"

Total number of files infected with given threat.

", "locationName":"itemCount" }, "FilePaths":{ "shape":"FilePaths", "documentation":"

List of infected files in EBS volume with details.

", "locationName":"filePaths" } }, "documentation":"

Contains files infected with the given threat providing details of malware name and severity.

" }, "ScanThreatNames":{ "type":"list", "member":{"shape":"ScanThreatName"} }, "ScanType":{ "type":"string", "enum":[ "GUARDDUTY_INITIATED", "ON_DEMAND" ] }, "ScannedItemCount":{ "type":"structure", "members":{ "TotalGb":{ "shape":"Integer", "documentation":"

Total GB of files scanned for malware.

", "locationName":"totalGb" }, "Files":{ "shape":"Integer", "documentation":"

Number of files scanned.

", "locationName":"files" }, "Volumes":{ "shape":"Integer", "documentation":"

Total number of scanned volumes.

", "locationName":"volumes" } }, "documentation":"

Total number of scanned files.

" }, "Scans":{ "type":"list", "member":{"shape":"Scan"} }, "SecurityContext":{ "type":"structure", "members":{ "Privileged":{ "shape":"Boolean", "documentation":"

Whether the container is privileged.

", "locationName":"privileged" }, "AllowPrivilegeEscalation":{ "shape":"Boolean", "documentation":"

Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process.

", "locationName":"allowPrivilegeEscalation" } }, "documentation":"

Container security context.

" }, "SecurityGroup":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The security group ID of the EC2 instance.

", "locationName":"groupId" }, "GroupName":{ "shape":"String", "documentation":"

The security group name of the EC2 instance.

", "locationName":"groupName" } }, "documentation":"

Contains information about the security groups associated with the EC2 instance.

" }, "SecurityGroups":{ "type":"list", "member":{"shape":"SecurityGroup"} }, "Service":{ "type":"structure", "members":{ "Action":{ "shape":"Action", "documentation":"

Information about the activity that is described in a finding.

", "locationName":"action" }, "Evidence":{ "shape":"Evidence", "documentation":"

An evidence object associated with the service.

", "locationName":"evidence" }, "Archived":{ "shape":"Boolean", "documentation":"

Indicates whether this finding is archived.

", "locationName":"archived" }, "Count":{ "shape":"Integer", "documentation":"

The total count of the occurrences of this finding type.

", "locationName":"count" }, "DetectorId":{ "shape":"DetectorId", "documentation":"

The detector ID for the GuardDuty service.

", "locationName":"detectorId" }, "EventFirstSeen":{ "shape":"String", "documentation":"

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

", "locationName":"eventFirstSeen" }, "EventLastSeen":{ "shape":"String", "documentation":"

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

", "locationName":"eventLastSeen" }, "ResourceRole":{ "shape":"String", "documentation":"

The resource role information for this finding.

", "locationName":"resourceRole" }, "ServiceName":{ "shape":"String", "documentation":"

The name of the Amazon Web Services service (GuardDuty) that generated a finding.

", "locationName":"serviceName" }, "UserFeedback":{ "shape":"String", "documentation":"

Feedback that was submitted about the finding.

", "locationName":"userFeedback" }, "AdditionalInfo":{ "shape":"ServiceAdditionalInfo", "documentation":"

Contains additional information about the generated finding.

", "locationName":"additionalInfo" }, "FeatureName":{ "shape":"String", "documentation":"

The name of the feature that generated a finding.

", "locationName":"featureName" }, "EbsVolumeScanDetails":{ "shape":"EbsVolumeScanDetails", "documentation":"

Returns details from the malware scan that created a finding.

", "locationName":"ebsVolumeScanDetails" }, "RuntimeDetails":{ "shape":"RuntimeDetails", "documentation":"

Information about the process and any required context values for a specific finding

", "locationName":"runtimeDetails" }, "Detection":{ "shape":"Detection", "documentation":"

Contains information about the detected unusual behavior.

", "locationName":"detection" } }, "documentation":"

Contains additional information about the generated finding.

" }, "ServiceAdditionalInfo":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

This field specifies the value of the additional information.

", "locationName":"value" }, "Type":{ "shape":"String", "documentation":"

Describes the type of the additional information.

", "locationName":"type" } }, "documentation":"

Additional information about the generated finding.

" }, "SessionNameList":{ "type":"list", "member":{"shape":"String"} }, "SortCriteria":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

Represents the finding attribute, such as `accountId`, that sorts the findings.

", "locationName":"attributeName" }, "OrderBy":{ "shape":"OrderBy", "documentation":"

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

", "locationName":"orderBy" } }, "documentation":"

Contains information about the criteria used for sorting findings.

" }, "SourceIps":{ "type":"list", "member":{"shape":"String"} }, "Sources":{ "type":"list", "member":{"shape":"String"} }, "StartMalwareScanRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

Amazon Resource Name (ARN) of the resource for which you invoked the API.

", "locationName":"resourceArn" } } }, "StartMalwareScanResponse":{ "type":"structure", "members":{ "ScanId":{ "shape":"NonEmptyString", "documentation":"

A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

", "locationName":"scanId" } } }, "StartMonitoringMembersRequest":{ "type":"structure", "required":[ "DetectorId", "AccountIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

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

", "locationName":"accountIds" } } }, "StartMonitoringMembersResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "StopMonitoringMembersRequest":{ "type":"structure", "required":[ "DetectorId", "AccountIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

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

", "locationName":"accountIds" } } }, "StopMonitoringMembersResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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.

", "locationName":"unprocessedAccounts" } } }, "String":{"type":"string"}, "SubnetIds":{ "type":"list", "member":{"shape":"String"} }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The EC2 instance tag key.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The EC2 instance tag value.

", "locationName":"value" } }, "documentation":"

Contains information about a tag associated with the EC2 instance.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":200, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"GuardDutyArn", "documentation":"

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

", "location":"uri", "locationName":"resourceArn" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags to be added to a resource.

", "locationName":"tags" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256 }, "Tags":{ "type":"list", "member":{"shape":"Tag"} }, "ThreatDetectedByName":{ "type":"structure", "members":{ "ItemCount":{ "shape":"Integer", "documentation":"

Total number of infected files identified.

", "locationName":"itemCount" }, "UniqueThreatNameCount":{ "shape":"Integer", "documentation":"

Total number of unique threats by name identified, as part of the malware scan.

", "locationName":"uniqueThreatNameCount" }, "Shortened":{ "shape":"Boolean", "documentation":"

Flag to determine if the finding contains every single infected file-path and/or every threat.

", "locationName":"shortened" }, "ThreatNames":{ "shape":"ScanThreatNames", "documentation":"

List of identified threats with details, organized by threat name.

", "locationName":"threatNames" } }, "documentation":"

Contains details about identified threats organized by threat name.

" }, "ThreatIntelSetFormat":{ "type":"string", "enum":[ "TXT", "STIX", "OTX_CSV", "ALIEN_VAULT", "PROOF_POINT", "FIRE_EYE" ], "max":300, "min":1 }, "ThreatIntelSetIds":{ "type":"list", "member":{"shape":"String"}, "max":50, "min":0 }, "ThreatIntelSetStatus":{ "type":"string", "enum":[ "INACTIVE", "ACTIVATING", "ACTIVE", "DEACTIVATING", "ERROR", "DELETE_PENDING", "DELETED" ], "max":300, "min":1 }, "ThreatIntelligenceDetail":{ "type":"structure", "members":{ "ThreatListName":{ "shape":"String", "documentation":"

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

", "locationName":"threatListName" }, "ThreatNames":{ "shape":"ThreatNames", "documentation":"

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

", "locationName":"threatNames" } }, "documentation":"

An instance of a threat intelligence detail that constitutes evidence for the finding.

" }, "ThreatIntelligenceDetails":{ "type":"list", "member":{"shape":"ThreatIntelligenceDetail"} }, "ThreatNames":{ "type":"list", "member":{"shape":"String"} }, "ThreatsDetectedItemCount":{ "type":"structure", "members":{ "Files":{ "shape":"Integer", "documentation":"

Total number of infected files.

", "locationName":"files" } }, "documentation":"

Contains total number of infected files.

" }, "Timestamp":{"type":"timestamp"}, "Total":{ "type":"structure", "members":{ "Amount":{ "shape":"String", "documentation":"

The total usage.

", "locationName":"amount" }, "Unit":{ "shape":"String", "documentation":"

The currency unit that the amount is given in.

", "locationName":"unit" } }, "documentation":"

Contains the total usage with the corresponding currency unit for that value.

" }, "TriggerDetails":{ "type":"structure", "members":{ "GuardDutyFindingId":{ "shape":"NonEmptyString", "documentation":"

The ID of the GuardDuty finding that triggered the malware scan.

", "locationName":"guardDutyFindingId" }, "Description":{ "shape":"NonEmptyString", "documentation":"

The description of the scan trigger.

", "locationName":"description" } }, "documentation":"

Represents the reason the scan was triggered.

" }, "UnarchiveFindingsRequest":{ "type":"structure", "required":[ "DetectorId", "FindingIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FindingIds":{ "shape":"FindingIds", "documentation":"

The IDs of the findings to unarchive.

", "locationName":"findingIds" } } }, "UnarchiveFindingsResponse":{ "type":"structure", "members":{ } }, "UnprocessedAccount":{ "type":"structure", "required":[ "AccountId", "Result" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID.

", "locationName":"accountId" }, "Result":{ "shape":"String", "documentation":"

A reason why the account hasn't been processed.

", "locationName":"result" } }, "documentation":"

Contains information about the accounts that weren't processed.

" }, "UnprocessedAccounts":{ "type":"list", "member":{"shape":"UnprocessedAccount"}, "max":50, "min":0 }, "UnprocessedDataSourcesResult":{ "type":"structure", "members":{ "MalwareProtection":{ "shape":"MalwareProtectionConfigurationResult", "locationName":"malwareProtection" } }, "documentation":"

Specifies the names of the data sources that couldn't be enabled.

" }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"GuardDutyArn", "documentation":"

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

", "location":"uri", "locationName":"resourceArn" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The tag keys to remove from the resource.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateDetectorRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The unique ID of the detector to update.

", "location":"uri", "locationName":"detectorId" }, "Enable":{ "shape":"Boolean", "documentation":"

Specifies whether the detector is enabled or not enabled.

", "locationName":"enable" }, "FindingPublishingFrequency":{ "shape":"FindingPublishingFrequency", "documentation":"

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

", "locationName":"findingPublishingFrequency" }, "DataSources":{ "shape":"DataSourceConfigurations", "documentation":"

Describes which data sources will be updated.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Features":{ "shape":"DetectorFeatureConfigurations", "documentation":"

Provides the features that will be updated for the detector.

", "locationName":"features" } } }, "UpdateDetectorResponse":{ "type":"structure", "members":{ } }, "UpdateFilterRequest":{ "type":"structure", "required":[ "DetectorId", "FilterName" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FilterName":{ "shape":"String", "documentation":"

The name of the filter.

", "location":"uri", "locationName":"filterName" }, "Description":{ "shape":"FilterDescription", "documentation":"

The description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses (`{ }`, `[ ]`, and `( )`), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.

", "locationName":"description" }, "Action":{ "shape":"FilterAction", "documentation":"

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

", "locationName":"action" }, "Rank":{ "shape":"FilterRank", "documentation":"

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.

", "locationName":"rank" }, "FindingCriteria":{ "shape":"FindingCriteria", "documentation":"

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

", "locationName":"findingCriteria" } } }, "UpdateFilterResponse":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"FilterName", "documentation":"

The name of the filter.

", "locationName":"name" } } }, "UpdateFindingsFeedbackRequest":{ "type":"structure", "required":[ "DetectorId", "FindingIds", "Feedback" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "FindingIds":{ "shape":"FindingIds", "documentation":"

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

", "locationName":"findingIds" }, "Feedback":{ "shape":"Feedback", "documentation":"

The feedback for the finding.

", "locationName":"feedback" }, "Comments":{ "shape":"String", "documentation":"

Additional feedback about the GuardDuty findings.

", "locationName":"comments" } } }, "UpdateFindingsFeedbackResponse":{ "type":"structure", "members":{ } }, "UpdateIPSetRequest":{ "type":"structure", "required":[ "DetectorId", "IpSetId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "IpSetId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"ipSetId" }, "Name":{ "shape":"Name", "documentation":"

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

", "locationName":"name" }, "Location":{ "shape":"Location", "documentation":"

The updated URI of the file that contains the IPSet.

", "locationName":"location" }, "Activate":{ "shape":"Boolean", "documentation":"

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

", "locationName":"activate" } } }, "UpdateIPSetResponse":{ "type":"structure", "members":{ } }, "UpdateMalwareScanSettingsRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "ScanResourceCriteria":{ "shape":"ScanResourceCriteria", "documentation":"

Represents the criteria to be used in the filter for selecting resources to scan.

", "locationName":"scanResourceCriteria" }, "EbsSnapshotPreservation":{ "shape":"EbsSnapshotPreservation", "documentation":"

An enum value representing possible snapshot preservation settings.

", "locationName":"ebsSnapshotPreservation" } } }, "UpdateMalwareScanSettingsResponse":{ "type":"structure", "members":{ } }, "UpdateMemberDetectorsRequest":{ "type":"structure", "required":[ "DetectorId", "AccountIds" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The detector ID of the administrator account.

", "location":"uri", "locationName":"detectorId" }, "AccountIds":{ "shape":"AccountIds", "documentation":"

A list of member account IDs to be updated.

", "locationName":"accountIds" }, "DataSources":{ "shape":"DataSourceConfigurations", "documentation":"

Describes which data sources will be updated.

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Features":{ "shape":"MemberFeaturesConfigurations", "documentation":"

A list of features that will be updated for the specified member accounts.

", "locationName":"features" } } }, "UpdateMemberDetectorsResponse":{ "type":"structure", "required":["UnprocessedAccounts"], "members":{ "UnprocessedAccounts":{ "shape":"UnprocessedAccounts", "documentation":"

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

", "locationName":"unprocessedAccounts" } } }, "UpdateOrganizationConfigurationRequest":{ "type":"structure", "required":["DetectorId"], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

The ID of the detector that configures the delegated administrator.

", "location":"uri", "locationName":"detectorId" }, "AutoEnable":{ "shape":"Boolean", "documentation":"

Represents whether or not to automatically enable member accounts in the organization.

Even though this is still supported, we recommend using `AutoEnableOrganizationMembers` to achieve the similar results. You must provide a value for either `autoEnableOrganizationMembers` or `autoEnable`.

", "deprecated":true, "deprecatedMessage":"This field is deprecated, use AutoEnableOrganizationMembers instead", "locationName":"autoEnable" }, "DataSources":{ "shape":"OrganizationDataSourceConfigurations", "documentation":"

Describes which data sources will be updated.

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Features":{ "shape":"OrganizationFeaturesConfigurations", "documentation":"

A list of features that will be configured for the organization.

", "locationName":"features" }, "AutoEnableOrganizationMembers":{ "shape":"AutoEnableMembers", "documentation":"

Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either `autoEnableOrganizationMembers` or `autoEnable`.

Use one of the following configuration values for `autoEnableOrganizationMembers`:

- `NEW`: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically.

- `ALL`: Indicates that all accounts in the organization have GuardDuty enabled automatically. This includes `NEW` accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

  It may take up to 24 hours to update the configuration for all the member accounts.

- `NONE`: Indicates that GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.

", "locationName":"autoEnableOrganizationMembers" } } }, "UpdateOrganizationConfigurationResponse":{ "type":"structure", "members":{ } }, "UpdatePublishingDestinationRequest":{ "type":"structure", "required":[ "DetectorId", "DestinationId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "DestinationId":{ "shape":"String", "documentation":"

The ID of the publishing destination to update.

", "location":"uri", "locationName":"destinationId" }, "DestinationProperties":{ "shape":"DestinationProperties", "documentation":"

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

", "locationName":"destinationProperties" } } }, "UpdatePublishingDestinationResponse":{ "type":"structure", "members":{ } }, "UpdateThreatIntelSetRequest":{ "type":"structure", "required":[ "DetectorId", "ThreatIntelSetId" ], "members":{ "DetectorId":{ "shape":"DetectorId", "documentation":"

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

", "location":"uri", "locationName":"detectorId" }, "ThreatIntelSetId":{ "shape":"String", "documentation":"

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

", "location":"uri", "locationName":"threatIntelSetId" }, "Name":{ "shape":"Name", "documentation":"

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

", "locationName":"name" }, "Location":{ "shape":"Location", "documentation":"

The updated URI of the file that contains the ThreateIntelSet.

", "locationName":"location" }, "Activate":{ "shape":"Boolean", "documentation":"

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

", "locationName":"activate" } } }, "UpdateThreatIntelSetResponse":{ "type":"structure", "members":{ } }, "UsageAccountResult":{ "type":"structure", "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The Account ID that generated usage.

", "locationName":"accountId" }, "Total":{ "shape":"Total", "documentation":"

Represents the total of usage for the Account ID.

", "locationName":"total" } }, "documentation":"

Contains information on the total of usage based on account IDs.

" }, "UsageAccountResultList":{ "type":"list", "member":{"shape":"UsageAccountResult"} }, "UsageCriteria":{ "type":"structure", "members":{ "AccountIds":{ "shape":"AccountIds", "documentation":"

The account IDs to aggregate usage statistics from.

", "locationName":"accountIds" }, "DataSources":{ "shape":"DataSourceList", "documentation":"

The data sources to aggregate usage statistics from.

", "deprecated":true, "deprecatedMessage":"This parameter is deprecated, use Features instead", "locationName":"dataSources" }, "Resources":{ "shape":"ResourceList", "documentation":"

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

", "locationName":"resources" }, "Features":{ "shape":"UsageFeatureList", "documentation":"

The features to aggregate usage statistics from.

", "locationName":"features" } }, "documentation":"

Contains information about the criteria used to query usage statistics.

" }, "UsageDataSourceResult":{ "type":"structure", "members":{ "DataSource":{ "shape":"DataSource", "documentation":"

The data source type that generated usage.

", "locationName":"dataSource" }, "Total":{ "shape":"Total", "documentation":"

Represents the total of usage for the specified data source.

", "locationName":"total" } }, "documentation":"

Contains information on the result of usage based on data source type.

" }, "UsageDataSourceResultList":{ "type":"list", "member":{"shape":"UsageDataSourceResult"} }, "UsageFeature":{ "type":"string", "enum":[ "FLOW_LOGS", "CLOUD_TRAIL", "DNS_LOGS", "S3_DATA_EVENTS", "EKS_AUDIT_LOGS", "EBS_MALWARE_PROTECTION", "RDS_LOGIN_EVENTS", "LAMBDA_NETWORK_LOGS", "EKS_RUNTIME_MONITORING", "FARGATE_RUNTIME_MONITORING", "EC2_RUNTIME_MONITORING" ] }, "UsageFeatureList":{ "type":"list", "member":{"shape":"UsageFeature"} }, "UsageFeatureResult":{ "type":"structure", "members":{ "Feature":{ "shape":"UsageFeature", "documentation":"

The feature that generated the usage cost.

", "locationName":"feature" }, "Total":{ "shape":"Total", "locationName":"total" } }, "documentation":"

Contains information about the result of the total usage based on the feature.

" }, "UsageFeatureResultList":{ "type":"list", "member":{"shape":"UsageFeatureResult"} }, "UsageResourceResult":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The Amazon Web Services resource that generated usage.

", "locationName":"resource" }, "Total":{ "shape":"Total", "documentation":"

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

", "locationName":"total" } }, "documentation":"

Contains information on the sum of usage based on an Amazon Web Services resource.

" }, "UsageResourceResultList":{ "type":"list", "member":{"shape":"UsageResourceResult"} }, "UsageStatisticType":{ "type":"string", "enum":[ "SUM_BY_ACCOUNT", "SUM_BY_DATA_SOURCE", "SUM_BY_RESOURCE", "TOP_RESOURCES", "SUM_BY_FEATURES", "TOP_ACCOUNTS_BY_FEATURE" ] }, "UsageStatistics":{ "type":"structure", "members":{ "SumByAccount":{ "shape":"UsageAccountResultList", "documentation":"

The usage statistic sum organized by account ID.

", "locationName":"sumByAccount" }, "TopAccountsByFeature":{ "shape":"UsageTopAccountsResultList", "documentation":"

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

Currently, this doesn't support `RDS_LOGIN_EVENTS`.

", "locationName":"topAccountsByFeature" }, "SumByDataSource":{ "shape":"UsageDataSourceResultList", "documentation":"

The usage statistic sum organized by on data source.

", "locationName":"sumByDataSource" }, "SumByResource":{ "shape":"UsageResourceResultList", "documentation":"

The usage statistic sum organized by resource.

", "locationName":"sumByResource" }, "TopResources":{ "shape":"UsageResourceResultList", "documentation":"

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

", "locationName":"topResources" }, "SumByFeature":{ "shape":"UsageFeatureResultList", "documentation":"

The usage statistic sum organized by feature.

", "locationName":"sumByFeature" } }, "documentation":"

Contains the result of GuardDuty usage. If a UsageStatisticType is provided the result for other types will be null.

" }, "UsageTopAccountResult":{ "type":"structure", "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

The unique account ID.

", "locationName":"accountId" }, "Total":{ "shape":"Total", "locationName":"total" } }, "documentation":"

Contains information on the total of usage based on the topmost 50 account IDs.

" }, "UsageTopAccountsByFeatureList":{ "type":"list", "member":{"shape":"UsageTopAccountResult"} }, "UsageTopAccountsResult":{ "type":"structure", "members":{ "Feature":{ "shape":"UsageFeature", "documentation":"

Features by which you can generate the usage statistics.

`RDS_LOGIN_EVENTS` is currently not supported with `topAccountsByFeature`.

", "locationName":"feature" }, "Accounts":{ "shape":"UsageTopAccountsByFeatureList", "documentation":"

The accounts that contributed to the total usage cost.

", "locationName":"accounts" } }, "documentation":"

Information about the usage statistics, calculated by top accounts by feature.

" }, "UsageTopAccountsResultList":{ "type":"list", "member":{"shape":"UsageTopAccountsResult"} }, "Volume":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

Volume name.

", "locationName":"name" }, "HostPath":{ "shape":"HostPath", "documentation":"

Represents a pre-existing file or directory on the host machine that the volume maps to.

", "locationName":"hostPath" } }, "documentation":"

Volume used by the Kubernetes workload.

" }, "VolumeDetail":{ "type":"structure", "members":{ "VolumeArn":{ "shape":"String", "documentation":"

EBS volume Arn information.

", "locationName":"volumeArn" }, "VolumeType":{ "shape":"String", "documentation":"

The EBS volume type.

", "locationName":"volumeType" }, "DeviceName":{ "shape":"String", "documentation":"

The device name for the EBS volume.

", "locationName":"deviceName" }, "VolumeSizeInGB":{ "shape":"Integer", "documentation":"

EBS volume size in GB.

", "locationName":"volumeSizeInGB" }, "EncryptionType":{ "shape":"String", "documentation":"

EBS volume encryption type.

", "locationName":"encryptionType" }, "SnapshotArn":{ "shape":"String", "documentation":"

Snapshot Arn of the EBS volume.

", "locationName":"snapshotArn" }, "KmsKeyArn":{ "shape":"String", "documentation":"

KMS key Arn used to encrypt the EBS volume.

", "locationName":"kmsKeyArn" } }, "documentation":"

Contains EBS volume details.

" }, "VolumeDetails":{ "type":"list", "member":{"shape":"VolumeDetail"} }, "VolumeMount":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

Volume mount name.

", "locationName":"name" }, "MountPath":{ "shape":"String", "documentation":"

Volume mount path.

", "locationName":"mountPath" } }, "documentation":"

Container volume mount.

" }, "VolumeMounts":{ "type":"list", "member":{"shape":"VolumeMount"} }, "Volumes":{ "type":"list", "member":{"shape":"Volume"} }, "VpcConfig":{ "type":"structure", "members":{ "SubnetIds":{ "shape":"SubnetIds", "documentation":"

The identifiers of the subnets that are associated with your Lambda function.

", "locationName":"subnetIds" }, "VpcId":{ "shape":"String", "documentation":"

The identifier of the Amazon Virtual Private Cloud.

", "locationName":"vpcId" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The identifier of the security group attached to the Lambda function.

", "locationName":"securityGroups" } }, "documentation":"

Amazon Virtual Private Cloud configuration details associated with your Lambda function.

" } }, "documentation":"

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.

GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as unauthorized infrastructure deployments like 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 about the status of your Amazon Web Services environment by producing security findings that you can view in the GuardDuty console or through Amazon EventBridge. For more information, see the Amazon GuardDuty User Guide .

" }