URI HTTP methods Schemas Properties See also

Finding Samples

The Finding Samples resource provides a set of findings that use example data and placeholder values to help you understand and analyze the types of findings that Amazon Macie can generate. A finding is a detailed report of a potential issue with the security or privacy of an Amazon Simple Storage Service (Amazon S3) general purpose bucket or sensitive data in an S3 object. For information about the types of findings that Macie can generate, see Types of findings in the Amazon Macie User Guide.

If you use this resource to create sample findings, Macie generates one sample finding for each supported finding type that you choose to include in the set of samples. You can then review and work with the samples by using the Amazon Macie API or the Amazon Macie console. Depending on the findings filters and publication settings for your Macie account, you can also work with the samples by using Amazon EventBridge and AWS Security Hub. To help you identify a sample finding, Macie sets the value for the sample field of each finding to true. For more information about creating and managing sample findings, see Working with sample findings in the Amazon Macie User Guide.

You can use the Finding Samples resource to create one or more sample findings. To create only certain types of sample findings, use the supported request parameter to specify each type of sample finding that you want to create.

URI

/findings/sample

HTTP methods

POST

Operation ID: CreateSampleFindings

Creates sample findings.

Responses
Status code	Response model	Description
`200`	`Empty Schema`	The request succeeded and there isn't any content to include in the body of the response (No Content).
`400`	`ValidationException`	The request failed because the input doesn't satisfy the constraints specified by the service.
`402`	`ServiceQuotaExceededException`	The request failed because fulfilling the request would exceed one or more service quotas for your account.
`403`	`AccessDeniedException`	The request was denied because you don't have sufficient access to the specified resource.
`404`	`ResourceNotFoundException`	The request failed because the specified resource wasn't found.
`409`	`ConflictException`	The request failed because it conflicts with the current state of the specified resource.
`429`	`ThrottlingException`	The request failed because you sent too many requests during a certain amount of time.
`500`	`InternalServerException`	The request failed due to an unknown internal server error, exception, or failure.

Schemas

Request bodies


{
  "findingTypes": [
    enum
  ]
}

Response bodies

{
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}

Properties

AccessDeniedException

Provides information about an error that occurred due to insufficient access to a specified resource.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ConflictException

Provides information about an error that occurred due to a versioning conflict for a specified resource.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

CreateSampleFindingsRequest

Specifies the types of sample findings to create.

Property	Type	Required	Description
`findingTypes`	Array of type FindingType	False	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.

Empty

The request succeeded and there isn't any content to include in the body of the response (No Content).

FindingType

The type of finding. For details about each type, see Types of findings in the Amazon Macie User Guide. Possible values are:

SensitiveData:S3Object/Multiple
SensitiveData:S3Object/Financial
SensitiveData:S3Object/Personal
SensitiveData:S3Object/Credentials
SensitiveData:S3Object/CustomIdentifier
Policy:IAMUser/S3BucketPublic
Policy:IAMUser/S3BucketSharedExternally
Policy:IAMUser/S3BucketReplicatedExternally
Policy:IAMUser/S3BucketEncryptionDisabled
Policy:IAMUser/S3BlockPublicAccessDisabled
Policy:IAMUser/S3BucketSharedWithCloudFront

InternalServerException

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ResourceNotFoundException

Provides information about an error that occurred because a specified resource wasn't found.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ServiceQuotaExceededException

Provides information about an error that occurred due to one or more service quotas for an account.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ThrottlingException

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.

ValidationException

Provides information about an error that occurred due to a syntax error in a request.

Property	Type	Required	Description
`message`	string	False	The explanation of the error that occurred.