Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event logs, EKS audit logs, DNS logs, and Amazon EBS volume data. 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 .
' x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: guardduty x-aws-signingName: guardduty x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/guardduty-2017-11-28.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://guardduty.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon GuardDuty multi-region endpoint - url: https://guardduty.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon GuardDuty multi-region endpoint - url: http://guardduty.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon GuardDuty endpoint for China (Beijing) and China (Ningxia) - url: https://guardduty.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon GuardDuty endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Detector paths: /detector/{detectorId}/administrator: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: AcceptAdministratorInvitation description: Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AcceptAdministratorInvitationResponse' examples: AcceptAdministratorInvitation200Example: summary: Default AcceptAdministratorInvitation 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: AcceptAdministratorInvitation480Example: summary: Default AcceptAdministratorInvitation 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: AcceptAdministratorInvitation481Example: summary: Default AcceptAdministratorInvitation 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector of the GuardDuty member account. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object required: - administratorId - invitationId properties: administratorId: description: The account ID of the GuardDuty administrator account whose invitation you're accepting. type: string invitationId: description: The value that is used to validate the administrator account to the member account. type: string summary: Amazon GuardDuty Accept Administrator Invitation x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector get: operationId: GetAdministratorAccount description: Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetAdministratorAccountResponse' examples: GetAdministratorAccount200Example: summary: Default GetAdministratorAccount 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetAdministratorAccount480Example: summary: Default GetAdministratorAccount 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetAdministratorAccount481Example: summary: Default GetAdministratorAccount 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector of the GuardDuty member account. schema: type: string minLength: 1 maxLength: 300 summary: Amazon GuardDuty Get Administrator Account x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/master: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: deprecated: true operationId: AcceptInvitation description: Accepts the invitation to be monitored by a GuardDuty administrator account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AcceptInvitationResponse' examples: AcceptInvitation200Example: summary: Default AcceptInvitation 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: AcceptInvitation480Example: summary: Default AcceptInvitation 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: AcceptInvitation481Example: summary: Default AcceptInvitation 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector of the GuardDuty member account. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object required: - masterId - invitationId properties: masterId: description: The account ID of the GuardDuty administrator account whose invitation you're accepting. type: string invitationId: description: The value that is used to validate the administrator account to the member account. type: string summary: Amazon GuardDuty Accept Invitation x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector get: deprecated: true operationId: GetMasterAccount description: Provides the details for the GuardDuty administrator account associated with the current GuardDuty member account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMasterAccountResponse' examples: GetMasterAccount200Example: summary: Default GetMasterAccount 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetMasterAccount480Example: summary: Default GetMasterAccount 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetMasterAccount481Example: summary: Default GetMasterAccount 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector of the GuardDuty member account. schema: type: string minLength: 1 maxLength: 300 summary: Amazon GuardDuty Get Master Account x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/findings/archive: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ArchiveFindings description: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.
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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateDetectorResponse' examples: CreateDetector200Example: summary: Default CreateDetector 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateDetector480Example: summary: Default CreateDetector 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateDetector481Example: summary: Default CreateDetector 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: [] requestBody: required: true content: application/json: schema: type: object required: - enable properties: enable: description: A Boolean value that specifies whether the detector is to be enabled. type: boolean clientToken: description: The idempotency token for the create request. type: string minLength: 0 maxLength: 64 findingPublishingFrequency: description: A value that specifies how frequently updated findings are exported. type: string enum: - FIFTEEN_MINUTES - ONE_HOUR - SIX_HOURS dataSources: description: Contains information about which data sources are enabled. type: object properties: S3Logs: allOf: - $ref: '#/components/schemas/S3LogsConfiguration' - xml: name: s3Logs description: Describes whether S3 data event logs are enabled as a data source. Kubernetes: allOf: - $ref: '#/components/schemas/KubernetesConfiguration' - xml: name: kubernetes description: Describes whether any Kubernetes logs are enabled as data sources. MalwareProtection: allOf: - $ref: '#/components/schemas/MalwareProtectionConfiguration' - xml: name: malwareProtection description: Describes whether Malware Protection is enabled as a data source. tags: description: The tags to be added to a new detector resource. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: '#/components/schemas/TagValue' features: description: A list of features that will be configured for the detector. type: array items: $ref: '#/components/schemas/DetectorFeatureConfiguration' summary: Amazon GuardDuty Create Detector x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector get: operationId: ListDetectors description: Lists detectorIds of all the existing Amazon GuardDuty detector resources. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListDetectorsResponse' examples: ListDetectors200Example: summary: Default ListDetectors 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListDetectors480Example: summary: Default ListDetectors 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListDetectors481Example: summary: Default ListDetectors 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: maxResults in: query required: false description: 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. schema: type: integer minimum: 1 maximum: 50 - name: nextToken in: query required: false description: 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. schema: type: string - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon GuardDuty List Detectors x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/filter: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateFilter description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFilterResponse' examples: CreateFilter200Example: summary: Default CreateFilter 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateFilter480Example: summary: Default CreateFilter 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateFilter481Example: summary: Default CreateFilter 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The ID of the detector belonging to the GuardDuty account that you want to create a filter for. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object required: - name - findingCriteria properties: name: description: The name of the filter. Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character. type: string minLength: 3 maxLength: 64 description: description: 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.
type: string
minLength: 0
maxLength: 512
action:
description: Specifies the action that is to be applied to the findings that match the filter.
type: string
enum:
- NOOP
- ARCHIVE
minLength: 1
maxLength: 300
rank:
description: 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.
type: integer
minimum: 1
maximum: 100
findingCriteria:
description: Contains information about the criteria used for querying findings.
type: object
properties:
Criterion:
allOf:
- $ref: '#/components/schemas/Criterion'
- xml:
name: criterion
description: Represents a map of finding properties that match specified conditions and values when querying findings.
clientToken:
description: The idempotency token for the create request.
type: string
minLength: 0
maxLength: 64
tags:
description: The tags to be added to a new filter resource.
type: object
minProperties: 1
maxProperties: 200
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon GuardDuty Create Filter
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
get:
operationId: ListFilters
description: Returns a paginated list of the current filters.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFiltersResponse'
examples:
ListFilters200Example:
summary: Default ListFilters 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListFilters480Example:
summary: Default ListFilters 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListFilters481Example:
summary: Default ListFilters 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector that the filter is associated with.
schema:
type: string
minLength: 1
maxLength: 300
- name: maxResults
in: query
required: false
description: 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.
schema:
type: integer
minimum: 1
maximum: 50
- name: nextToken
in: query
required: false
description: 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.
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon GuardDuty List Filters
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/ipset:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateIPSet
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIPSetResponse'
examples:
CreateIPSet200Example:
summary: Default CreateIPSet 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreateIPSet480Example:
summary: Default CreateIPSet 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateIPSet481Example:
summary: Default CreateIPSet 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.
schema:
type: string
minLength: 1
maxLength: 300
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- format
- location
- activate
properties:
name:
description: The user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
type: string minLength: 1 maxLength: 300 format: description: The format of the file that contains the IPSet. type: string enum: - TXT - STIX - OTX_CSV - ALIEN_VAULT - PROOF_POINT - FIRE_EYE minLength: 1 maxLength: 300 location: description: 'The URI of the file that contains the IPSet. ' type: string minLength: 1 maxLength: 300 activate: description: A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet. type: boolean clientToken: description: The idempotency token for the create request. type: string minLength: 0 maxLength: 64 tags: description: The tags to be added to a new IP set resource. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: '#/components/schemas/TagValue' summary: Amazon GuardDuty Create I P Set x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector get: operationId: ListIPSets description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListIPSetsResponse' examples: ListIPSets200Example: summary: Default ListIPSets 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListIPSets480Example: summary: Default ListIPSets 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListIPSets481Example: summary: Default ListIPSets 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector that the IPSet is associated with. schema: type: string minLength: 1 maxLength: 300 - name: maxResults in: query required: false description: 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. schema: type: integer minimum: 1 maximum: 50 - name: nextToken in: query required: false description: 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. schema: type: string - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon GuardDuty List I P Sets x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/member: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateMembers description: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.
When using Create Members as an organizations delegated administrator this action will enable GuardDuty in the added member accounts, with the exception of the organization delegated administrator account, which must enable GuardDuty prior to being added as a member.
If you are adding accounts by invitation, use this action after GuardDuty has bee enabled in potential member accounts and before using InviteMembers.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMembersResponse' examples: CreateMembers200Example: summary: Default CreateMembers 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateMembers480Example: summary: Default CreateMembers 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateMembers481Example: summary: Default CreateMembers 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector of the GuardDuty account that you want to associate member accounts with. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object required: - accountDetails properties: accountDetails: description: A list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account. type: array items: $ref: '#/components/schemas/AccountDetail' minItems: 1 maxItems: 50 summary: Amazon GuardDuty Create Members x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector get: operationId: ListMembers description: Lists details about all member accounts for the current GuardDuty administrator account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListMembersResponse' examples: ListMembers200Example: summary: Default ListMembers 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListMembers480Example: summary: Default ListMembers 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListMembers481Example: summary: Default ListMembers 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector the member is associated with. schema: type: string minLength: 1 maxLength: 300 - name: maxResults in: query required: false description: 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. schema: type: integer minimum: 1 maximum: 50 - name: nextToken in: query required: false description: 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. schema: type: string - name: onlyAssociated in: query required: false description: '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 usingCreate Members . '
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon GuardDuty List Members
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/publishingDestination:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreatePublishingDestination
description: Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePublishingDestinationResponse'
examples:
CreatePublishingDestination200Example:
summary: Default CreatePublishingDestination 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreatePublishingDestination480Example:
summary: Default CreatePublishingDestination 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreatePublishingDestination481Example:
summary: Default CreatePublishingDestination 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The ID of the GuardDuty detector associated with the publishing destination.
schema:
type: string
minLength: 1
maxLength: 300
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- destinationType
- destinationProperties
properties:
destinationType:
description: The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.
type: string
enum:
- S3
minLength: 1
maxLength: 300
destinationProperties:
description: 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.
type: object
properties:
DestinationArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationArn
description: '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/
detectorId.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListPublishingDestinationsResponse'
examples:
ListPublishingDestinations200Example:
summary: Default ListPublishingDestinations 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListPublishingDestinations480Example:
summary: Default ListPublishingDestinations 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListPublishingDestinations481Example:
summary: Default ListPublishingDestinations 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The ID of the detector to retrieve publishing destinations for.
schema:
type: string
minLength: 1
maxLength: 300
- name: maxResults
in: query
required: false
description: The maximum number of results to return in the response.
schema:
type: integer
minimum: 1
maximum: 50
- name: nextToken
in: query
required: false
description: 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.
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon GuardDuty List Publishing Destinations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/findings/create:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateSampleFindings
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSampleFindingsResponse'
examples:
CreateSampleFindings200Example:
summary: Default CreateSampleFindings 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreateSampleFindings480Example:
summary: Default CreateSampleFindings 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateSampleFindings481Example:
summary: Default CreateSampleFindings 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The ID of the detector to create sample findings for.
schema:
type: string
minLength: 1
maxLength: 300
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
findingTypes:
description: The types of sample findings to generate.
type: array
items:
$ref: '#/components/schemas/FindingType'
minItems: 0
maxItems: 50
summary: Amazon GuardDuty Create Sample Findings
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/threatintelset:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateThreatIntelSet
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateThreatIntelSetResponse'
examples:
CreateThreatIntelSet200Example:
summary: Default CreateThreatIntelSet 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreateThreatIntelSet480Example:
summary: Default CreateThreatIntelSet 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateThreatIntelSet481Example:
summary: Default CreateThreatIntelSet 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for.
schema:
type: string
minLength: 1
maxLength: 300
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- format
- location
- activate
properties:
name:
description: A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.
type: string
minLength: 1
maxLength: 300
format:
description: The format of the file that contains the ThreatIntelSet.
type: string
enum:
- TXT
- STIX
- OTX_CSV
- ALIEN_VAULT
- PROOF_POINT
- FIRE_EYE
minLength: 1
maxLength: 300
location:
description: 'The URI of the file that contains the ThreatIntelSet. '
type: string
minLength: 1
maxLength: 300
activate:
description: A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.
type: boolean
clientToken:
description: The idempotency token for the create request.
type: string
minLength: 0
maxLength: 64
tags:
description: The tags to be added to a new threat list resource.
type: object
minProperties: 1
maxProperties: 200
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon GuardDuty Create Threat Intel Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
get:
operationId: ListThreatIntelSets
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListThreatIntelSetsResponse'
examples:
ListThreatIntelSets200Example:
summary: Default ListThreatIntelSets 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListThreatIntelSets480Example:
summary: Default ListThreatIntelSets 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListThreatIntelSets481Example:
summary: Default ListThreatIntelSets 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector that the threatIntelSet is associated with.
schema:
type: string
minLength: 1
maxLength: 300
- name: maxResults
in: query
required: false
description: 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.
schema:
type: integer
minimum: 1
maximum: 50
- name: nextToken
in: query
required: false
description: 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.
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon GuardDuty List Threat Intel Sets
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteDetector
description: Deletes an Amazon GuardDuty detector that is specified by the detector ID.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDetectorResponse'
examples:
DeleteDetector200Example:
summary: Default DeleteDetector 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
DeleteDetector480Example:
summary: Default DeleteDetector 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DeleteDetector481Example:
summary: Default DeleteDetector 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector that you want to delete.
schema:
type: string
minLength: 1
maxLength: 300
summary: Amazon GuardDuty Delete Detector
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
get:
operationId: GetDetector
description: 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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDetectorResponse' examples: GetDetector200Example: summary: Default GetDetector 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetDetector480Example: summary: Default GetDetector 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetDetector481Example: summary: Default GetDetector 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector that you want to get. schema: type: string minLength: 1 maxLength: 300 summary: Amazon GuardDuty Get Detector x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector post: operationId: UpdateDetector description: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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateDetectorResponse' examples: UpdateDetector200Example: summary: Default UpdateDetector 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateDetector480Example: summary: Default UpdateDetector 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateDetector481Example: summary: Default UpdateDetector 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector to update. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object properties: enable: description: Specifies whether the detector is enabled or not enabled. type: boolean findingPublishingFrequency: description: An enum value that specifies how frequently findings are exported, such as to CloudWatch Events. type: string enum: - FIFTEEN_MINUTES - ONE_HOUR - SIX_HOURS dataSources: description: Contains information about which data sources are enabled. type: object properties: S3Logs: allOf: - $ref: '#/components/schemas/S3LogsConfiguration' - xml: name: s3Logs description: Describes whether S3 data event logs are enabled as a data source. Kubernetes: allOf: - $ref: '#/components/schemas/KubernetesConfiguration' - xml: name: kubernetes description: Describes whether any Kubernetes logs are enabled as data sources. MalwareProtection: allOf: - $ref: '#/components/schemas/MalwareProtectionConfiguration' - xml: name: malwareProtection description: Describes whether Malware Protection is enabled as a data source. features: description: Provides the features that will be updated for the detector. type: array items: $ref: '#/components/schemas/DetectorFeatureConfiguration' summary: Amazon GuardDuty Update Detector x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/filter/{filterName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteFilter description: Deletes the filter specified by the filter name. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteFilterResponse' examples: DeleteFilter200Example: summary: Default DeleteFilter 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteFilter480Example: summary: Default DeleteFilter 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteFilter481Example: summary: Default DeleteFilter 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector that the filter is associated with. schema: type: string minLength: 1 maxLength: 300 - name: filterName in: path required: true description: The name of the filter that you want to delete. schema: type: string summary: Amazon GuardDuty Delete Filter x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector get: operationId: GetFilter description: Returns the details of the filter specified by the filter name. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetFilterResponse' examples: GetFilter200Example: summary: Default GetFilter 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetFilter480Example: summary: Default GetFilter 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetFilter481Example: summary: Default GetFilter 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector that the filter is associated with. schema: type: string minLength: 1 maxLength: 300 - name: filterName in: path required: true description: The name of the filter you want to get. schema: type: string summary: Amazon GuardDuty Get Filter x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector post: operationId: UpdateFilter description: Updates the filter specified by the filter name. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateFilterResponse' examples: UpdateFilter200Example: summary: Default UpdateFilter 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateFilter480Example: summary: Default UpdateFilter 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateFilter481Example: summary: Default UpdateFilter 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector that specifies the GuardDuty service where you want to update a filter. schema: type: string minLength: 1 maxLength: 300 - name: filterName in: path required: true description: The name of the filter. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: description: description: 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.
type: string
minLength: 0
maxLength: 512
action:
description: Specifies the action that is to be applied to the findings that match the filter.
type: string
enum:
- NOOP
- ARCHIVE
minLength: 1
maxLength: 300
rank:
description: 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.
type: integer
minimum: 1
maximum: 100
findingCriteria:
description: Contains information about the criteria used for querying findings.
type: object
properties:
Criterion:
allOf:
- $ref: '#/components/schemas/Criterion'
- xml:
name: criterion
description: Represents a map of finding properties that match specified conditions and values when querying findings.
summary: Amazon GuardDuty Update Filter
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/ipset/{ipSetId}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteIPSet
description: Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteIPSetResponse'
examples:
DeleteIPSet200Example:
summary: Default DeleteIPSet 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
DeleteIPSet480Example:
summary: Default DeleteIPSet 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DeleteIPSet481Example:
summary: Default DeleteIPSet 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector associated with the IPSet.
schema:
type: string
minLength: 1
maxLength: 300
- name: ipSetId
in: path
required: true
description: The unique ID of the IPSet to delete.
schema:
type: string
summary: Amazon GuardDuty Delete I P Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
get:
operationId: GetIPSet
description: Retrieves the IPSet specified by the ipSetId.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetIPSetResponse'
examples:
GetIPSet200Example:
summary: Default GetIPSet 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
GetIPSet480Example:
summary: Default GetIPSet 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
GetIPSet481Example:
summary: Default GetIPSet 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector that the IPSet is associated with.
schema:
type: string
minLength: 1
maxLength: 300
- name: ipSetId
in: path
required: true
description: The unique ID of the IPSet to retrieve.
schema:
type: string
summary: Amazon GuardDuty Get I P Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
post:
operationId: UpdateIPSet
description: Updates the IPSet specified by the IPSet ID.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateIPSetResponse'
examples:
UpdateIPSet200Example:
summary: Default UpdateIPSet 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
UpdateIPSet480Example:
summary: Default UpdateIPSet 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
UpdateIPSet481Example:
summary: Default UpdateIPSet 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The detectorID that specifies the GuardDuty service whose IPSet you want to update.
schema:
type: string
minLength: 1
maxLength: 300
- name: ipSetId
in: path
required: true
description: The unique ID that specifies the IPSet that you want to update.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
description: The unique ID that specifies the IPSet that you want to update.
type: string
minLength: 1
maxLength: 300
location:
description: 'The updated URI of the file that contains the IPSet. '
type: string
minLength: 1
maxLength: 300
activate:
description: The updated Boolean value that specifies whether the IPSet is active or not.
type: boolean
summary: Amazon GuardDuty Update I P Set
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/member/delete:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteMembers
description: 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.
destinationId.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePublishingDestinationResponse'
examples:
DeletePublishingDestination200Example:
summary: Default DeletePublishingDestination 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
DeletePublishingDestination480Example:
summary: Default DeletePublishingDestination 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DeletePublishingDestination481Example:
summary: Default DeletePublishingDestination 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector associated with the publishing destination to delete.
schema:
type: string
minLength: 1
maxLength: 300
- name: destinationId
in: path
required: true
description: The ID of the publishing destination to delete.
schema:
type: string
summary: Amazon GuardDuty Delete Publishing Destination
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
get:
operationId: DescribePublishingDestination
description: Returns information about the publishing destination specified by the provided destinationId.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribePublishingDestinationResponse'
examples:
DescribePublishingDestination200Example:
summary: Default DescribePublishingDestination 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
DescribePublishingDestination480Example:
summary: Default DescribePublishingDestination 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DescribePublishingDestination481Example:
summary: Default DescribePublishingDestination 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector associated with the publishing destination to retrieve.
schema:
type: string
minLength: 1
maxLength: 300
- name: destinationId
in: path
required: true
description: The ID of the publishing destination to retrieve.
schema:
type: string
summary: Amazon GuardDuty Describe Publishing Destination
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
post:
operationId: UpdatePublishingDestination
description: Updates information about the publishing destination specified by the destinationId.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePublishingDestinationResponse'
examples:
UpdatePublishingDestination200Example:
summary: Default UpdatePublishingDestination 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
UpdatePublishingDestination480Example:
summary: Default UpdatePublishingDestination 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
UpdatePublishingDestination481Example:
summary: Default UpdatePublishingDestination 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The ID of the detector associated with the publishing destinations to update.
schema:
type: string
minLength: 1
maxLength: 300
- name: destinationId
in: path
required: true
description: The ID of the publishing destination to update.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
destinationProperties:
description: 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.
type: object
properties:
DestinationArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationArn
description: '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/
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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeMalwareScansResponse' examples: DescribeMalwareScans200Example: summary: Default DescribeMalwareScans 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeMalwareScans480Example: summary: Default DescribeMalwareScans 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeMalwareScans481Example: summary: Default DescribeMalwareScans 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector that the request is associated with. schema: type: string minLength: 1 maxLength: 300 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: 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. type: string maxResults: description: 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. type: integer minimum: 1 maximum: 50 filterCriteria: description: Represents the criteria to be used in the filter for describing scan entries. type: object properties: FilterCriterion: allOf: - $ref: '#/components/schemas/FilterCriterionList' - xml: name: filterCriterion description: Represents a condition that when matched will be added to the response of the operation. sortCriteria: description: Contains information about the criteria used for sorting findings. type: object properties: AttributeName: allOf: - $ref: '#/components/schemas/String' - xml: name: attributeName description: Represents the finding attribute, such asaccountId, that sorts the findings.
OrderBy:
allOf:
- $ref: '#/components/schemas/OrderBy'
- xml:
name: orderBy
description: The order by which the sorted findings are to be displayed.
summary: Amazon GuardDuty Describe Malware Scans
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/admin:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: DescribeOrganizationConfiguration
description: 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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeOrganizationConfigurationResponse' examples: DescribeOrganizationConfiguration200Example: summary: Default DescribeOrganizationConfiguration 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeOrganizationConfiguration480Example: summary: Default DescribeOrganizationConfiguration 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeOrganizationConfiguration481Example: summary: Default DescribeOrganizationConfiguration 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The ID of the detector to retrieve information about the delegated administrator from. schema: type: string minLength: 1 maxLength: 300 - name: maxResults in: query required: false description: You can use this parameter to indicate the maximum number of items that you want in the response. schema: type: integer minimum: 1 maximum: 50 - name: nextToken in: query required: false description: 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, fillnextToken in the request with the value of NextToken from the previous response to continue listing data.
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon GuardDuty Describe Organization Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
post:
operationId: UpdateOrganizationConfiguration
description: Configures the delegated administrator account with the provided values. You must provide the value for either autoEnableOrganizationMembers or autoEnable.
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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateOrganizationConfigurationResponse' examples: UpdateOrganizationConfiguration200Example: summary: Default UpdateOrganizationConfiguration 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateOrganizationConfiguration480Example: summary: Default UpdateOrganizationConfiguration 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateOrganizationConfiguration481Example: summary: Default UpdateOrganizationConfiguration 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The ID of the detector that configures the delegated administrator. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object properties: autoEnable: description:Indicates whether to automatically enable member accounts in the organization.
Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results.
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 Amazon Web Services 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 accounts in the organization. GuardDuty must be managed for each account individually by the administrator.
Disassociates the current GuardDuty member account from its administrator account.
With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disable GuardDuty in a member account.
Disassociates GuardDuty member accounts (to the current 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 disassociate a member account before removing them from your Amazon Web Services organization.
accountId, that sorts the findings.
OrderBy:
allOf:
- $ref: '#/components/schemas/OrderBy'
- xml:
name: orderBy
description: The order by which the sorted findings are to be displayed.
summary: Amazon GuardDuty Get Findings
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/findings/statistics:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetFindingsStatistics
description: Lists Amazon GuardDuty findings statistics for the specified detector ID.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetFindingsStatisticsResponse'
examples:
GetFindingsStatistics200Example:
summary: Default GetFindingsStatistics 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
GetFindingsStatistics480Example:
summary: Default GetFindingsStatistics 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
GetFindingsStatistics481Example:
summary: Default GetFindingsStatistics 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.
schema:
type: string
minLength: 1
maxLength: 300
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- findingStatisticTypes
properties:
findingStatisticTypes:
description: The types of finding statistics to retrieve.
type: array
items:
$ref: '#/components/schemas/FindingStatisticType'
minItems: 0
maxItems: 10
findingCriteria:
description: Contains information about the criteria used for querying findings.
type: object
properties:
Criterion:
allOf:
- $ref: '#/components/schemas/Criterion'
- xml:
name: criterion
description: Represents a map of finding properties that match specified conditions and values when querying findings.
summary: Amazon GuardDuty Get Findings Statistics
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/malware-scan-settings:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetMalwareScanSettings
description: 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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMalwareScanSettingsResponse' examples: GetMalwareScanSettings200Example: summary: Default GetMalwareScanSettings 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetMalwareScanSettings480Example: summary: Default GetMalwareScanSettings 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetMalwareScanSettings481Example: summary: Default GetMalwareScanSettings 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector that the scan setting is associated with. schema: type: string minLength: 1 maxLength: 300 summary: Amazon GuardDuty Get Malware Scan Settings x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector post: operationId: UpdateMalwareScanSettings description: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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateMalwareScanSettingsResponse' examples: UpdateMalwareScanSettings200Example: summary: Default UpdateMalwareScanSettings 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateMalwareScanSettings480Example: summary: Default UpdateMalwareScanSettings 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateMalwareScanSettings481Example: summary: Default UpdateMalwareScanSettings 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector that specifies the GuardDuty service where you want to update scan settings. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object properties: scanResourceCriteria: description: Contains information about criteria used to filter resources before triggering malware scan. type: object properties: Include: allOf: - $ref: '#/components/schemas/ScanCriterion' - xml: name: include description: Represents condition that when matched will allow a malware scan for a certain resource. Exclude: allOf: - $ref: '#/components/schemas/ScanCriterion' - xml: name: exclude description: Represents condition that when matched will prevent a malware scan for a certain resource. ebsSnapshotPreservation: description: An enum value representing possible snapshot preservation settings. type: string enum: - NO_RETENTION - RETENTION_WITH_FINDING summary: Amazon GuardDuty Update Malware Scan Settings x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/member/detector/get: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetMemberDetectors description: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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMemberDetectorsResponse' examples: GetMemberDetectors200Example: summary: Default GetMemberDetectors 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetMemberDetectors480Example: summary: Default GetMemberDetectors 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetMemberDetectors481Example: summary: Default GetMemberDetectors 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The detector ID for the administrator account. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object required: - accountIds properties: accountIds: description: The account ID of the member account. type: array items: $ref: '#/components/schemas/AccountId' minItems: 1 maxItems: 50 summary: Amazon GuardDuty Get Member Detectors x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/member/get: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetMembers description: Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMembersResponse' examples: GetMembers200Example: summary: Default GetMembers 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetMembers480Example: summary: Default GetMembers 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetMembers481Example: summary: Default GetMembers 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector of the GuardDuty account whose members you want to retrieve. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object required: - accountIds properties: accountIds: description: A list of account IDs of the GuardDuty member accounts that you want to describe. type: array items: $ref: '#/components/schemas/AccountId' minItems: 1 maxItems: 50 summary: Amazon GuardDuty Get Members x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/freeTrial/daysRemaining: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetRemainingFreeTrialDays description: Provides the number of days left for each data source used in the free trial period. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetRemainingFreeTrialDaysResponse' examples: GetRemainingFreeTrialDays200Example: summary: Default GetRemainingFreeTrialDays 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetRemainingFreeTrialDays480Example: summary: Default GetRemainingFreeTrialDays 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetRemainingFreeTrialDays481Example: summary: Default GetRemainingFreeTrialDays 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector of the GuardDuty member account. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object properties: accountIds: description: A list of account identifiers of the GuardDuty member account. type: array items: $ref: '#/components/schemas/AccountId' minItems: 1 maxItems: 50 summary: Amazon GuardDuty Get Remaining Free Trial Days x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/usage/statistics: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetUsageStatistics description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetUsageStatisticsResponse' examples: GetUsageStatistics200Example: summary: Default GetUsageStatistics 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetUsageStatistics480Example: summary: Default GetUsageStatistics 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetUsageStatistics481Example: summary: Default GetUsageStatistics 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve. schema: type: string minLength: 1 maxLength: 300 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - usageStatisticsType - usageCriteria properties: usageStatisticsType: description: The type of usage statistics to retrieve. type: string enum: - SUM_BY_ACCOUNT - SUM_BY_DATA_SOURCE - SUM_BY_RESOURCE - TOP_RESOURCES - SUM_BY_FEATURES usageCriteria: description: Contains information about the criteria used to query usage statistics. type: object properties: AccountIds: allOf: - $ref: '#/components/schemas/AccountIds' - xml: name: accountIds description: The account IDs to aggregate usage statistics from. DataSources: allOf: - $ref: '#/components/schemas/DataSourceList' - deprecated: true xml: name: dataSources description: The data sources to aggregate usage statistics from.This parameter is deprecated, use Features instead Resources: allOf: - $ref: '#/components/schemas/ResourceList' - xml: name: resources description: The resources to aggregate usage statistics from. Only accepts exact resource names. Features: allOf: - $ref: '#/components/schemas/UsageFeatureList' - xml: name: features description: The features to aggregate usage statistics from. unit: description: The currency unit you would like to view your usage statistics in. Current valid values are USD. type: string maxResults: description: The maximum number of results to return in the response. type: integer minimum: 1 maximum: 50 nextToken: description: 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. type: string summary: Amazon GuardDuty Get Usage Statistics x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/member/invite: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: InviteMembers description: Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage these accounts' findings on their behalf as the GuardDuty administrator account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InviteMembersResponse' examples: InviteMembers200Example: summary: Default InviteMembers 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: InviteMembers480Example: summary: Default InviteMembers 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: InviteMembers481Example: summary: Default InviteMembers 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector of the GuardDuty account that you want to invite members with. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object required: - accountIds properties: accountIds: description: A list of account IDs of the accounts that you want to invite to GuardDuty as members. type: array items: $ref: '#/components/schemas/AccountId' minItems: 1 maxItems: 50 disableEmailNotification: description: A Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members. type: boolean message: description: The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members. type: string summary: Amazon GuardDuty Invite Members x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/coverage: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListCoverage description: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 EKS Runtime Monitoring enabled and GuardDuty agent running on their EKS nodes.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCoverageResponse' examples: ListCoverage200Example: summary: Default ListCoverage 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListCoverage480Example: summary: Default ListCoverage 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListCoverage481Example: summary: Default ListCoverage 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The unique ID of the detector whose coverage details you want to retrieve. schema: type: string minLength: 1 maxLength: 300 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: nextToken: description: 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. type: string maxResults: description: The maximum number of results to return in the response. type: integer minimum: 1 maximum: 50 filterCriteria: description: Represents the criteria used in the filter. type: object properties: FilterCriterion: allOf: - $ref: '#/components/schemas/CoverageFilterCriterionList' - xml: name: filterCriterion description: Represents a condition that when matched will be added to the response of the operation. sortCriteria: description: Information about the sorting criteria used in the coverage statistics. type: object properties: AttributeName: allOf: - $ref: '#/components/schemas/CoverageSortKey' - xml: name: attributeName description: Represents the field name used to sort the coverage details. OrderBy: allOf: - $ref: '#/components/schemas/OrderBy' - xml: name: orderBy description: The order in which the sorted findings are to be displayed. summary: Amazon GuardDuty List Coverage x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector /detector/{detectorId}/findings: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListFindings description: Lists Amazon GuardDuty findings for the specified detector ID. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFindingsResponse' examples: ListFindings200Example: summary: Default ListFindings 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListFindings480Example: summary: Default ListFindings 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListFindings481Example: summary: Default ListFindings 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The ID of the detector that specifies the GuardDuty service whose findings you want to list. schema: type: string minLength: 1 maxLength: 300 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: findingCriteria: description: Contains information about the criteria used for querying findings. type: object properties: Criterion: allOf: - $ref: '#/components/schemas/Criterion' - xml: name: criterion description: Represents a map of finding properties that match specified conditions and values when querying findings. sortCriteria: description: Contains information about the criteria used for sorting findings. type: object properties: AttributeName: allOf: - $ref: '#/components/schemas/String' - xml: name: attributeName description: Represents the finding attribute, such asaccountId, that sorts the findings.
OrderBy:
allOf:
- $ref: '#/components/schemas/OrderBy'
- xml:
name: orderBy
description: The order by which the sorted findings are to be displayed.
maxResults:
description: 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.
type: integer
minimum: 1
maximum: 50
nextToken:
description: 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.
type: string
summary: Amazon GuardDuty List Findings
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/member/start:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: StartMonitoringMembers
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartMonitoringMembersResponse'
examples:
StartMonitoringMembers200Example:
summary: Default StartMonitoringMembers 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
StartMonitoringMembers480Example:
summary: Default StartMonitoringMembers 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
StartMonitoringMembers481Example:
summary: Default StartMonitoringMembers 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The unique ID of the detector of the GuardDuty administrator account associated with the member accounts to monitor.
schema:
type: string
minLength: 1
maxLength: 300
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- accountIds
properties:
accountIds:
description: A list of account IDs of the GuardDuty member accounts to start monitoring.
type: array
items:
$ref: '#/components/schemas/AccountId'
minItems: 1
maxItems: 50
summary: Amazon GuardDuty Start Monitoring Members
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/member/stop:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: StopMonitoringMembers
description: 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.
findingIds.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UnarchiveFindingsResponse'
examples:
UnarchiveFindings200Example:
summary: Default UnarchiveFindings 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
UnarchiveFindings480Example:
summary: Default UnarchiveFindings 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
UnarchiveFindings481Example:
summary: Default UnarchiveFindings 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The ID of the detector associated with the findings to unarchive.
schema:
type: string
minLength: 1
maxLength: 300
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- findingIds
properties:
findingIds:
description: The IDs of the findings to unarchive.
type: array
items:
$ref: '#/components/schemas/FindingId'
minItems: 0
maxItems: 50
summary: Amazon GuardDuty Unarchive Findings
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/findings/feedback:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateFindingsFeedback
description: Marks the specified GuardDuty findings as useful or not useful.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFindingsFeedbackResponse'
examples:
UpdateFindingsFeedback200Example:
summary: Default UpdateFindingsFeedback 200 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
UpdateFindingsFeedback480Example:
summary: Default UpdateFindingsFeedback 480 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
UpdateFindingsFeedback481Example:
summary: Default UpdateFindingsFeedback 481 response
x-microcks-default: true
value:
detectorId: abc123
format: DNS_LOGS
parameters:
- name: detectorId
in: path
required: true
description: The ID of the detector associated with the findings to update feedback for.
schema:
type: string
minLength: 1
maxLength: 300
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- findingIds
- feedback
properties:
findingIds:
description: The IDs of the findings that you want to mark as useful or not useful.
type: array
items:
$ref: '#/components/schemas/FindingId'
minItems: 0
maxItems: 50
feedback:
description: The feedback for the finding.
type: string
enum:
- USEFUL
- NOT_USEFUL
comments:
description: Additional feedback about the GuardDuty findings.
type: string
summary: Amazon GuardDuty Update Findings Feedback
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Detector
/detector/{detectorId}/member/detector/update:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateMemberDetectors
description: 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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateMemberDetectorsResponse' examples: UpdateMemberDetectors200Example: summary: Default UpdateMemberDetectors 200 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateMemberDetectors480Example: summary: Default UpdateMemberDetectors 480 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateMemberDetectors481Example: summary: Default UpdateMemberDetectors 481 response x-microcks-default: true value: detectorId: abc123 format: DNS_LOGS parameters: - name: detectorId in: path required: true description: The detector ID of the administrator account. schema: type: string minLength: 1 maxLength: 300 requestBody: required: true content: application/json: schema: type: object required: - accountIds properties: accountIds: description: A list of member account IDs to be updated. type: array items: $ref: '#/components/schemas/AccountId' minItems: 1 maxItems: 50 dataSources: description: Contains information about which data sources are enabled. type: object properties: S3Logs: allOf: - $ref: '#/components/schemas/S3LogsConfiguration' - xml: name: s3Logs description: Describes whether S3 data event logs are enabled as a data source. Kubernetes: allOf: - $ref: '#/components/schemas/KubernetesConfiguration' - xml: name: kubernetes description: Describes whether any Kubernetes logs are enabled as data sources. MalwareProtection: allOf: - $ref: '#/components/schemas/MalwareProtectionConfiguration' - xml: name: malwareProtection description: Describes whether Malware Protection is enabled as a data source. features: description: A list of features that will be updated for the specified member accounts. type: array items: $ref: '#/components/schemas/MemberFeaturesConfiguration' summary: Amazon GuardDuty Update Member Detectors x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Detector components: schemas: VpcConfig: type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - xml: name: subnetIds description: The identifiers of the subnets that are associated with your Lambda function. VpcId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcId description: The identifier of the Amazon Virtual Private Cloud. SecurityGroups: allOf: - $ref: '#/components/schemas/SecurityGroups' - xml: name: securityGroups description: The identifier of the security group attached to the Lambda function. description: Amazon Virtual Private Cloud configuration details associated with your Lambda function. EbsVolumeScanDetails: type: object properties: ScanId: allOf: - $ref: '#/components/schemas/String' - xml: name: scanId description: Unique Id of the malware scan that generated the finding. ScanStartedAt: allOf: - $ref: '#/components/schemas/Timestamp' - xml: name: scanStartedAt description: Returns the start date and time of the malware scan. ScanCompletedAt: allOf: - $ref: '#/components/schemas/Timestamp' - xml: name: scanCompletedAt description: Returns the completion date and time of the malware scan. TriggerFindingId: allOf: - $ref: '#/components/schemas/String' - xml: name: triggerFindingId description: GuardDuty finding ID that triggered a malware scan. Sources: allOf: - $ref: '#/components/schemas/Sources' - xml: name: sources description: Contains list of threat intelligence sources used to detect threats. ScanDetections: allOf: - $ref: '#/components/schemas/ScanDetections' - xml: name: scanDetections description: Contains a complete view providing malware scan result details. description: Contains details from the malware scan that created a finding. AccountDetail: type: object required: - AccountId - Email properties: AccountId: allOf: - $ref: '#/components/schemas/AccountId' - xml: name: accountId description: The member account ID. Email: allOf: - $ref: '#/components/schemas/Email' - xml: name: email description: The email address of the member account. description: Contains information about the account. Master: type: object properties: AccountId: allOf: - $ref: '#/components/schemas/AccountId' - xml: name: accountId description: The ID of the account used as the administrator account. InvitationId: allOf: - $ref: '#/components/schemas/String' - xml: name: invitationId description: The value used to validate the administrator account to the member account. RelationshipStatus: allOf: - $ref: '#/components/schemas/String' - xml: name: relationshipStatus description: The status of the relationship between the administrator and member accounts. InvitedAt: allOf: - $ref: '#/components/schemas/String' - xml: name: invitedAt description: The timestamp when the invitation was sent. description: Contains information about the administrator account and invitation. OrganizationKubernetesConfiguration: type: object required: - AuditLogs properties: AuditLogs: allOf: - $ref: '#/components/schemas/OrganizationKubernetesAuditLogsConfiguration' - xml: name: auditLogs description: Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization. description: Organization-wide Kubernetes data sources configurations. UsageAccountResult: type: object properties: AccountId: allOf: - $ref: '#/components/schemas/AccountId' - xml: name: accountId description: The Account ID that generated usage. Total: allOf: - $ref: '#/components/schemas/Total' - xml: name: total description: Represents the total of usage for the Account ID. description: Contains information on the total of usage based on account IDs. FilterCriterion: type: object properties: CriterionKey: allOf: - $ref: '#/components/schemas/CriterionKey' - xml: name: criterionKey description: An enum value representing possible scan properties to match with given scan entries. FilterCondition: allOf: - $ref: '#/components/schemas/FilterCondition' - xml: name: filterCondition description: Contains information about the condition. description: 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. ScanEc2InstanceWithFindingsResult: type: object properties: EbsVolumes: allOf: - $ref: '#/components/schemas/EbsVolumesResult' - xml: name: ebsVolumes description: Describes the configuration of scanning EBS volumes as a data source. description: An object that contains information on the status of whether Malware Protection for EC2 instances with findings will be enabled as a data source. PrivateIpAddressDetails: type: object properties: PrivateDnsName: allOf: - $ref: '#/components/schemas/String' - xml: name: privateDnsName description: The private DNS name of the EC2 instance. PrivateIpAddress: allOf: - $ref: '#/components/schemas/String' - xml: name: privateIpAddress description: The private IP address of the EC2 instance. description: Contains other private IP address information of the EC2 instance. CoverageEksClusterDetails: type: object properties: ClusterName: allOf: - $ref: '#/components/schemas/String' - xml: name: clusterName description: Name of the EKS cluster. CoveredNodes: allOf: - $ref: '#/components/schemas/Long' - xml: name: coveredNodes description: Represents the nodes within the EKS cluster that have aHEALTHY coverage status.
CompatibleNodes:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: compatibleNodes
description: Represents all the nodes within the EKS cluster in your account.
AddonDetails:
allOf:
- $ref: '#/components/schemas/AddonDetails'
- xml:
name: addonDetails
description: Information about the installed EKS add-on.
description: Information about the EKS cluster that has a coverage status.
DisassociateFromAdministratorAccountResponse:
type: object
properties: {}
ListMembersResponse:
type: object
properties:
Members:
allOf:
- $ref: '#/components/schemas/Members'
- xml:
name: members
description: A list of members.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The pagination parameter to be used on the next list operation to retrieve more items.
EbsVolumesResult:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/DataSourceStatus'
- xml:
name: status
description: Describes whether scanning EBS volumes is enabled as a data source.
Reason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reason
description: Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a data source.
description: Describes the configuration of scanning EBS volumes as a data source.
UsageFeatureResult:
type: object
properties:
Feature:
allOf:
- $ref: '#/components/schemas/UsageFeature'
- xml:
name: feature
description: The feature that generated the usage cost.
Total:
allOf:
- $ref: '#/components/schemas/Total'
- xml:
name: total
description: Contains information about the result of the total usage based on the feature.
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/NetworkInterface'
VolumeDetail:
type: object
properties:
VolumeArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeArn
description: EBS volume Arn information.
VolumeType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeType
description: The EBS volume type.
DeviceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deviceName
description: The device name for the EBS volume.
VolumeSizeInGB:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: volumeSizeInGB
description: EBS volume size in GB.
EncryptionType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: encryptionType
description: EBS volume encryption type.
SnapshotArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotArn
description: Snapshot Arn of the EBS volume.
KmsKeyArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: kmsKeyArn
description: KMS key Arn used to encrypt the EBS volume.
description: Contains EBS volume details.
ResourceType:
type: string
enum:
- EKS
DnsRequestAction:
type: object
properties:
Domain:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: domain
description: The domain information for the API request.
Protocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: protocol
description: The network connection protocol observed in the activity that prompted GuardDuty to generate the finding.
Blocked:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: blocked
description: Indicates whether the targeted port is blocked.
description: Contains information about the DNS_REQUEST action described in this finding.
OrganizationKubernetesAuditLogsConfiguration:
type: object
required:
- AutoEnable
properties:
AutoEnable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: autoEnable
description: A value that contains information on whether Kubernetes audit logs should be enabled automatically as a data source for the organization.
description: Organization-wide Kubernetes audit logs configuration.
String:
type: string
UpdateIPSetResponse:
type: object
properties: {}
ThreatIntelSetFormat:
type: string
enum:
- TXT
- STIX
- OTX_CSV
- ALIEN_VAULT
- PROOF_POINT
- FIRE_EYE
minLength: 1
maxLength: 300
UpdateFindingsFeedbackResponse:
type: object
properties: {}
FilterNames:
type: array
items:
$ref: '#/components/schemas/FilterName'
minItems: 0
maxItems: 50
OrganizationAdditionalConfigurationResults:
type: array
items:
$ref: '#/components/schemas/OrganizationAdditionalConfigurationResult'
Email:
type: string
minLength: 1
maxLength: 64
SecurityGroup:
type: object
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The security group ID of the EC2 instance.
GroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupName
description: The security group name of the EC2 instance.
description: Contains information about the security groups associated with the EC2 instance.
FilterDescription:
type: string
minLength: 0
maxLength: 512
ListThreatIntelSetsResponse:
type: object
required:
- ThreatIntelSetIds
properties:
ThreatIntelSetIds:
allOf:
- $ref: '#/components/schemas/ThreatIntelSetIds'
- xml:
name: threatIntelSetIds
description: The IDs of the ThreatIntelSet resources.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The pagination parameter to be used on the next list operation to retrieve more items.
CreateMembersResponse:
type: object
required:
- UnprocessedAccounts
properties:
UnprocessedAccounts:
allOf:
- $ref: '#/components/schemas/UnprocessedAccounts'
- xml:
name: unprocessedAccounts
description: A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.
DetectorId:
type: string
minLength: 1
maxLength: 300
GetMasterAccountResponse:
type: object
required:
- Master
deprecated: true
properties:
Master:
allOf:
- $ref: '#/components/schemas/Master'
- xml:
name: master
description: The administrator account details.
description: This output is deprecated, use GetAdministratorAccountResponse instead
FilterCriterionList:
type: array
items:
$ref: '#/components/schemas/FilterCriterion'
minItems: 0
maxItems: 1
PositiveLong:
type: integer
minimum: 0
UnarchiveFindingsResponse:
type: object
properties: {}
GetAdministratorAccountResponse:
type: object
required:
- Administrator
properties:
Administrator:
allOf:
- $ref: '#/components/schemas/Administrator'
- xml:
name: administrator
description: The administrator account details.
OrganizationEbsVolumes:
type: object
properties:
AutoEnable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: autoEnable
description: Whether scanning EBS volumes should be auto-enabled for new members joining the organization.
description: Organization-wide EBS volumes scan configuration.
ServiceAdditionalInfo:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: This field specifies the value of the additional information.
Type:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: type
description: Describes the type of the additional information.
description: Additional information about the generated finding.
RemoteAccountDetails:
type: object
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: accountId
description: The Amazon Web Services account ID of the remote API caller.
Affiliated:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: affiliated
description: 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.
description: Contains details about the remote Amazon Web Services account that made the API call.
ListFiltersResponse:
type: object
required:
- FilterNames
properties:
FilterNames:
allOf:
- $ref: '#/components/schemas/FilterNames'
- xml:
name: filterNames
description: A list of filter names.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The pagination parameter to be used on the next list operation to retrieve more items.
KubernetesUserDetails:
type: object
properties:
Username:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: username
description: The username of the user who called the Kubernetes API.
Uid:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: uid
description: The user ID of the user who called the Kubernetes API.
Groups:
allOf:
- $ref: '#/components/schemas/Groups'
- xml:
name: groups
description: The groups that include the user who called the Kubernetes API.
description: Details about the Kubernetes user involved in a Kubernetes finding.
Organization:
type: object
properties:
Asn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: asn
description: The Autonomous System Number (ASN) of the internet provider of the remote IP address.
AsnOrg:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: asnOrg
description: The organization that registered this ASN.
Isp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: isp
description: The ISP information for the internet provider.
Org:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: org
description: The name of the internet provider.
description: Contains information about the ISP organization of the remote IP address.
GetDetectorResponse:
type: object
required:
- ServiceRole
- Status
properties:
CreatedAt:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: createdAt
description: The timestamp of when the detector was created.
FindingPublishingFrequency:
allOf:
- $ref: '#/components/schemas/FindingPublishingFrequency'
- xml:
name: findingPublishingFrequency
description: The publishing frequency of the finding.
ServiceRole:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceRole
description: The GuardDuty service role.
Status:
allOf:
- $ref: '#/components/schemas/DetectorStatus'
- xml:
name: status
description: The detector status.
UpdatedAt:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: updatedAt
description: The last-updated timestamp for the detector.
DataSources:
allOf:
- $ref: '#/components/schemas/DataSourceConfigurationsResult'
- deprecated: true
xml:
name: dataSources
description: Describes which data sources are enabled for the detector.This parameter is deprecated, use Features instead
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- xml:
name: tags
description: The tags of the detector resource.
Features:
allOf:
- $ref: '#/components/schemas/DetectorFeatureConfigurationsResults'
- xml:
name: features
description: Describes the features that have been enabled for the detector.
IpSetStatus:
type: string
enum:
- INACTIVE
- ACTIVATING
- ACTIVE
- DEACTIVATING
- ERROR
- DELETE_PENDING
- DELETED
minLength: 1
maxLength: 300
DeleteIPSetResponse:
type: object
properties: {}
OrganizationS3LogsConfigurationResult:
type: object
required:
- AutoEnable
properties:
AutoEnable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: autoEnable
description: A value that describes whether S3 data event logs are automatically enabled for new members of the organization.
description: The current configuration of S3 data event logs as a data source for the organization.
City:
type: object
properties:
CityName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cityName
description: The city name of the remote IP address.
description: Contains information about the city associated with the IP address.
KubernetesAuditLogsConfigurationResult:
type: object
required:
- Status
properties:
Status:
allOf:
- $ref: '#/components/schemas/DataSourceStatus'
- xml:
name: status
description: A value that describes whether Kubernetes audit logs are enabled as a data source.
description: Describes whether Kubernetes audit logs are enabled as a data source.
Condition:
type: object
properties:
Eq:
allOf:
- $ref: '#/components/schemas/Eq'
- deprecated: true
xml:
name: eq
description: Represents the equal condition to be applied to a single field when querying for findings.
Neq:
allOf:
- $ref: '#/components/schemas/Neq'
- deprecated: true
xml:
name: neq
description: Represents the not equal condition to be applied to a single field when querying for findings.
Gt:
allOf:
- $ref: '#/components/schemas/Integer'
- deprecated: true
xml:
name: gt
description: Represents a greater than condition to be applied to a single field when querying for findings.
Gte:
allOf:
- $ref: '#/components/schemas/Integer'
- deprecated: true
xml:
name: gte
description: Represents a greater than or equal condition to be applied to a single field when querying for findings.
Lt:
allOf:
- $ref: '#/components/schemas/Integer'
- deprecated: true
xml:
name: lt
description: Represents a less than condition to be applied to a single field when querying for findings.
Lte:
allOf:
- $ref: '#/components/schemas/Integer'
- deprecated: true
xml:
name: lte
description: Represents a less than or equal condition to be applied to a single field when querying for findings.
Equals:
allOf:
- $ref: '#/components/schemas/Equals'
- xml:
name: equals
description: Represents an equal condition to be applied to a single field when querying for findings.
NotEquals:
allOf:
- $ref: '#/components/schemas/NotEquals'
- xml:
name: notEquals
description: Represents a not equal condition to be applied to a single field when querying for findings.
GreaterThan:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: greaterThan
description: Represents a greater than condition to be applied to a single field when querying for findings.
GreaterThanOrEqual:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: greaterThanOrEqual
description: Represents a greater than or equal condition to be applied to a single field when querying for findings.
LessThan:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: lessThan
description: Represents a less than condition to be applied to a single field when querying for findings.
LessThanOrEqual:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: lessThanOrEqual
description: Represents a less than or equal condition to be applied to a single field when querying for findings.
description: Contains information about the condition.
LoginAttribute:
type: object
properties:
User:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: user
description: Indicates the user name which attempted to log in.
Application:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: application
description: Indicates the application name used to attempt log in.
FailedLoginAttempts:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: failedLoginAttempts
description: Represents the sum of failed (unsuccessful) login attempts made to establish a connection to the database instance.
SuccessfulLoginAttempts:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: successfulLoginAttempts
description: Represents the sum of successful connections (a correct combination of login attributes) made to the database instance by the actor.
description: Information about the login attempts.
FindingPublishingFrequency:
type: string
enum:
- FIFTEEN_MINUTES
- ONE_HOUR
- SIX_HOURS
PublicAccess:
type: object
properties:
PermissionConfiguration:
allOf:
- $ref: '#/components/schemas/PermissionConfiguration'
- xml:
name: permissionConfiguration
description: Contains information about how permissions are configured for the S3 bucket.
EffectivePermission:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: effectivePermission
description: Describes the effective permission on this bucket after factoring all attached policies.
description: Describes the public access policies that apply to the S3 bucket.
SubnetIds:
type: array
items:
$ref: '#/components/schemas/String'
DNSLogsConfigurationResult:
type: object
required:
- Status
properties:
Status:
allOf:
- $ref: '#/components/schemas/DataSourceStatus'
- xml:
name: status
description: Denotes whether DNS logs is enabled as a data source.
description: Contains information on the status of DNS logs as a data source.
ThreatNames:
type: array
items:
$ref: '#/components/schemas/String'
DataSource:
type: string
enum:
- FLOW_LOGS
- CLOUD_TRAIL
- DNS_LOGS
- S3_LOGS
- KUBERNETES_AUDIT_LOGS
- EC2_MALWARE_SCAN
CoverageResource:
type: object
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The unique ID of the resource.
DetectorId:
allOf:
- $ref: '#/components/schemas/DetectorId'
- xml:
name: detectorId
description: The unique ID of the GuardDuty detector associated with the resource.
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- xml:
name: accountId
description: The unique ID of the Amazon Web Services account.
ResourceDetails:
allOf:
- $ref: '#/components/schemas/CoverageResourceDetails'
- xml:
name: resourceDetails
description: Information about the resource for which the coverage statistics are retrieved.
CoverageStatus:
allOf:
- $ref: '#/components/schemas/CoverageStatus'
- xml:
name: coverageStatus
description: Represents the status of the EKS cluster coverage.
Issue:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: issue
description: Represents the reason why a coverage status was UNHEALTHY for the EKS cluster.
UpdatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: updatedAt
description: The timestamp at which the coverage details for the resource were last updated. This is in UTC format.
description: Information about the resource of the GuardDuty account.
MalwareProtectionConfiguration:
type: object
properties:
ScanEc2InstanceWithFindings:
allOf:
- $ref: '#/components/schemas/ScanEc2InstanceWithFindings'
- xml:
name: scanEc2InstanceWithFindings
description: Describes the configuration of Malware Protection for EC2 instances with findings.
description: Describes whether Malware Protection will be enabled as a data source.
ProductCode:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: productCodeId
description: The product code information.
ProductType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: productCodeType
description: The product code type.
description: Contains information about the product code for the EC2 instance.
S3BucketDetail:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The Amazon Resource Name (ARN) of the S3 bucket.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the S3 bucket.
Type:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: type
description: Describes whether the bucket is a source or destination bucket.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: createdAt
description: The date and time the bucket was created at.
Owner:
allOf:
- $ref: '#/components/schemas/Owner'
- xml:
name: owner
description: The owner of the S3 bucket.
Tags:
allOf:
- $ref: '#/components/schemas/Tags'
- xml:
name: tags
description: All tags attached to the S3 bucket
DefaultServerSideEncryption:
allOf:
- $ref: '#/components/schemas/DefaultServerSideEncryption'
- xml:
name: defaultServerSideEncryption
description: Describes the server side encryption method used in the S3 bucket.
PublicAccess:
allOf:
- $ref: '#/components/schemas/PublicAccess'
- xml:
name: publicAccess
description: Describes the public access policies that apply to the S3 bucket.
description: Contains information on the S3 bucket.
UsageDataSourceResult:
type: object
properties:
DataSource:
allOf:
- $ref: '#/components/schemas/DataSource'
- xml:
name: dataSource
description: The data source type that generated usage.
Total:
allOf:
- $ref: '#/components/schemas/Total'
- xml:
name: total
description: Represents the total of usage for the specified data source.
description: Contains information on the result of usage based on data source type.
Boolean:
type: boolean
CloudTrailConfigurationResult:
type: object
required:
- Status
properties:
Status:
allOf:
- $ref: '#/components/schemas/DataSourceStatus'
- xml:
name: status
description: Describes whether CloudTrail is enabled as a data source for the detector.
description: Contains information on the status of CloudTrail as a data source for the detector.
StartMonitoringMembersResponse:
type: object
required:
- UnprocessedAccounts
properties:
UnprocessedAccounts:
allOf:
- $ref: '#/components/schemas/UnprocessedAccounts'
- xml:
name: unprocessedAccounts
description: A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
DescribePublishingDestinationResponse:
type: object
required:
- DestinationId
- DestinationType
- Status
- PublishingFailureStartTimestamp
- DestinationProperties
properties:
DestinationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationId
description: The ID of the publishing destination.
DestinationType:
allOf:
- $ref: '#/components/schemas/DestinationType'
- xml:
name: destinationType
description: The type of publishing destination. Currently, only Amazon S3 buckets are supported.
Status:
allOf:
- $ref: '#/components/schemas/PublishingStatus'
- xml:
name: status
description: The status of the publishing destination.
PublishingFailureStartTimestamp:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: publishingFailureStartTimestamp
description: The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.
DestinationProperties:
allOf:
- $ref: '#/components/schemas/DestinationProperties'
- xml:
name: destinationProperties
description: A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.
NotEquals:
type: array
items:
$ref: '#/components/schemas/String'
OrganizationMalwareProtectionConfiguration:
type: object
properties:
ScanEc2InstanceWithFindings:
allOf:
- $ref: '#/components/schemas/OrganizationScanEc2InstanceWithFindings'
- xml:
name: scanEc2InstanceWithFindings
description: Whether Malware Protection for EC2 instances with findings should be auto-enabled for new members joining the organization.
description: Organization-wide Malware Protection configurations.
KubernetesWorkloadDetails:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: Kubernetes workload name.
Type:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: type
description: Kubernetes workload type (e.g. Pod, Deployment, etc.).
Uid:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: uid
description: Kubernetes workload ID.
Namespace:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: namespace
description: Kubernetes namespace that the workload is part of.
HostNetwork:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: hostNetwork
description: Whether the hostNetwork flag is enabled for the pods included in the workload.
Containers:
allOf:
- $ref: '#/components/schemas/Containers'
- xml:
name: containers
description: Containers running as part of the Kubernetes workload.
Volumes:
allOf:
- $ref: '#/components/schemas/Volumes'
- xml:
name: volumes
description: Volumes used by the Kubernetes workload.
description: Details about the Kubernetes workload involved in a Kubernetes finding.
ScanDetections:
type: object
properties:
ScannedItemCount:
allOf:
- $ref: '#/components/schemas/ScannedItemCount'
- xml:
name: scannedItemCount
description: Total number of scanned files.
ThreatsDetectedItemCount:
allOf:
- $ref: '#/components/schemas/ThreatsDetectedItemCount'
- xml:
name: threatsDetectedItemCount
description: Total number of infected files.
HighestSeverityThreatDetails:
allOf:
- $ref: '#/components/schemas/HighestSeverityThreatDetails'
- xml:
name: highestSeverityThreatDetails
description: Details of the highest severity threat detected during malware scan and number of infected files.
ThreatDetectedByName:
allOf:
- $ref: '#/components/schemas/ThreatDetectedByName'
- xml:
name: threatDetectedByName
description: Contains details about identified threats organized by threat name.
description: Contains a complete view providing malware scan result details.
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
TagMap:
type: object
minProperties: 1
maxProperties: 200
additionalProperties:
$ref: '#/components/schemas/TagValue'
AcceptInvitationResponse:
type: object
deprecated: true
properties: {}
description: This output is deprecated, use AcceptAdministratorInvitationResponse instead
CoverageStatistics:
type: object
properties:
CountByResourceType:
allOf:
- $ref: '#/components/schemas/CountByResourceType'
- xml:
name: countByResourceType
description: Represents coverage statistics for EKS clusters aggregated by resource type.
CountByCoverageStatus:
allOf:
- $ref: '#/components/schemas/CountByCoverageStatus'
- xml:
name: countByCoverageStatus
description: Represents coverage statistics for EKS clusters aggregated by coverage status.
description: Information about the coverage statistics for a resource.
UnprocessedAccount:
type: object
required:
- AccountId
- Result
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- xml:
name: accountId
description: The Amazon Web Services account ID.
Result:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: result
description: A reason why the account hasn't been processed.
description: Contains information about the accounts that weren't processed.
CreatePublishingDestinationResponse:
type: object
required:
- DestinationId
properties:
DestinationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationId
description: The ID of the publishing destination that is created.
MemberAdditionalConfigurationResults:
type: array
items:
$ref: '#/components/schemas/MemberAdditionalConfigurationResult'
FilePaths:
type: array
items:
$ref: '#/components/schemas/ScanFilePath'
DetectorAdditionalConfigurationResult:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/FeatureAdditionalConfiguration'
- xml:
name: name
description: Name of the additional configuration.
Status:
allOf:
- $ref: '#/components/schemas/FeatureStatus'
- xml:
name: status
description: Status of the additional configuration.
UpdatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: updatedAt
description: The timestamp at which the additional configuration was last updated. This is in UTC format.
description: Information about the additional configuration.
Members:
type: array
items:
$ref: '#/components/schemas/Member'
minItems: 0
maxItems: 50
TagValue:
type: string
maxLength: 256
CountByCoverageStatus:
type: object
additionalProperties:
$ref: '#/components/schemas/Long'
GetMalwareScanSettingsResponse:
type: object
properties:
ScanResourceCriteria:
allOf:
- $ref: '#/components/schemas/ScanResourceCriteria'
- xml:
name: scanResourceCriteria
description: Represents the criteria to be used in the filter for scanning resources.
EbsSnapshotPreservation:
allOf:
- $ref: '#/components/schemas/EbsSnapshotPreservation'
- xml:
name: ebsSnapshotPreservation
description: An enum value representing possible snapshot preservation settings.
ThreatIntelligenceDetails:
type: array
items:
$ref: '#/components/schemas/ThreatIntelligenceDetail'
ProcessDetails:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the process.
ExecutablePath:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: executablePath
description: The absolute path of the process executable file.
ExecutableSha256:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: executableSha256
description: The SHA256 hash of the process executable.
NamespacePid:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: namespacePid
description: The ID of the child process.
Pwd:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: pwd
description: The present working directory of the process.
Pid:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: pid
description: The ID of the process.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: startTime
description: The time when the process started. This is in UTC format.
Uuid:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: uuid
description: The unique ID assigned to the process by GuardDuty.
ParentUuid:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: parentUuid
description: The unique ID of the parent process. This ID is assigned to the parent process by GuardDuty.
User:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: user
description: The user that executed the process.
UserId:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: userId
description: The unique ID of the user that executed the process.
Euid:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: euid
description: The effective user ID of the user that executed the process.
Lineage:
allOf:
- $ref: '#/components/schemas/Lineage'
- xml:
name: lineage
description: Information about the process's lineage.
description: Information about the observed process.
Neq:
type: array
items:
$ref: '#/components/schemas/String'
GetIPSetResponse:
type: object
required:
- Name
- Format
- Location
- Status
properties:
Name:
allOf:
- $ref: '#/components/schemas/Name'
- xml:
name: name
description: The user-friendly name for the IPSet.
Format:
allOf:
- $ref: '#/components/schemas/IpSetFormat'
- xml:
name: format
description: The format of the file that contains the IPSet.
Location:
allOf:
- $ref: '#/components/schemas/Location'
- xml:
name: location
description: The URI of the file that contains the IPSet.
Status:
allOf:
- $ref: '#/components/schemas/IpSetStatus'
- xml:
name: status
description: The status of IPSet file that was uploaded.
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- xml:
name: tags
description: The tags of the IPSet resource.
UpdateMemberDetectorsResponse:
type: object
required:
- UnprocessedAccounts
properties:
UnprocessedAccounts:
allOf:
- $ref: '#/components/schemas/UnprocessedAccounts'
- xml:
name: unprocessedAccounts
description: A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.
MapEquals:
type: array
items:
$ref: '#/components/schemas/ScanConditionPair'
DetectorAdditionalConfigurations:
type: array
items:
$ref: '#/components/schemas/DetectorAdditionalConfiguration'
Scans:
type: array
items:
$ref: '#/components/schemas/Scan'
GetFilterResponse:
type: object
required:
- Name
- Action
- FindingCriteria
properties:
Name:
allOf:
- $ref: '#/components/schemas/FilterName'
- xml:
name: name
description: The name of the filter.
Description:
allOf:
- $ref: '#/components/schemas/FilterDescription'
- xml:
name: description
description: The description of the filter.
Action:
allOf:
- $ref: '#/components/schemas/FilterAction'
- xml:
name: action
description: Specifies the action that is to be applied to the findings that match the filter.
Rank:
allOf:
- $ref: '#/components/schemas/FilterRank'
- xml:
name: rank
description: 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.
FindingCriteria:
allOf:
- $ref: '#/components/schemas/FindingCriteria'
- xml:
name: findingCriteria
description: Represents the criteria to be used in the filter for querying findings.
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- xml:
name: tags
description: The tags of the filter resource.
Service:
type: object
properties:
Action:
allOf:
- $ref: '#/components/schemas/Action'
- xml:
name: action
description: Information about the activity that is described in a finding.
Evidence:
allOf:
- $ref: '#/components/schemas/Evidence'
- xml:
name: evidence
description: An evidence object associated with the service.
Archived:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: archived
description: Indicates whether this finding is archived.
Count:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: count
description: The total count of the occurrences of this finding type.
DetectorId:
allOf:
- $ref: '#/components/schemas/DetectorId'
- xml:
name: detectorId
description: The detector ID for the GuardDuty service.
EventFirstSeen:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: eventFirstSeen
description: The first-seen timestamp of the activity that prompted GuardDuty to generate this finding.
EventLastSeen:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: eventLastSeen
description: The last-seen timestamp of the activity that prompted GuardDuty to generate this finding.
ResourceRole:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceRole
description: The resource role information for this finding.
ServiceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceName
description: The name of the Amazon Web Services service (GuardDuty) that generated a finding.
UserFeedback:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: userFeedback
description: Feedback that was submitted about the finding.
AdditionalInfo:
allOf:
- $ref: '#/components/schemas/ServiceAdditionalInfo'
- xml:
name: additionalInfo
description: Contains additional information about the generated finding.
FeatureName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: featureName
description: The name of the feature that generated a finding.
EbsVolumeScanDetails:
allOf:
- $ref: '#/components/schemas/EbsVolumeScanDetails'
- xml:
name: ebsVolumeScanDetails
description: Returns details from the malware scan that created a finding.
RuntimeDetails:
allOf:
- $ref: '#/components/schemas/RuntimeDetails'
- xml:
name: runtimeDetails
description: Information about the process and any required context values for a specific finding
description: Contains additional information about the generated finding.
SourceIps:
type: array
items:
$ref: '#/components/schemas/String'
MalwareProtectionConfigurationResult:
type: object
properties:
ScanEc2InstanceWithFindings:
allOf:
- $ref: '#/components/schemas/ScanEc2InstanceWithFindingsResult'
- xml:
name: scanEc2InstanceWithFindings
description: Describes the configuration of Malware Protection for EC2 instances with findings.
ServiceRole:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceRole
description: The GuardDuty Malware Protection service role.
description: An object that contains information on the status of all Malware Protection data sources.
OrganizationFeaturesConfigurationsResults:
type: array
items:
$ref: '#/components/schemas/OrganizationFeatureConfigurationResult'
DataSourcesFreeTrial:
type: object
properties:
CloudTrail:
allOf:
- $ref: '#/components/schemas/DataSourceFreeTrial'
- xml:
name: cloudTrail
description: Describes whether any Amazon Web Services CloudTrail management event logs are enabled as data sources.
DnsLogs:
allOf:
- $ref: '#/components/schemas/DataSourceFreeTrial'
- xml:
name: dnsLogs
description: Describes whether any DNS logs are enabled as data sources.
FlowLogs:
allOf:
- $ref: '#/components/schemas/DataSourceFreeTrial'
- xml:
name: flowLogs
description: Describes whether any VPC Flow logs are enabled as data sources.
S3Logs:
allOf:
- $ref: '#/components/schemas/DataSourceFreeTrial'
- xml:
name: s3Logs
description: Describes whether any S3 data event logs are enabled as data sources.
Kubernetes:
allOf:
- $ref: '#/components/schemas/KubernetesDataSourceFreeTrial'
- xml:
name: kubernetes
description: Describes whether any Kubernetes logs are enabled as data sources.
MalwareProtection:
allOf:
- $ref: '#/components/schemas/MalwareProtectionDataSourceFreeTrial'
- xml:
name: malwareProtection
description: Describes whether Malware Protection is enabled as a data source.
description: Contains information about which data sources are enabled for the GuardDuty member account.
UsageResourceResultList:
type: array
items:
$ref: '#/components/schemas/UsageResourceResult'
OrganizationAdditionalConfigurationResult:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/OrgFeatureAdditionalConfiguration'
- xml:
name: name
description: The name of the additional configuration that is configured for the member accounts within the organization.
AutoEnable:
allOf:
- $ref: '#/components/schemas/OrgFeatureStatus'
- xml:
name: autoEnable
description: Describes how The status of the additional configuration that are configured for the member accounts within the organization.
If you set AutoEnable to NEW, a feature will be configured for only the new accounts when they join the organization.
If you set AutoEnable to NONE, no feature will be configured for the accounts when they join the organization.
runc implementation.
ReleaseAgentPath:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: releaseAgentPath
description: The path in the container that modified the release agent file.
MountSource:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: mountSource
description: The path on the host that is mounted by the container.
MountTarget:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: mountTarget
description: The path in the container that is mapped to the host directory.
FileSystemType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: fileSystemType
description: Represents the type of mounted fileSystem.
Flags:
allOf:
- $ref: '#/components/schemas/FlagsList'
- xml:
name: flags
description: Represents options that control the behavior of a runtime operation or action. For example, a filesystem mount operation may contain a read-only flag.
ModuleName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: moduleName
description: The name of the module loaded into the kernel.
ModuleFilePath:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: moduleFilePath
description: The path to the module loaded into the kernel.
ModuleSha256:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: moduleSha256
description: The SHA256 hash of the module.
ShellHistoryFilePath:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: shellHistoryFilePath
description: The path to the modified shell history file.
TargetProcess:
allOf:
- $ref: '#/components/schemas/ProcessDetails'
- xml:
name: targetProcess
description: Information about the process that had its memory overwritten by the current process.
AddressFamily:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: addressFamily
description: Represents the communication protocol associated with the address. For example, the address family AF_INET is used for IP version of 4 protocol.
IanaProtocolNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: ianaProtocolNumber
description: 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.
MemoryRegions:
allOf:
- $ref: '#/components/schemas/MemoryRegionsList'
- xml:
name: memoryRegions
description: Specifies the Region of a process's address space such as stack and heap.
description: Additional information about the suspicious activity.
DetectorIds:
type: array
items:
$ref: '#/components/schemas/DetectorId'
minItems: 0
maxItems: 50
UpdateMalwareScanSettingsResponse:
type: object
properties: {}
OrderBy:
type: string
enum:
- ASC
- DESC
RemotePortDetails:
type: object
properties:
Port:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: port
description: The port number of the remote connection.
PortName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: portName
description: The port name of the remote connection.
description: Contains information about the remote port.
TriggerDetails:
type: object
properties:
GuardDutyFindingId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- xml:
name: guardDutyFindingId
description: The ID of the GuardDuty finding that triggered the malware scan.
Description:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- xml:
name: description
description: The description of the scan trigger.
description: Represents the reason the scan was triggered.
ScanResourceCriteria:
type: object
properties:
Include:
allOf:
- $ref: '#/components/schemas/ScanCriterion'
- xml:
name: include
description: Represents condition that when matched will allow a malware scan for a certain resource.
Exclude:
allOf:
- $ref: '#/components/schemas/ScanCriterion'
- xml:
name: exclude
description: Represents condition that when matched will prevent a malware scan for a certain resource.
description: Contains information about criteria used to filter resources before triggering malware scan.
DataSourceStatus:
type: string
enum:
- ENABLED
- DISABLED
minLength: 1
maxLength: 300
AccountId:
type: string
minLength: 12
maxLength: 12
Tag:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: key
description: The EC2 instance tag key.
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The EC2 instance tag value.
description: Contains information about a tag associated with the EC2 instance.
ArchiveFindingsResponse:
type: object
properties: {}
IamInstanceProfile:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The profile ARN of the EC2 instance.
Id:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: id
description: The profile ID of the EC2 instance.
description: Contains information about the EC2 instance profile.
GetThreatIntelSetResponse:
type: object
required:
- Name
- Format
- Location
- Status
properties:
Name:
allOf:
- $ref: '#/components/schemas/Name'
- xml:
name: name
description: A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.
Format:
allOf:
- $ref: '#/components/schemas/ThreatIntelSetFormat'
- xml:
name: format
description: The format of the threatIntelSet.
Location:
allOf:
- $ref: '#/components/schemas/Location'
- xml:
name: location
description: 'The URI of the file that contains the ThreatIntelSet. '
Status:
allOf:
- $ref: '#/components/schemas/ThreatIntelSetStatus'
- xml:
name: status
description: The status of threatIntelSet file uploaded.
Tags:
allOf:
- $ref: '#/components/schemas/TagMap'
- xml:
name: tags
description: The tags of the threat list resource.
DetectorFeatureConfiguration:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/DetectorFeature'
- xml:
name: name
description: The name of the feature.
Status:
allOf:
- $ref: '#/components/schemas/FeatureStatus'
- xml:
name: status
description: The status of the feature.
AdditionalConfiguration:
allOf:
- $ref: '#/components/schemas/DetectorAdditionalConfigurations'
- xml:
name: additionalConfiguration
description: Additional configuration for a resource.
description: Contains information about a GuardDuty feature.
ScanCriterion:
type: object
description: Represents a map of resource properties that match specified conditions and values when triggering malware scans.
additionalProperties:
$ref: '#/components/schemas/ScanCondition'
GetUsageStatisticsResponse:
type: object
properties:
UsageStatistics:
allOf:
- $ref: '#/components/schemas/UsageStatistics'
- xml:
name: usageStatistics
description: The usage statistics object. If a UsageStatisticType was provided, the objects representing other types will be null.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The pagination parameter to be used on the next list operation to retrieve more items.
FindingCriteria:
type: object
properties:
Criterion:
allOf:
- $ref: '#/components/schemas/Criterion'
- xml:
name: criterion
description: Represents a map of finding properties that match specified conditions and values when querying findings.
description: Contains information about the criteria used for querying findings.
MemberAdditionalConfiguration:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/OrgFeatureAdditionalConfiguration'
- xml:
name: name
description: Name of the additional configuration.
Status:
allOf:
- $ref: '#/components/schemas/FeatureStatus'
- xml:
name: status
description: Status of the additional configuration.
description: Information about the additional configuration for the member account.
ListFindingsResponse:
type: object
required:
- FindingIds
properties:
FindingIds:
allOf:
- $ref: '#/components/schemas/FindingIds'
- xml:
name: findingIds
description: The IDs of the findings that you're listing.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The pagination parameter to be used on the next list operation to retrieve more items.
Volume:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: Volume name.
HostPath:
allOf:
- $ref: '#/components/schemas/HostPath'
- xml:
name: hostPath
description: Represents a pre-existing file or directory on the host machine that the volume maps to.
description: Volume used by the Kubernetes workload.
Double:
type: number
format: double
LongValue:
type: integer
InternalServerErrorException: {}
CoverageResources:
type: array
items:
$ref: '#/components/schemas/CoverageResource'
EbsVolumeDetails:
type: object
properties:
ScannedVolumeDetails:
allOf:
- $ref: '#/components/schemas/VolumeDetails'
- xml:
name: scannedVolumeDetails
description: List of EBS volumes that were scanned.
SkippedVolumeDetails:
allOf:
- $ref: '#/components/schemas/VolumeDetails'
- xml:
name: skippedVolumeDetails
description: List of EBS volumes that were skipped from the malware scan.
description: Contains list of scanned and skipped EBS volumes with details.
Containers:
type: array
items:
$ref: '#/components/schemas/Container'
CoverageSortKey:
type: string
enum:
- ACCOUNT_ID
- CLUSTER_NAME
- COVERAGE_STATUS
- ISSUE
- ADDON_VERSION
- UPDATED_AT
CreateIPSetResponse:
type: object
required:
- IpSetId
properties:
IpSetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipSetId
description: The ID of the IPSet resource.
RuntimeDetails:
type: object
properties:
Process:
allOf:
- $ref: '#/components/schemas/ProcessDetails'
- xml:
name: process
description: Information about the observed process.
Context:
allOf:
- $ref: '#/components/schemas/RuntimeContext'
- xml:
name: context
description: Additional information about the suspicious activity.
description: Information about the process and any required context values for a specific finding.
Evidence:
type: object
properties:
ThreatIntelligenceDetails:
allOf:
- $ref: '#/components/schemas/ThreatIntelligenceDetails'
- xml:
name: threatIntelligenceDetails
description: A list of threat intelligence details related to the evidence.
description: Contains information about the reason that the finding was generated.
ThreatIntelSetIds:
type: array
items:
$ref: '#/components/schemas/String'
minItems: 0
maxItems: 50
MemberFeaturesConfiguration:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/OrgFeature'
- xml:
name: name
description: The name of the feature.
Status:
allOf:
- $ref: '#/components/schemas/FeatureStatus'
- xml:
name: status
description: The status of the feature.
AdditionalConfiguration:
allOf:
- $ref: '#/components/schemas/MemberAdditionalConfigurations'
- xml:
name: additionalConfiguration
description: Additional configuration of the feature for the member account.
description: Contains information about the features for the member account.
UpdateThreatIntelSetResponse:
type: object
properties: {}
Ipv6Addresses:
type: array
items:
$ref: '#/components/schemas/String'
DetectorAdditionalConfiguration:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/FeatureAdditionalConfiguration'
- xml:
name: name
description: Name of the additional configuration.
Status:
allOf:
- $ref: '#/components/schemas/FeatureStatus'
- xml:
name: status
description: Status of the additional configuration.
description: Information about the additional configuration for a feature in your GuardDuty account.
LocalPortDetails:
type: object
properties:
Port:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: port
description: The port number of the local connection.
PortName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: portName
description: The port name of the local connection.
description: Contains information about the port for the local connection.
KubernetesConfiguration:
type: object
required:
- AuditLogs
properties:
AuditLogs:
allOf:
- $ref: '#/components/schemas/KubernetesAuditLogsConfiguration'
- xml:
name: auditLogs
description: The status of Kubernetes audit logs as a data source.
description: Describes whether any Kubernetes data sources are enabled.
FilterCondition:
type: object
properties:
EqualsValue:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- xml:
name: equalsValue
description: Represents an equal condition to be applied to a single field when querying for scan entries.
GreaterThan:
allOf:
- $ref: '#/components/schemas/LongValue'
- xml:
name: greaterThan
description: Represents a greater than condition to be applied to a single field when querying for scan entries.
LessThan:
allOf:
- $ref: '#/components/schemas/LongValue'
- xml:
name: lessThan
description: Represents a less than condition to be applied to a single field when querying for scan entries.
description: Contains information about the condition.
KubernetesDetails:
type: object
properties:
KubernetesUserDetails:
allOf:
- $ref: '#/components/schemas/KubernetesUserDetails'
- xml:
name: kubernetesUserDetails
description: Details about the Kubernetes user involved in a Kubernetes finding.
KubernetesWorkloadDetails:
allOf:
- $ref: '#/components/schemas/KubernetesWorkloadDetails'
- xml:
name: kubernetesWorkloadDetails
description: Details about the Kubernetes workload involved in a Kubernetes finding.
description: Details about Kubernetes resources such as a Kubernetes user or workload resource involved in a Kubernetes finding.
PermissionConfiguration:
type: object
properties:
BucketLevelPermissions:
allOf:
- $ref: '#/components/schemas/BucketLevelPermissions'
- xml:
name: bucketLevelPermissions
description: Contains information about the bucket level permissions for the S3 bucket.
AccountLevelPermissions:
allOf:
- $ref: '#/components/schemas/AccountLevelPermissions'
- xml:
name: accountLevelPermissions
description: Contains information about the account level permissions on the S3 bucket.
description: Contains information about how permissions are configured for the S3 bucket.
CreateSampleFindingsResponse:
type: object
properties: {}
MemoryRegionsList:
type: array
items:
$ref: '#/components/schemas/String'
ThreatIntelSetStatus:
type: string
enum:
- INACTIVE
- ACTIVATING
- ACTIVE
- DEACTIVATING
- ERROR
- DELETE_PENDING
- DELETED
minLength: 1
maxLength: 300
CoverageResourceDetails:
type: object
properties:
EksClusterDetails:
allOf:
- $ref: '#/components/schemas/CoverageEksClusterDetails'
- xml:
name: eksClusterDetails
description: EKS cluster details involved in the coverage statistics.
ResourceType:
allOf:
- $ref: '#/components/schemas/ResourceType'
- xml:
name: resourceType
description: The type of Amazon Web Services resource.
description: Information about the resource for each individual EKS cluster.
CountByResourceType:
type: object
additionalProperties:
$ref: '#/components/schemas/Long'
DeleteFilterResponse:
type: object
properties: {}
FindingStatistics:
type: object
properties:
CountBySeverity:
allOf:
- $ref: '#/components/schemas/CountBySeverity'
- xml:
name: countBySeverity
description: Represents a map of severity to count statistics for a set of findings.
description: Contains information about finding statistics.
LambdaDetails:
type: object
properties:
FunctionArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: functionArn
description: Amazon Resource Name (ARN) of the Lambda function.
FunctionName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: functionName
description: Name of the Lambda function.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: Description of the Lambda function.
LastModifiedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: lastModifiedAt
description: The timestamp when the Lambda function was last modified. This field is in the UTC date string format (2023-03-22T19:37:20.168Z).
RevisionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: revisionId
description: The revision ID of the Lambda function version.
FunctionVersion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: functionVersion
description: The version of the Lambda function.
Role:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: role
description: The execution role of the Lambda function.
VpcConfig:
allOf:
- $ref: '#/components/schemas/VpcConfig'
- xml:
name: vpcConfig
description: Amazon Virtual Private Cloud configuration details associated with your Lambda function.
Tags:
allOf:
- $ref: '#/components/schemas/Tags'
- xml:
name: tags
description: A list of tags attached to this resource, listed in the format of key:value pair.
description: Information about the Lambda function involved in the finding.
CreateFilterResponse:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/FilterName'
- xml:
name: name
description: The name of the successfully created filter.
FreeTrialFeatureConfigurationsResults:
type: array
items:
$ref: '#/components/schemas/FreeTrialFeatureConfigurationResult'
Lineage:
type: array
items:
$ref: '#/components/schemas/LineageObject'
Location:
type: string
minLength: 1
maxLength: 300
ListIPSetsResponse:
type: object
required:
- IpSetIds
properties:
IpSetIds:
allOf:
- $ref: '#/components/schemas/IpSetIds'
- xml:
name: ipSetIds
description: The IDs of the IPSet resources.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The pagination parameter to be used on the next list operation to retrieve more items.
ScanResult:
type: string
enum:
- CLEAN
- INFECTED
Container:
type: object
properties:
ContainerRuntime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: containerRuntime
description: The container runtime (such as, Docker or containerd) used to run the container.
Id:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: id
description: Container ID.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: Container name.
Image:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: image
description: Container image.
ImagePrefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imagePrefix
description: 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.
VolumeMounts:
allOf:
- $ref: '#/components/schemas/VolumeMounts'
- xml:
name: volumeMounts
description: Container volume mounts.
SecurityContext:
allOf:
- $ref: '#/components/schemas/SecurityContext'
- xml:
name: securityContext
description: Container security context.
description: Details of a container.
OrganizationScanEc2InstanceWithFindingsResult:
type: object
properties:
EbsVolumes:
allOf:
- $ref: '#/components/schemas/OrganizationEbsVolumesResult'
- xml:
name: ebsVolumes
description: Describes the configuration for scanning EBS volumes for an organization.
description: An object that contains information on the status of scanning EC2 instances with findings for an organization.
OrganizationFeatureConfigurationResult:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/OrgFeature'
- xml:
name: name
description: The name of the feature that is configured for the member accounts within the organization.
AutoEnable:
allOf:
- $ref: '#/components/schemas/OrgFeatureStatus'
- xml:
name: autoEnable
description: Describes how The status of the feature that are configured for the member accounts within the organization.
If you set AutoEnable to NEW, a feature will be configured for only the new accounts when they join the organization.
If you set AutoEnable to NONE, no feature will be configured for the accounts when they join the organization.
RDSDBInstance involved in a GuardDuty finding.
UsageDataSourceResultList:
type: array
items:
$ref: '#/components/schemas/UsageDataSourceResult'
DataSourceList:
type: array
items:
$ref: '#/components/schemas/DataSource'
CreateThreatIntelSetResponse:
type: object
required:
- ThreatIntelSetId
properties:
ThreatIntelSetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: threatIntelSetId
description: The ID of the ThreatIntelSet resource.
FeatureAdditionalConfiguration:
type: string
enum:
- EKS_ADDON_MANAGEMENT
AccountLevelPermissions:
type: object
properties:
BlockPublicAccess:
allOf:
- $ref: '#/components/schemas/BlockPublicAccess'
- xml:
name: blockPublicAccess
description: Describes the S3 Block Public Access settings of the bucket's parent account.
description: Contains information about the account level permissions on the S3 bucket.
IpSetIds:
type: array
items:
$ref: '#/components/schemas/String'
minItems: 0
maxItems: 50
FindingIds:
type: array
items:
$ref: '#/components/schemas/FindingId'
minItems: 0
maxItems: 50
ListCoverageResponse:
type: object
required:
- Resources
properties:
Resources:
allOf:
- $ref: '#/components/schemas/CoverageResources'
- xml:
name: resources
description: A list of resources and their attributes providing cluster details.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The pagination parameter to be used on the next list operation to retrieve more items.
FindingType:
type: string
minLength: 1
maxLength: 50
GetRemainingFreeTrialDaysResponse:
type: object
properties:
Accounts:
allOf:
- $ref: '#/components/schemas/AccountFreeTrialInfos'
- xml:
name: accounts
description: The member accounts which were included in a request and were processed successfully.
UnprocessedAccounts:
allOf:
- $ref: '#/components/schemas/UnprocessedAccounts'
- xml:
name: unprocessedAccounts
description: The member account that was included in a request but for which the request could not be processed.
ScanConditionPair:
type: object
required:
- Key
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- xml:
name: key
description: Represents key in the map condition.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- xml:
name: value
description: Represents optional value in the map condition. If not specified, only key will be matched.
description: Represents key, value pair to be matched against given resource property.
OrganizationAdditionalConfigurations:
type: array
items:
$ref: '#/components/schemas/OrganizationAdditionalConfiguration'
OrgFeature:
type: string
enum:
- S3_DATA_EVENTS
- EKS_AUDIT_LOGS
- EBS_MALWARE_PROTECTION
- RDS_LOGIN_EVENTS
- EKS_RUNTIME_MONITORING
- LAMBDA_NETWORK_LOGS
CountBySeverity:
type: object
additionalProperties:
$ref: '#/components/schemas/Integer'
CoverageStatus:
type: string
enum:
- HEALTHY
- UNHEALTHY
VolumeDetails:
type: array
items:
$ref: '#/components/schemas/VolumeDetail'
UnprocessedAccounts:
type: array
items:
$ref: '#/components/schemas/UnprocessedAccount'
minItems: 0
maxItems: 50
MemberFeaturesConfigurationResult:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/OrgFeature'
- xml:
name: name
description: Indicates the name of the feature that is enabled for the detector.
Status:
allOf:
- $ref: '#/components/schemas/FeatureStatus'
- xml:
name: status
description: Indicates the status of the feature that is enabled for the detector.
UpdatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: updatedAt
description: The timestamp at which the feature object was updated.
AdditionalConfiguration:
allOf:
- $ref: '#/components/schemas/MemberAdditionalConfigurationResults'
- xml:
name: additionalConfiguration
description: Indicates the additional configuration of the feature that is configured for the member account.
description: Contains information about the features for the member account.
DeletePublishingDestinationResponse:
type: object
properties: {}
ScanThreatName:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the identified threat.
Severity:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: severity
description: Severity of threat identified as part of the malware scan.
ItemCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: itemCount
description: Total number of files infected with given threat.
FilePaths:
allOf:
- $ref: '#/components/schemas/FilePaths'
- xml:
name: filePaths
description: List of infected files in EBS volume with details.
description: Contains files infected with the given threat providing details of malware name and severity.
KubernetesApiCallAction:
type: object
properties:
RequestUri:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: requestUri
description: The Kubernetes API request URI.
Verb:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verb
description: The Kubernetes API request HTTP verb.
SourceIps:
allOf:
- $ref: '#/components/schemas/SourceIps'
- xml:
name: sourceIps
description: The IP of the Kubernetes API caller and the IPs of any proxies or load balancers between the caller and the API endpoint.
UserAgent:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: userAgent
description: The user agent of the caller of the Kubernetes API.
RemoteIpDetails:
allOf:
- $ref: '#/components/schemas/RemoteIpDetails'
- xml:
name: remoteIpDetails
StatusCode:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: statusCode
description: The resulting HTTP response code of the Kubernetes API call action.
Parameters:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: parameters
description: Parameters related to the Kubernetes API call action.
description: Information about the Kubernetes API call action described in this finding.
PortProbeDetails:
type: array
items:
$ref: '#/components/schemas/PortProbeDetail'
ScannedItemCount:
type: object
properties:
TotalGb:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalGb
description: Total GB of files scanned for malware.
Files:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: files
description: Number of files scanned.
Volumes:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: volumes
description: Total number of scanned volumes.
description: Total number of scanned files.
KubernetesAuditLogsConfiguration:
type: object
required:
- Enable
properties:
Enable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enable
description: The status of Kubernetes audit logs as a data source.
description: Describes whether Kubernetes audit logs are enabled as a data source.
DomainDetails:
type: object
properties:
Domain:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: domain
description: The domain information for the Amazon Web Services API call.
description: Contains information about the domain.
OrganizationDataSourceConfigurationsResult:
type: object
required:
- S3Logs
properties:
S3Logs:
allOf:
- $ref: '#/components/schemas/OrganizationS3LogsConfigurationResult'
- xml:
name: s3Logs
description: Describes whether S3 data event logs are enabled as a data source.
Kubernetes:
allOf:
- $ref: '#/components/schemas/OrganizationKubernetesConfigurationResult'
- xml:
name: kubernetes
description: Describes the configuration of Kubernetes data sources.
MalwareProtection:
allOf:
- $ref: '#/components/schemas/OrganizationMalwareProtectionConfigurationResult'
- xml:
name: malwareProtection
description: Describes the configuration of Malware Protection data source for an organization.
description: An object that contains information on which data sources are automatically enabled for new members within the organization.
TagKey:
type: string
pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
minLength: 1
maxLength: 128
UpdateDetectorResponse:
type: object
properties: {}
DescribeOrganizationConfigurationResponse:
type: object
required:
- MemberAccountLimitReached
properties:
AutoEnable:
allOf:
- $ref: '#/components/schemas/Boolean'
- deprecated: true
xml:
name: autoEnable
description: 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.
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 Amazon Web Services 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 accounts in the organization. GuardDuty must be managed for each account individually by the administrator.
Destinations object that includes information about each publishing destination returned.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: 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.
ScanCondition:
type: object
required:
- MapEquals
properties:
MapEquals:
allOf:
- $ref: '#/components/schemas/MapEquals'
- xml:
name: mapEquals
description: Represents an mapEqual condition to be applied to a single field when triggering for malware scan.
description: Contains information about the condition.
UpdateFilterResponse:
type: object
required:
- Name
properties:
Name:
allOf:
- $ref: '#/components/schemas/FilterName'
- xml:
name: name
description: The name of the filter.
GetMemberDetectorsResponse:
type: object
required:
- MemberDataSourceConfigurations
- UnprocessedAccounts
properties:
MemberDataSourceConfigurations:
allOf:
- $ref: '#/components/schemas/MemberDataSourceConfigurations'
- xml:
name: members
description: An object that describes which data sources are enabled for a member account.
UnprocessedAccounts:
allOf:
- $ref: '#/components/schemas/UnprocessedAccounts'
- xml:
name: unprocessedAccounts
description: A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.
FindingStatisticType:
type: string
enum:
- COUNT_BY_SEVERITY
Member:
type: object
required:
- AccountId
- MasterId
- Email
- RelationshipStatus
- UpdatedAt
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- xml:
name: accountId
description: The ID of the member account.
DetectorId:
allOf:
- $ref: '#/components/schemas/DetectorId'
- xml:
name: detectorId
description: The detector ID of the member account.
MasterId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: masterId
description: The administrator account ID.
Email:
allOf:
- $ref: '#/components/schemas/Email'
- xml:
name: email
description: The email address of the member account.
RelationshipStatus:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: relationshipStatus
description: The status of the relationship between the member and the administrator.
InvitedAt:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: invitedAt
description: The timestamp when the invitation was sent.
UpdatedAt:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: updatedAt
description: The last-updated timestamp of the member.
AdministratorId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: administratorId
description: The administrator account ID.
description: 'Contains information about the member account. '
OrganizationScanEc2InstanceWithFindings:
type: object
properties:
EbsVolumes:
allOf:
- $ref: '#/components/schemas/OrganizationEbsVolumes'
- xml:
name: ebsVolumes
description: Whether scanning EBS volumes should be auto-enabled for new members joining the organization.
description: Organization-wide EC2 instances with findings scan configuration.
OrganizationKubernetesAuditLogsConfigurationResult:
type: object
required:
- AutoEnable
properties:
AutoEnable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: autoEnable
description: Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization.
description: The current configuration of Kubernetes audit logs as a data source for the organization.
DescribeMalwareScansResponse:
type: object
required:
- Scans
properties:
Scans:
allOf:
- $ref: '#/components/schemas/Scans'
- xml:
name: scans
description: Contains information about malware scans.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The pagination parameter to be used on the next list operation to retrieve more items.
FilterRank:
type: integer
minimum: 1
maximum: 100
GetFindingsStatisticsResponse:
type: object
required:
- FindingStatistics
properties:
FindingStatistics:
allOf:
- $ref: '#/components/schemas/FindingStatistics'
- xml:
name: findingStatistics
description: The finding statistics object.
DeleteThreatIntelSetResponse:
type: object
properties: {}
LocalIpDetails:
type: object
properties:
IpAddressV4:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipAddressV4
description: The IPv4 local address of the connection.
description: Contains information about the local IP address of the connection.
OrganizationS3LogsConfiguration:
type: object
required:
- AutoEnable
properties:
AutoEnable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: autoEnable
description: A value that contains information on whether S3 data event logs will be enabled automatically as a data source for the organization.
description: Describes whether S3 data event logs will be automatically enabled for new members of the organization.
UpdatePublishingDestinationResponse:
type: object
properties: {}
CoverageFilterCriterionKey:
type: string
enum:
- ACCOUNT_ID
- CLUSTER_NAME
- RESOURCE_TYPE
- COVERAGE_STATUS
- ADDON_VERSION
DetectorFeatureConfigurationsResults:
type: array
items:
$ref: '#/components/schemas/DetectorFeatureConfigurationResult'
DeleteDetectorResponse:
type: object
properties: {}
AccessControlList:
type: object
properties:
AllowsPublicReadAccess:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowsPublicReadAccess
description: A value that indicates whether public read access for the bucket is enabled through an Access Control List (ACL).
AllowsPublicWriteAccess:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowsPublicWriteAccess
description: A value that indicates whether public write access for the bucket is enabled through an Access Control List (ACL).
description: Contains information on the current access control policies for the bucket.
ResourceList:
type: array
items:
$ref: '#/components/schemas/String'
PortProbeDetail:
type: object
properties:
LocalPortDetails:
allOf:
- $ref: '#/components/schemas/LocalPortDetails'
- xml:
name: localPortDetails
description: The local port information of the connection.
LocalIpDetails:
allOf:
- $ref: '#/components/schemas/LocalIpDetails'
- xml:
name: localIpDetails
description: The local IP information of the connection.
RemoteIpDetails:
allOf:
- $ref: '#/components/schemas/RemoteIpDetails'
- xml:
name: remoteIpDetails
description: The remote IP information of the connection.
description: Contains information about the port probe details.
AddonDetails:
type: object
properties:
AddonVersion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: addonVersion
description: Version of the installed EKS add-on.
AddonStatus:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: addonStatus
description: Status of the installed EKS add-on.
description: Information about the installed EKS add-on (GuardDuty security agent).
VolumeMount:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: Volume mount name.
MountPath:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: mountPath
description: Volume mount path.
description: Container volume mount.
Equals:
type: array
items:
$ref: '#/components/schemas/String'
AccountFreeTrialInfos:
type: array
items:
$ref: '#/components/schemas/AccountFreeTrialInfo'
EcsClusterDetails:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the ECS Cluster.
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The Amazon Resource Name (ARN) that identifies the cluster.
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: The status of the ECS cluster.
ActiveServicesCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: activeServicesCount
description: The number of services that are running on the cluster in an ACTIVE state.
RegisteredContainerInstancesCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: registeredContainerInstancesCount
description: The number of container instances registered into the cluster.
RunningTasksCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: runningTasksCount
description: The number of tasks in the cluster that are in the RUNNING state.
Tags:
allOf:
- $ref: '#/components/schemas/Tags'
- xml:
name: tags
description: The tags of the ECS Cluster.
TaskDetails:
allOf:
- $ref: '#/components/schemas/EcsTaskDetails'
- xml:
name: taskDetails
description: Contains information about the details of the ECS Task.
description: Contains information about the details of the ECS Cluster.
EbsSnapshotPreservation:
type: string
enum:
- NO_RETENTION
- RETENTION_WITH_FINDING
S3LogsConfigurationResult:
type: object
required:
- Status
properties:
Status:
allOf:
- $ref: '#/components/schemas/DataSourceStatus'
- xml:
name: status
description: A value that describes whether S3 data event logs are automatically enabled for new members of the organization.
description: Describes whether S3 data event logs will be enabled as a data source.
RemoteIpDetails:
type: object
properties:
City:
allOf:
- $ref: '#/components/schemas/City'
- xml:
name: city
description: The city information of the remote IP address.
Country:
allOf:
- $ref: '#/components/schemas/Country'
- xml:
name: country
description: The country code of the remote IP address.
GeoLocation:
allOf:
- $ref: '#/components/schemas/GeoLocation'
- xml:
name: geoLocation
description: The location information of the remote IP address.
IpAddressV4:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipAddressV4
description: The IPv4 remote address of the connection.
Organization:
allOf:
- $ref: '#/components/schemas/Organization'
- xml:
name: organization
description: The ISP organization information of the remote IP address.
description: Contains information about the remote IP address of the connection.
AutoEnableMembers:
type: string
enum:
- NEW
- ALL
- NONE
CoverageFilterCondition:
type: object
properties:
Equals:
allOf:
- $ref: '#/components/schemas/Equals'
- xml:
name: equals
description: Represents an equal condition that is applied to a single field while retrieving the coverage details.
NotEquals:
allOf:
- $ref: '#/components/schemas/NotEquals'
- xml:
name: notEquals
description: Represents a not equal condition that is applied to a single field while retrieving the coverage details.
description: Represents a condition that when matched will be added to the response of the operation.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
InstanceDetails:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone of the EC2 instance.
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfile'
- xml:
name: iamInstanceProfile
description: The profile information of the EC2 instance.
ImageDescription:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageDescription
description: The image description of the EC2 instance.
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The image ID of the EC2 instance.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the EC2 instance.
InstanceState:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceState
description: The state of the EC2 instance.
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: The type of the EC2 instance.
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost. Only applicable to Amazon Web Services Outposts instances.
LaunchTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: launchTime
description: The launch time of the EC2 instance.
NetworkInterfaces:
allOf:
- $ref: '#/components/schemas/NetworkInterfaces'
- xml:
name: networkInterfaces
description: The elastic network interface information of the EC2 instance.
Platform:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: platform
description: The platform of the EC2 instance.
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodes'
- xml:
name: productCodes
description: The product code of the EC2 instance.
Tags:
allOf:
- $ref: '#/components/schemas/Tags'
- xml:
name: tags
description: The tags of the EC2 instance.
description: Contains information about the details of an instance.
ThreatDetectedByName:
type: object
properties:
ItemCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: itemCount
description: Total number of infected files identified.
UniqueThreatNameCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: uniqueThreatNameCount
description: Total number of unique threats by name identified, as part of the malware scan.
Shortened:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: shortened
description: Flag to determine if the finding contains every single infected file-path and/or every threat.
ThreatNames:
allOf:
- $ref: '#/components/schemas/ScanThreatNames'
- xml:
name: threatNames
description: List of identified threats with details, organized by threat name.
description: Contains details about identified threats organized by threat name.
Integer:
type: integer
ThreatIntelligenceDetail:
type: object
properties:
ThreatListName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: threatListName
description: The name of the threat intelligence list that triggered the finding.
ThreatNames:
allOf:
- $ref: '#/components/schemas/ThreatNames'
- xml:
name: threatNames
description: A list of names of the threats in the threat intelligence list that triggered the finding.
description: An instance of a threat intelligence detail that constitutes evidence for the finding.
Total:
type: object
properties:
Amount:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: amount
description: The total usage.
Unit:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: unit
description: The currency unit that the amount is given in.
description: Contains the total usage with the corresponding currency unit for that value.
OrganizationAdditionalConfiguration:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/OrgFeatureAdditionalConfiguration'
- xml:
name: name
description: The name of the additional configuration that will be configured for the organization.
AutoEnable:
allOf:
- $ref: '#/components/schemas/OrgFeatureStatus'
- xml:
name: autoEnable
description: The status of the additional configuration that will be configured for the organization.
description: A list of additional configurations which will be configured for the organization.
CoverageFilterCriterionList:
type: array
items:
$ref: '#/components/schemas/CoverageFilterCriterion'
minItems: 0
maxItems: 50
AwsApiCallAction:
type: object
properties:
Api:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: api
description: The Amazon Web Services API name.
CallerType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: callerType
description: The Amazon Web Services API caller type.
DomainDetails:
allOf:
- $ref: '#/components/schemas/DomainDetails'
- xml:
name: domainDetails
description: The domain information for the Amazon Web Services API call.
ErrorCode:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: errorCode
description: The error code of the failed Amazon Web Services API action.
UserAgent:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: userAgent
description: The agent through which the API request was made.
RemoteIpDetails:
allOf:
- $ref: '#/components/schemas/RemoteIpDetails'
- xml:
name: remoteIpDetails
description: The remote IP information of the connection that initiated the Amazon Web Services API call.
ServiceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceName
description: The Amazon Web Services service name whose API was invoked.
RemoteAccountDetails:
allOf:
- $ref: '#/components/schemas/RemoteAccountDetails'
- xml:
name: remoteAccountDetails
description: 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.
AffectedResources:
allOf:
- $ref: '#/components/schemas/AffectedResources'
- xml:
name: affectedResources
description: 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.
description: Contains information about the API action.
OrganizationEbsVolumesResult:
type: object
properties:
AutoEnable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: autoEnable
description: An object that contains the status of whether scanning EBS volumes should be auto-enabled for new members joining the organization.
description: An object that contains information on the status of whether EBS volumes scanning will be enabled as a data source for an organization.
AcceptAdministratorInvitationResponse:
type: object
properties: {}
DefaultServerSideEncryption:
type: object
properties:
EncryptionType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: encryptionType
description: The type of encryption used for objects within the S3 bucket.
KmsMasterKeyArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: kmsMasterKeyArn
description: The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket EncryptionType is aws:kms.
description: Contains information on the server side encryption method used in the S3 bucket. See S3 Server-Side Encryption for more information.
IpSetFormat:
type: string
enum:
- TXT
- STIX
- OTX_CSV
- ALIEN_VAULT
- PROOF_POINT
- FIRE_EYE
minLength: 1
maxLength: 300
UsageStatistics:
type: object
properties:
SumByAccount:
allOf:
- $ref: '#/components/schemas/UsageAccountResultList'
- xml:
name: sumByAccount
description: The usage statistic sum organized by account ID.
SumByDataSource:
allOf:
- $ref: '#/components/schemas/UsageDataSourceResultList'
- xml:
name: sumByDataSource
description: The usage statistic sum organized by on data source.
SumByResource:
allOf:
- $ref: '#/components/schemas/UsageResourceResultList'
- xml:
name: sumByResource
description: The usage statistic sum organized by resource.
TopResources:
allOf:
- $ref: '#/components/schemas/UsageResourceResultList'
- xml:
name: topResources
description: Lists the top 50 resources that have generated the most GuardDuty usage, in order from most to least expensive.
SumByFeature:
allOf:
- $ref: '#/components/schemas/UsageFeatureResultList'
- xml:
name: sumByFeature
description: The usage statistic sum organized by feature.
description: 'Contains the result of GuardDuty usage. If a UsageStatisticType is provided the result for other types will be null. '
NonEmptyString:
type: string
minLength: 1
maxLength: 200
RdsDbUserDetails:
type: object
properties:
User:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: user
description: The user name used in the anomalous login attempt.
Application:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: application
description: The application name used in the anomalous login attempt.
Database:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: database
description: The name of the database instance involved in the anomalous login attempt.
Ssl:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ssl
description: The version of the Secure Socket Layer (SSL) used for the network.
AuthMethod:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: authMethod
description: The authentication method used by the user involved in the finding.
description: Contains information about the user and authentication details for a database instance involved in the finding.
HighestSeverityThreatDetails:
type: object
properties:
Severity:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: severity
description: Severity level of the highest severity threat detected.
ThreatName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: threatName
description: Threat name of the highest severity threat detected as part of the malware scan.
Count:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: count
description: Total number of infected files with the highest severity threat detected.
description: Contains details of the highest severity threat detected during scan and number of infected files.
DetectorAdditionalConfigurationResults:
type: array
items:
$ref: '#/components/schemas/DetectorAdditionalConfigurationResult'
UsageFeatureResultList:
type: array
items:
$ref: '#/components/schemas/UsageFeatureResult'
FlagsList:
type: array
items:
$ref: '#/components/schemas/String'
StopMonitoringMembersResponse:
type: object
required:
- UnprocessedAccounts
properties:
UnprocessedAccounts:
allOf:
- $ref: '#/components/schemas/UnprocessedAccounts'
- xml:
name: unprocessedAccounts
description: '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. '
Volumes:
type: array
items:
$ref: '#/components/schemas/Volume'
BucketLevelPermissions:
type: object
properties:
AccessControlList:
allOf:
- $ref: '#/components/schemas/AccessControlList'
- xml:
name: accessControlList
description: Contains information on how Access Control Policies are applied to the bucket.
BucketPolicy:
allOf:
- $ref: '#/components/schemas/BucketPolicy'
- xml:
name: bucketPolicy
description: Contains information on the bucket policies for the S3 bucket.
BlockPublicAccess:
allOf:
- $ref: '#/components/schemas/BlockPublicAccess'
- xml:
name: blockPublicAccess
description: Contains information on which account level S3 Block Public Access settings are applied to the S3 bucket.
description: Contains information about the bucket level permissions for the S3 bucket.
ResourceDetails:
type: object
properties:
InstanceArn:
allOf:
- $ref: '#/components/schemas/InstanceArn'
- xml:
name: instanceArn
description: InstanceArn that was scanned in the scan entry.
description: Represents the resources that were scanned in the scan entry.
DestinationProperties:
type: object
properties:
DestinationArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationArn
description: '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/
RDS_LOGIN_ATTEMPT action described in this finding.
description: Contains information about actions.
ScanResultDetails:
type: object
properties:
ScanResult:
allOf:
- $ref: '#/components/schemas/ScanResult'
- xml:
name: scanResult
description: An enum value representing possible scan results.
description: Represents the result of the scan.
FilterName:
type: string
minLength: 3
maxLength: 64
ProductCodes:
type: array
items:
$ref: '#/components/schemas/ProductCode'
LoginAttributes:
type: array
items:
$ref: '#/components/schemas/LoginAttribute'
CriterionKey:
type: string
enum:
- EC2_INSTANCE_ARN
- SCAN_ID
- ACCOUNT_ID
- GUARDDUTY_FINDING_ID
- SCAN_START_TIME
- SCAN_STATUS
ThreatsDetectedItemCount:
type: object
properties:
Files:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: files
description: Total number of infected files.
description: Contains total number of infected files.
CoverageStatisticsType:
type: string
enum:
- COUNT_BY_RESOURCE_TYPE
- COUNT_BY_COVERAGE_STATUS
Owner:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: id
description: 'The canonical user ID of the bucket owner. For information about locating your canonical user ID see Finding Your Account Canonical User ID. '
description: Contains information on the owner of the bucket.
UpdateOrganizationConfigurationResponse:
type: object
properties: {}
KubernetesConfigurationResult:
type: object
required:
- AuditLogs
properties:
AuditLogs:
allOf:
- $ref: '#/components/schemas/KubernetesAuditLogsConfigurationResult'
- xml:
name: auditLogs
description: Describes whether Kubernetes audit logs are enabled as a data source.
description: Describes whether any Kubernetes logs will be enabled as a data source.
NetworkInterface:
type: object
properties:
Ipv6Addresses:
allOf:
- $ref: '#/components/schemas/Ipv6Addresses'
- xml:
name: ipv6Addresses
description: A list of IPv6 addresses for the EC2 instance.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
PrivateDnsName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateDnsName
description: The private DNS name of the EC2 instance.
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateIpAddress
description: The private IP address of the EC2 instance.
PrivateIpAddresses:
allOf:
- $ref: '#/components/schemas/PrivateIpAddresses'
- xml:
name: privateIpAddresses
description: Other private IP address information of the EC2 instance.
PublicDnsName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicDnsName
description: The public DNS name of the EC2 instance.
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The public IP address of the EC2 instance.
SecurityGroups:
allOf:
- $ref: '#/components/schemas/SecurityGroups'
- xml:
name: securityGroups
description: The security groups associated with the EC2 instance.
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: subnetId
description: The subnet ID of the EC2 instance.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The VPC ID of the EC2 instance.
description: Contains information about the elastic network interface of the EC2 instance.
Destinations:
type: array
items:
$ref: '#/components/schemas/Destination'
CreateDetectorResponse:
type: object
properties:
DetectorId:
allOf:
- $ref: '#/components/schemas/DetectorId'
- xml:
name: detectorId
description: The unique ID of the created detector.
UnprocessedDataSources:
allOf:
- $ref: '#/components/schemas/UnprocessedDataSourcesResult'
- xml:
name: unprocessedDataSources
description: Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the first time.
Timestamp:
type: string
format: date-time
Country:
type: object
properties:
CountryCode:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: countryCode
description: The country code of the remote IP address.
CountryName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: countryName
description: The country name of the remote IP address.
description: Contains information about the country where the remote IP address is located.
HostPath:
type: object
properties:
Path:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: path
description: Path of the file or directory on the host that the volume maps to.
description: Represents a pre-existing file or directory on the host machine that the volume maps to.
UsageFeatureList:
type: array
items:
$ref: '#/components/schemas/UsageFeature'
PrivateIpAddresses:
type: array
items:
$ref: '#/components/schemas/PrivateIpAddressDetails'
Finding:
type: object
required:
- AccountId
- Arn
- CreatedAt
- Id
- Region
- Resource
- SchemaVersion
- Severity
- Type
- UpdatedAt
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: accountId
description: The ID of the account in which the finding was generated.
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The ARN of the finding.
Confidence:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: confidence
description: The confidence score for the finding.
CreatedAt:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: createdAt
description: The time and date when the finding was created.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the finding.
Id:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: id
description: The ID of the finding.
Partition:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: partition
description: The partition associated with the finding.
Region:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: region
description: The Region where the finding was generated.
Resource:
allOf:
- $ref: '#/components/schemas/Resource'
- xml:
name: resource
SchemaVersion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: schemaVersion
description: The version of the schema used for the finding.
Service:
allOf:
- $ref: '#/components/schemas/Service'
- xml:
name: service
Severity:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: severity
description: The severity of the finding.
Title:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: title
description: The title of the finding.
Type:
allOf:
- $ref: '#/components/schemas/FindingType'
- xml:
name: type
description: The type of finding.
UpdatedAt:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: updatedAt
description: The time and date when the finding was last updated.
description: Contains information about the finding, which is generated when abnormal or suspicious activity is detected.
Criterion:
type: object
additionalProperties:
$ref: '#/components/schemas/Condition'
OrganizationMalwareProtectionConfigurationResult:
type: object
properties:
ScanEc2InstanceWithFindings:
allOf:
- $ref: '#/components/schemas/OrganizationScanEc2InstanceWithFindingsResult'
- xml:
name: scanEc2InstanceWithFindings
description: Describes the configuration for scanning EC2 instances with findings for an organization.
description: An object that contains information on the status of all Malware Protection data source for an organization.
ScanFilePath:
type: object
properties:
FilePath:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: filePath
description: The file path of the infected file.
VolumeArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeArn
description: EBS volume Arn details of the infected file.
Hash:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hash
description: The hash value of the infected file.
FileName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: fileName
description: File name of the infected file.
description: Contains details of infected file including name, file path and hash.
MemberDataSourceConfiguration:
type: object
required:
- AccountId
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- xml:
name: accountId
description: The account ID for the member account.
DataSources:
allOf:
- $ref: '#/components/schemas/DataSourceConfigurationsResult'
- deprecated: true
xml:
name: dataSources
description: Contains information on the status of data sources for the account.This parameter is deprecated, use Features instead
Features:
allOf:
- $ref: '#/components/schemas/MemberFeaturesConfigurationsResults'
- xml:
name: features
description: Contains information about the status of the features for the member account.
description: Contains information on which data sources are enabled for a member account.
FlowLogsConfigurationResult:
type: object
required:
- Status
properties:
Status:
allOf:
- $ref: '#/components/schemas/DataSourceStatus'
- xml:
name: status
description: Denotes whether VPC flow logs is enabled as a data source.
description: Contains information on the status of VPC flow logs as a data source.
MalwareProtectionDataSourceFreeTrial:
type: object
properties:
ScanEc2InstanceWithFindings:
allOf:
- $ref: '#/components/schemas/DataSourceFreeTrial'
- xml:
name: scanEc2InstanceWithFindings
description: Describes whether Malware Protection for EC2 instances with findings is enabled as a data source.
description: Provides details about Malware Protection when it is enabled as a data source.
DestinationType:
type: string
enum:
- S3
minLength: 1
maxLength: 300
Findings:
type: array
items:
$ref: '#/components/schemas/Finding'
minItems: 0
maxItems: 50
FindingId:
type: string
minLength: 1
maxLength: 300
DeleteMembersResponse:
type: object
required:
- UnprocessedAccounts
properties:
UnprocessedAccounts:
allOf:
- $ref: '#/components/schemas/UnprocessedAccounts'
- xml:
name: unprocessedAccounts
description: The accounts that could not be processed.
OrgFeatureAdditionalConfiguration:
type: string
enum:
- EKS_ADDON_MANAGEMENT
FilterAction:
type: string
enum:
- NOOP
- ARCHIVE
minLength: 1
maxLength: 300
VolumeMounts:
type: array
items:
$ref: '#/components/schemas/VolumeMount'
AccountFreeTrialInfo:
type: object
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: accountId
description: The account identifier of the GuardDuty member account.
DataSources:
allOf:
- $ref: '#/components/schemas/DataSourcesFreeTrial'
- deprecated: true
xml:
name: dataSources
description: Describes the data source enabled for the GuardDuty member account.This parameter is deprecated, use Features instead
Features:
allOf:
- $ref: '#/components/schemas/FreeTrialFeatureConfigurationsResults'
- xml:
name: features
description: A list of features enabled for the GuardDuty account.
description: Provides details of the GuardDuty member account that uses a free trial service.
Eq:
type: array
items:
$ref: '#/components/schemas/String'
MemberFeaturesConfigurationsResults:
type: array
items:
$ref: '#/components/schemas/MemberFeaturesConfigurationResult'
InviteMembersResponse:
type: object
required:
- UnprocessedAccounts
properties:
UnprocessedAccounts:
allOf:
- $ref: '#/components/schemas/UnprocessedAccounts'
- xml:
name: unprocessedAccounts
description: A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
EcsTaskDetails:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The Amazon Resource Name (ARN) of the task.
DefinitionArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: definitionArn
description: The ARN of the task definition that creates the task.
Version:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: version
description: The version counter for the task.
TaskCreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: createdAt
description: The Unix timestamp for the time when the task was created.
StartedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: startedAt
description: The Unix timestamp for the time when the task started.
StartedBy:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: startedBy
description: Contains the tag specified when a task is started.
Tags:
allOf:
- $ref: '#/components/schemas/Tags'
- xml:
name: tags
description: The tags of the ECS Task.
Volumes:
allOf:
- $ref: '#/components/schemas/Volumes'
- xml:
name: volumes
description: The list of data volume definitions for the task.
Containers:
allOf:
- $ref: '#/components/schemas/Containers'
- xml:
name: containers
description: The containers that's associated with the task.
Group:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: group
description: The name of the task group that's associated with the task.
description: Contains information about the task in an ECS cluster.
OrganizationKubernetesConfigurationResult:
type: object
required:
- AuditLogs
properties:
AuditLogs:
allOf:
- $ref: '#/components/schemas/OrganizationKubernetesAuditLogsConfigurationResult'
- xml:
name: auditLogs
description: The current configuration of Kubernetes audit logs as a data source for the organization.
description: The current configuration of all Kubernetes data sources for the organization.
S3LogsConfiguration:
type: object
required:
- Enable
properties:
Enable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enable
description: ' The status of S3 data event logs as a data source.'
description: Describes whether S3 data event logs will be enabled as a data source.
Sources:
type: array
items:
$ref: '#/components/schemas/String'
Scan:
type: object
properties:
DetectorId:
allOf:
- $ref: '#/components/schemas/DetectorId'
- xml:
name: detectorId
description: The unique ID of the detector that the request is associated with.
AdminDetectorId:
allOf:
- $ref: '#/components/schemas/DetectorId'
- xml:
name: adminDetectorId
description: 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.
ScanId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- xml:
name: scanId
description: The unique scan ID associated with a scan entry.
ScanStatus:
allOf:
- $ref: '#/components/schemas/ScanStatus'
- xml:
name: scanStatus
description: An enum value representing possible scan statuses.
FailureReason:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- xml:
name: failureReason
description: Represents the reason for FAILED scan status.
ScanStartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: scanStartTime
description: The timestamp of when the scan was triggered.
ScanEndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- xml:
name: scanEndTime
description: The timestamp of when the scan was finished.
TriggerDetails:
allOf:
- $ref: '#/components/schemas/TriggerDetails'
- xml:
name: triggerDetails
description: Specifies the reason why the scan was initiated.
ResourceDetails:
allOf:
- $ref: '#/components/schemas/ResourceDetails'
- xml:
name: resourceDetails
description: Represents the resources that were scanned in the scan entry.
ScanResultDetails:
allOf:
- $ref: '#/components/schemas/ScanResultDetails'
- xml:
name: scanResultDetails
description: Represents the result of the scan.
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- xml:
name: accountId
description: The ID for the account that belongs to the scan.
TotalBytes:
allOf:
- $ref: '#/components/schemas/PositiveLong'
- xml:
name: totalBytes
description: Represents total bytes that were scanned.
FileCount:
allOf:
- $ref: '#/components/schemas/PositiveLong'
- xml:
name: fileCount
description: Represents the number of files that were scanned.
AttachedVolumes:
allOf:
- $ref: '#/components/schemas/VolumeDetails'
- xml:
name: attachedVolumes
description: List of volumes that were attached to the original instance to be scanned.
description: Contains information about a malware scan.
DataSourceFreeTrial:
type: object
properties:
FreeTrialDaysRemaining:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: freeTrialDaysRemaining
description: A value that specifies the number of days left to use each enabled data source.
description: Contains information about which data sources are enabled for the GuardDuty member account.
BlockPublicAccess:
type: object
properties:
IgnorePublicAcls:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ignorePublicAcls
description: Indicates if S3 Block Public Access is set to IgnorePublicAcls.
RestrictPublicBuckets:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: restrictPublicBuckets
description: Indicates if S3 Block Public Access is set to RestrictPublicBuckets.
BlockPublicAcls:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: blockPublicAcls
description: Indicates if S3 Block Public Access is set to BlockPublicAcls.
BlockPublicPolicy:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: blockPublicPolicy
description: Indicates if S3 Block Public Access is set to BlockPublicPolicy.
description: '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. '
GetCoverageStatisticsResponse:
type: object
properties:
CoverageStatistics:
allOf:
- $ref: '#/components/schemas/CoverageStatistics'
- xml:
name: coverageStatistics
description: Represents the count aggregated by the statusCode and resourceType.
SecurityContext:
type: object
properties:
Privileged:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: privileged
description: Whether the container is privileged.
description: Container security context.
OrgFeatureStatus:
type: string
enum:
- NEW
- NONE
BucketPolicy:
type: object
properties:
AllowsPublicReadAccess:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowsPublicReadAccess
description: A value that indicates whether public read access for the bucket is enabled through a bucket policy.
AllowsPublicWriteAccess:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowsPublicWriteAccess
description: A value that indicates whether public write access for the bucket is enabled through a bucket policy.
description: Contains information on the current bucket policies for the S3 bucket.
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
DetectorStatus:
type: string
enum:
- ENABLED
- DISABLED
minLength: 1
maxLength: 300
AccountIds:
type: array
items:
$ref: '#/components/schemas/AccountId'
minItems: 1
maxItems: 50
Name:
type: string
minLength: 1
maxLength: 300
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
Destination:
type: object
required:
- DestinationId
- DestinationType
- Status
properties:
DestinationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationId
description: The unique ID of the publishing destination.
DestinationType:
allOf:
- $ref: '#/components/schemas/DestinationType'
- xml:
name: destinationType
description: The type of resource used for the publishing destination. Currently, only Amazon S3 buckets are supported.
Status:
allOf:
- $ref: '#/components/schemas/PublishingStatus'
- xml:
name: status
description: The status of the publishing destination.
description: Contains information about the publishing destination, including the ID, type, and status.
Long:
type: integer
Administrator:
type: object
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/AccountId'
- xml:
name: accountId
description: The ID of the account used as the administrator account.
InvitationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: invitationId
description: The value that is used to validate the administrator account to the member account.
RelationshipStatus:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: relationshipStatus
description: The status of the relationship between the administrator and member accounts.
InvitedAt:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: invitedAt
description: The timestamp when the invitation was sent.
description: Contains information about the administrator account and invitation.
CoverageFilterCriterion:
type: object
properties:
CriterionKey:
allOf:
- $ref: '#/components/schemas/CoverageFilterCriterionKey'
- xml:
name: criterionKey
description: An enum value representing possible filter fields.
FilterCondition:
allOf:
- $ref: '#/components/schemas/CoverageFilterCondition'
- xml:
name: filterCondition
description: Contains information about the condition.
description: Represents a condition that when matched will be added to the response of the operation.
parameters:
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/guardduty/
x-hasEquivalentPaths: true