openapi: 3.0.0
info:
version: 2020-01-01
x-release: v4
title: Amazon Macie 2 Admin#adminAccountId Findings API
description: Amazon Macie
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: macie2
x-aws-signingName: macie2
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/macie2-2020-01-01.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://macie2.{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 Macie 2 multi-region endpoint
- url: https://macie2.{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 Macie 2 multi-region endpoint
- url: http://macie2.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Macie 2 endpoint for China (Beijing) and China (Ningxia)
- url: https://macie2.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Macie 2 endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Findings
paths:
/findings/sample:
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: Creates sample findings.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSampleFindingsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'486':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
findingTypes:
description: An array of finding types, one for each type of sample finding to create. To create a sample of every type of finding that Amazon Macie supports, don't include this array in your request.
type: array
items:
$ref: '#/components/schemas/FindingType'
summary: Amazon Macie Create Sample Findings
tags:
- Findings
/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: GetFindingStatistics
description: ' <p>Retrieves (queries) aggregated statistical data about findings.</p>'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetFindingStatisticsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'486':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- groupBy
properties:
findingCriteria:
description: Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
type: object
properties:
criterion:
allOf:
- $ref: '#/components/schemas/Criterion'
- description: A condition that specifies the property, operator, and one or more values to use to filter the results.
groupBy:
description: <p>The finding property to use to group the query results. Valid values are:</p> <ul><li><p>classificationDetails.jobId - The unique identifier for the classification job that produced the finding.</p></li> <li><p>resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.</p></li> <li><p>severity.description - The severity level of the finding, such as High or Medium.</p></li> <li><p>type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.</p></li></ul>
type: string
enum:
- resourcesAffected.s3Bucket.name
- type
- classificationDetails.jobId
- severity.description
size:
description: The maximum number of items to include in each page of the response.
type: integer
sortCriteria:
description: Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.
type: object
properties:
attributeName:
allOf:
- $ref: '#/components/schemas/FindingStatisticsSortAttributeName'
- description: 'The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.'
orderBy:
allOf:
- $ref: '#/components/schemas/OrderBy'
- description: 'The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.'
summary: Amazon Macie Get Finding Statistics
tags:
- Findings
/findings/describe:
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: GetFindings
description: Retrieves the details of one or more findings.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetFindingsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'486':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- findingIds
properties:
findingIds:
description: An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.
type: array
items:
$ref: '#/components/schemas/__string'
sortCriteria:
description: Specifies criteria for sorting the results of a request for findings.
type: object
properties:
attributeName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.
orderBy:
allOf:
- $ref: '#/components/schemas/OrderBy'
- description: 'The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.'
summary: Amazon Macie Get Findings
tags:
- Findings
/findings/{findingId}/reveal:
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: GetSensitiveDataOccurrences
description: Retrieves occurrences of sensitive data reported by a finding.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSensitiveDataOccurrencesResponse'
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: findingId
in: path
required: true
description: The unique identifier for the finding.
schema:
type: string
summary: Amazon Macie Get Sensitive Data Occurrences
tags:
- Findings
/findings/{findingId}/reveal/availability:
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: GetSensitiveDataOccurrencesAvailability
description: Checks whether occurrences of sensitive data can be retrieved for a finding.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetSensitiveDataOccurrencesAvailabilityResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
parameters:
- name: findingId
in: path
required: true
description: The unique identifier for the finding.
schema:
type: string
summary: Amazon Macie Get Sensitive Data Occurrences Availability
tags:
- Findings
/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: Retrieves a subset of information about one or more findings.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFindingsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'486':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
parameters:
- 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: Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
type: object
properties:
criterion:
allOf:
- $ref: '#/components/schemas/Criterion'
- description: A condition that specifies the property, operator, and one or more values to use to filter the results.
maxResults:
description: The maximum number of items to include in each page of the response.
type: integer
nextToken:
description: The nextToken string that specifies which page of results to return in a paginated response.
type: string
sortCriteria:
description: Specifies criteria for sorting the results of a request for findings.
type: object
properties:
attributeName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.
orderBy:
allOf:
- $ref: '#/components/schemas/OrderBy'
- description: 'The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.'
summary: Amazon Macie List Findings
tags:
- Findings
components:
schemas:
__listOfGroupCount:
type: array
items:
$ref: '#/components/schemas/GroupCount'
EncryptionType:
type: string
enum:
- NONE
- AES256
- aws:kms
- UNKNOWN
description: 'The server-side encryption algorithm that was used to encrypt an S3 object or is used by default to encrypt objects that are added to an S3 bucket. Possible values are:'
ClassificationResult:
type: object
properties:
additionalOccurrences:
allOf:
- $ref: '#/components/schemas/__boolean'
- description: <p>Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.</p> <p>This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).</p>
customDataIdentifiers:
allOf:
- $ref: '#/components/schemas/CustomDataIdentifiers'
- description: The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.
mimeType:
allOf:
- $ref: '#/components/schemas/__string'
- description: The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.
sensitiveData:
allOf:
- $ref: '#/components/schemas/SensitiveData'
- description: The category, types, and number of occurrences of the sensitive data that produced the finding.
sizeClassified:
allOf:
- $ref: '#/components/schemas/__long'
- description: The total size, in bytes, of the data that the finding applies to.
status:
allOf:
- $ref: '#/components/schemas/ClassificationResultStatus'
- description: The status of the finding.
description: Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.
FindingActionType:
type: string
enum:
- AWS_API_CALL
description: 'The type of action that occurred for the resource and produced the policy finding:'
IpCity:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the city.
description: Provides information about the city that an IP address originated from.
GroupCount:
type: object
properties:
count:
allOf:
- $ref: '#/components/schemas/__long'
- description: The total number of findings in the group of query results.
groupKey:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.
description: Provides a group of results for a query that retrieved aggregated statistical data about findings.
__long:
type: integer
CustomDetections:
type: array
description: Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that each identifier detected.
items:
$ref: '#/components/schemas/CustomDetection'
ResourceNotFoundException: {}
DetectedDataDetails:
type: object
required:
- value
properties:
value:
allOf:
- $ref: '#/components/schemas/__stringMin1Max128'
- description: An occurrence of the specified type of sensitive data. Each occurrence can contain 1-128 characters.
description: Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.
__listOfFinding:
type: array
items:
$ref: '#/components/schemas/Finding'
FederatedUser:
type: object
properties:
accessKeyId:
allOf:
- $ref: '#/components/schemas/__string'
- description: The Amazon Web Services access key ID that identifies the credentials.
accountId:
allOf:
- $ref: '#/components/schemas/__string'
- description: The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
arn:
allOf:
- $ref: '#/components/schemas/__string'
- description: The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
principalId:
allOf:
- $ref: '#/components/schemas/__string'
- description: The unique identifier for the entity that was used to get the credentials.
sessionContext:
allOf:
- $ref: '#/components/schemas/SessionContext'
- description: The details of the session that was created for the credentials, including the entity that issued the session.
description: Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the Security Token Service (STS) API.
FindingStatisticsSortAttributeName:
type: string
enum:
- groupKey
- count
description: 'The grouping to sort the results by. Valid values are:'
__double:
type: number
format: double
SessionIssuer:
type: object
properties:
accountId:
allOf:
- $ref: '#/components/schemas/__string'
- description: The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
arn:
allOf:
- $ref: '#/components/schemas/__string'
- description: The Amazon Resource Name (ARN) of the source account, Identity and Access Management (IAM) user, or role that was used to get the credentials.
principalId:
allOf:
- $ref: '#/components/schemas/__string'
- description: The unique identifier for the entity that was used to get the credentials.
type:
allOf:
- $ref: '#/components/schemas/__string'
- description: The source of the temporary security credentials, such as Root, IAMUser, or Role.
userName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.
description: Provides information about the source and type of temporary security credentials that were issued to an entity.
__listOfUnavailabilityReasonCode:
type: array
items:
$ref: '#/components/schemas/UnavailabilityReasonCode'
minItems: 0
KeyValuePair:
type: object
properties:
key:
allOf:
- $ref: '#/components/schemas/__string'
- description: One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.
value:
allOf:
- $ref: '#/components/schemas/__string'
- description: One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.
description: Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
Ranges:
type: array
description: Specifies the locations of occurrences of sensitive data in a non-binary text file.
items:
$ref: '#/components/schemas/Range'
Severity:
type: object
properties:
description:
allOf:
- $ref: '#/components/schemas/SeverityDescription'
- description: The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).
score:
allOf:
- $ref: '#/components/schemas/__long'
- description: The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).
description: Provides the numerical and qualitative representations of a finding's severity.
IpCountry:
type: object
properties:
code:
allOf:
- $ref: '#/components/schemas/__string'
- description: The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.
name:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the country that the IP address originated from.
description: Provides information about the country that an IP address originated from.
Records:
type: array
description: Specifies the locations of occurrences of sensitive data in an Apache Avro object container or a structured data file.
items:
$ref: '#/components/schemas/Record'
AwsService:
type: object
properties:
invokedBy:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the Amazon Web Service that performed the action.
description: Provides information about an Amazon Web Service t
# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-macie/refs/heads/main/openapi/amazon-macie-findings-api-openapi.yml