7248 lines
314 KiB
JSON
7248 lines
314 KiB
JSON
{
|
|
"metadata": {
|
|
"apiVersion": "2020-01-01",
|
|
"endpointPrefix": "macie2",
|
|
"signingName": "macie2",
|
|
"serviceFullName": "Amazon Macie 2",
|
|
"serviceId": "Macie2",
|
|
"protocol": "rest-json",
|
|
"jsonVersion": "1.1",
|
|
"uid": "macie2-2020-01-01",
|
|
"signatureVersion": "v4"
|
|
},
|
|
"operations": {
|
|
"AcceptInvitation": {
|
|
"name": "AcceptInvitation",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/invitations/accept",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "AcceptInvitationRequest"
|
|
},
|
|
"output": {
|
|
"shape": "AcceptInvitationResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Accepts an Amazon Macie membership invitation that was received from a specific account.</p>"
|
|
},
|
|
"BatchGetCustomDataIdentifiers": {
|
|
"name": "BatchGetCustomDataIdentifiers",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/custom-data-identifiers/get",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "BatchGetCustomDataIdentifiersRequest"
|
|
},
|
|
"output": {
|
|
"shape": "BatchGetCustomDataIdentifiersResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves information about one or more custom data identifiers.</p>"
|
|
},
|
|
"CreateClassificationJob": {
|
|
"name": "CreateClassificationJob",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/jobs",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "CreateClassificationJobRequest"
|
|
},
|
|
"output": {
|
|
"shape": "CreateClassificationJobResponse",
|
|
"documentation": "<p>The request succeeded. The specified job was created.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": " <p>Creates and defines the settings for a classification job.</p>"
|
|
},
|
|
"CreateCustomDataIdentifier": {
|
|
"name": "CreateCustomDataIdentifier",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/custom-data-identifiers",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "CreateCustomDataIdentifierRequest"
|
|
},
|
|
"output": {
|
|
"shape": "CreateCustomDataIdentifierResponse",
|
|
"documentation": "<p>The request succeeded. The specified custom data identifier was created.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Creates and defines the criteria and other settings for a custom data identifier.</p>"
|
|
},
|
|
"CreateFindingsFilter": {
|
|
"name": "CreateFindingsFilter",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/findingsfilters",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "CreateFindingsFilterRequest"
|
|
},
|
|
"output": {
|
|
"shape": "CreateFindingsFilterResponse"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Creates and defines the criteria and other settings for a findings filter.</p>"
|
|
},
|
|
"CreateInvitations": {
|
|
"name": "CreateInvitations",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/invitations",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "CreateInvitationsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "CreateInvitationsResponse",
|
|
"documentation": "<p>The request succeeded. Processing might not be complete.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Sends an Amazon Macie membership invitation to one or more accounts.</p>"
|
|
},
|
|
"CreateMember": {
|
|
"name": "CreateMember",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/members",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "CreateMemberRequest"
|
|
},
|
|
"output": {
|
|
"shape": "CreateMemberResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Associates an account with an Amazon Macie administrator account.</p>"
|
|
},
|
|
"CreateSampleFindings": {
|
|
"name": "CreateSampleFindings",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/findings/sample",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "CreateSampleFindingsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "CreateSampleFindingsResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": " <p>Creates sample findings.</p>"
|
|
},
|
|
"DeclineInvitations": {
|
|
"name": "DeclineInvitations",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/invitations/decline",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DeclineInvitationsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DeclineInvitationsResponse",
|
|
"documentation": "<p>The request succeeded. Processing might not be complete.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Declines Amazon Macie membership invitations that were received from specific accounts.</p>"
|
|
},
|
|
"DeleteCustomDataIdentifier": {
|
|
"name": "DeleteCustomDataIdentifier",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"requestUri": "/custom-data-identifiers/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DeleteCustomDataIdentifierRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DeleteCustomDataIdentifierResponse",
|
|
"documentation": "<p>The request succeeded. The specified custom data identifier was deleted and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Soft deletes a custom data identifier.</p>"
|
|
},
|
|
"DeleteFindingsFilter": {
|
|
"name": "DeleteFindingsFilter",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"requestUri": "/findingsfilters/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DeleteFindingsFilterRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DeleteFindingsFilterResponse",
|
|
"documentation": "<p>The request succeeded. The specified findings filter was deleted and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Deletes a findings filter.</p>"
|
|
},
|
|
"DeleteInvitations": {
|
|
"name": "DeleteInvitations",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/invitations/delete",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DeleteInvitationsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DeleteInvitationsResponse",
|
|
"documentation": "<p>The request succeeded. Processing might not be complete.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Deletes Amazon Macie membership invitations that were received from specific accounts.</p>"
|
|
},
|
|
"DeleteMember": {
|
|
"name": "DeleteMember",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"requestUri": "/members/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DeleteMemberRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DeleteMemberResponse",
|
|
"documentation": "<p>The request succeeded. The association was deleted and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Deletes the association between an Amazon Macie administrator account and an account.</p>"
|
|
},
|
|
"DescribeBuckets": {
|
|
"name": "DescribeBuckets",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/datasources/s3",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DescribeBucketsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DescribeBucketsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": " <p>Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.</p>"
|
|
},
|
|
"DescribeClassificationJob": {
|
|
"name": "DescribeClassificationJob",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/jobs/{jobId}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DescribeClassificationJobRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DescribeClassificationJobResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the status and settings for a classification job.</p>"
|
|
},
|
|
"DescribeOrganizationConfiguration": {
|
|
"name": "DescribeOrganizationConfiguration",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/admin/configuration",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DescribeOrganizationConfigurationRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DescribeOrganizationConfigurationResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the Amazon Macie configuration settings for an AWS organization.</p>"
|
|
},
|
|
"DisableMacie": {
|
|
"name": "DisableMacie",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"requestUri": "/macie",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DisableMacieRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DisableMacieResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Disables an Amazon Macie account and deletes Macie resources for the account.</p>"
|
|
},
|
|
"DisableOrganizationAdminAccount": {
|
|
"name": "DisableOrganizationAdminAccount",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"requestUri": "/admin",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DisableOrganizationAdminAccountRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DisableOrganizationAdminAccountResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Disables an account as the delegated Amazon Macie administrator account for an AWS organization.</p>"
|
|
},
|
|
"DisassociateFromAdministratorAccount": {
|
|
"name": "DisassociateFromAdministratorAccount",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/administrator/disassociate",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DisassociateFromAdministratorAccountRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DisassociateFromAdministratorAccountResponse"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Disassociates a member account from its Amazon Macie administrator account.</p>"
|
|
},
|
|
"DisassociateFromMasterAccount": {
|
|
"name": "DisassociateFromMasterAccount",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/master/disassociate",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DisassociateFromMasterAccountRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DisassociateFromMasterAccountResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the <link linkend=\"DisassociateFromAdministratorAccount\">DisassociateFromAdministratorAccount</link> operation.</p>"
|
|
},
|
|
"DisassociateMember": {
|
|
"name": "DisassociateMember",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/members/disassociate/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "DisassociateMemberRequest"
|
|
},
|
|
"output": {
|
|
"shape": "DisassociateMemberResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Disassociates an Amazon Macie administrator account from a member account.</p>"
|
|
},
|
|
"EnableMacie": {
|
|
"name": "EnableMacie",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/macie",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "EnableMacieRequest"
|
|
},
|
|
"output": {
|
|
"shape": "EnableMacieResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Enables Amazon Macie and specifies the configuration settings for a Macie account.</p>"
|
|
},
|
|
"EnableOrganizationAdminAccount": {
|
|
"name": "EnableOrganizationAdminAccount",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/admin",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "EnableOrganizationAdminAccountRequest"
|
|
},
|
|
"output": {
|
|
"shape": "EnableOrganizationAdminAccountResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Designates an account as the delegated Amazon Macie administrator account for an AWS organization.</p>"
|
|
},
|
|
"GetAdministratorAccount": {
|
|
"name": "GetAdministratorAccount",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/administrator",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetAdministratorAccountRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetAdministratorAccountResponse"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves information about the Amazon Macie administrator account for an account.</p>"
|
|
},
|
|
"GetBucketStatistics": {
|
|
"name": "GetBucketStatistics",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/datasources/s3/statistics",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetBucketStatisticsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetBucketStatisticsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": " <p>Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.</p>"
|
|
},
|
|
"GetClassificationExportConfiguration": {
|
|
"name": "GetClassificationExportConfiguration",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/classification-export-configuration",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetClassificationExportConfigurationRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetClassificationExportConfigurationResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the configuration settings for storing data classification results.</p>"
|
|
},
|
|
"GetCustomDataIdentifier": {
|
|
"name": "GetCustomDataIdentifier",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/custom-data-identifiers/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetCustomDataIdentifierRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetCustomDataIdentifierResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the criteria and other settings for a custom data identifier.</p>"
|
|
},
|
|
"GetFindingStatistics": {
|
|
"name": "GetFindingStatistics",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/findings/statistics",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetFindingStatisticsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetFindingStatisticsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": " <p>Retrieves (queries) aggregated statistical data about findings.</p>"
|
|
},
|
|
"GetFindings": {
|
|
"name": "GetFindings",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/findings/describe",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetFindingsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetFindingsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the details of one or more findings.</p>"
|
|
},
|
|
"GetFindingsFilter": {
|
|
"name": "GetFindingsFilter",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/findingsfilters/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetFindingsFilterRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetFindingsFilterResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the criteria and other settings for a findings filter.</p>"
|
|
},
|
|
"GetFindingsPublicationConfiguration": {
|
|
"name": "GetFindingsPublicationConfiguration",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/findings-publication-configuration",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetFindingsPublicationConfigurationRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetFindingsPublicationConfigurationResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the configuration settings for publishing findings to AWS Security Hub.</p>"
|
|
},
|
|
"GetInvitationsCount": {
|
|
"name": "GetInvitationsCount",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/invitations/count",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetInvitationsCountRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetInvitationsCountResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the count of Amazon Macie membership invitations that were received by an account.</p>"
|
|
},
|
|
"GetMacieSession": {
|
|
"name": "GetMacieSession",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/macie",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetMacieSessionRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetMacieSessionResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves the current status and configuration settings for an Amazon Macie account.</p>"
|
|
},
|
|
"GetMasterAccount": {
|
|
"name": "GetMasterAccount",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/master",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetMasterAccountRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetMasterAccountResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the <link linkend=\"GetAdministratorAccount\">GetAdministratorAccount</link> operation.</p>"
|
|
},
|
|
"GetMember": {
|
|
"name": "GetMember",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/members/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetMemberRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetMemberResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves information about an account that's associated with an Amazon Macie administrator account.</p>"
|
|
},
|
|
"GetUsageStatistics": {
|
|
"name": "GetUsageStatistics",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/usage/statistics",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetUsageStatisticsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetUsageStatisticsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves (queries) quotas and aggregated usage data for one or more accounts.</p>"
|
|
},
|
|
"GetUsageTotals": {
|
|
"name": "GetUsageTotals",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/usage",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "GetUsageTotalsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "GetUsageTotalsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves (queries) aggregated usage data for an account.</p>"
|
|
},
|
|
"ListClassificationJobs": {
|
|
"name": "ListClassificationJobs",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/jobs/list",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "ListClassificationJobsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "ListClassificationJobsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves a subset of information about one or more classification jobs.</p>"
|
|
},
|
|
"ListCustomDataIdentifiers": {
|
|
"name": "ListCustomDataIdentifiers",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/custom-data-identifiers/list",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "ListCustomDataIdentifiersRequest"
|
|
},
|
|
"output": {
|
|
"shape": "ListCustomDataIdentifiersResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves a subset of information about all the custom data identifiers for an account.</p>"
|
|
},
|
|
"ListFindings": {
|
|
"name": "ListFindings",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/findings",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "ListFindingsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "ListFindingsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": " <p>Retrieves a subset of information about one or more findings.</p>"
|
|
},
|
|
"ListFindingsFilters": {
|
|
"name": "ListFindingsFilters",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/findingsfilters",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "ListFindingsFiltersRequest"
|
|
},
|
|
"output": {
|
|
"shape": "ListFindingsFiltersResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves a subset of information about all the findings filters for an account.</p>"
|
|
},
|
|
"ListInvitations": {
|
|
"name": "ListInvitations",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/invitations",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "ListInvitationsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "ListInvitationsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves information about all the Amazon Macie membership invitations that were received by an account.</p>"
|
|
},
|
|
"ListMembers": {
|
|
"name": "ListMembers",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/members",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "ListMembersRequest"
|
|
},
|
|
"output": {
|
|
"shape": "ListMembersResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves information about the accounts that are associated with an Amazon Macie administrator account.</p>"
|
|
},
|
|
"ListOrganizationAdminAccounts": {
|
|
"name": "ListOrganizationAdminAccounts",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/admin",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "ListOrganizationAdminAccountsRequest"
|
|
},
|
|
"output": {
|
|
"shape": "ListOrganizationAdminAccountsResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Retrieves information about the delegated Amazon Macie administrator account for an AWS organization.</p>"
|
|
},
|
|
"ListTagsForResource": {
|
|
"name": "ListTagsForResource",
|
|
"http": {
|
|
"method": "GET",
|
|
"requestUri": "/tags/{resourceArn}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "ListTagsForResourceRequest"
|
|
},
|
|
"output": {
|
|
"shape": "ListTagsForResourceResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [],
|
|
"documentation": "<p>Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.</p>"
|
|
},
|
|
"PutClassificationExportConfiguration": {
|
|
"name": "PutClassificationExportConfiguration",
|
|
"http": {
|
|
"method": "PUT",
|
|
"requestUri": "/classification-export-configuration",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "PutClassificationExportConfigurationRequest"
|
|
},
|
|
"output": {
|
|
"shape": "PutClassificationExportConfigurationResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Creates or updates the configuration settings for storing data classification results.</p>"
|
|
},
|
|
"PutFindingsPublicationConfiguration": {
|
|
"name": "PutFindingsPublicationConfiguration",
|
|
"http": {
|
|
"method": "PUT",
|
|
"requestUri": "/findings-publication-configuration",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "PutFindingsPublicationConfigurationRequest"
|
|
},
|
|
"output": {
|
|
"shape": "PutFindingsPublicationConfigurationResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Updates the configuration settings for publishing findings to AWS Security Hub.</p>"
|
|
},
|
|
"TagResource": {
|
|
"name": "TagResource",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/tags/{resourceArn}",
|
|
"responseCode": 204
|
|
},
|
|
"input": {
|
|
"shape": "TagResourceRequest"
|
|
},
|
|
"output": {
|
|
"shape": "TagResourceResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [],
|
|
"documentation": "<p>Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.</p>"
|
|
},
|
|
"TestCustomDataIdentifier": {
|
|
"name": "TestCustomDataIdentifier",
|
|
"http": {
|
|
"method": "POST",
|
|
"requestUri": "/custom-data-identifiers/test",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "TestCustomDataIdentifierRequest"
|
|
},
|
|
"output": {
|
|
"shape": "TestCustomDataIdentifierResponse",
|
|
"documentation": "<p>The request succeeded.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Tests a custom data identifier.</p>"
|
|
},
|
|
"UntagResource": {
|
|
"name": "UntagResource",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"requestUri": "/tags/{resourceArn}",
|
|
"responseCode": 204
|
|
},
|
|
"input": {
|
|
"shape": "UntagResourceRequest"
|
|
},
|
|
"output": {
|
|
"shape": "UntagResourceResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [],
|
|
"documentation": "<p>Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.</p>"
|
|
},
|
|
"UpdateClassificationJob": {
|
|
"name": "UpdateClassificationJob",
|
|
"http": {
|
|
"method": "PATCH",
|
|
"requestUri": "/jobs/{jobId}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "UpdateClassificationJobRequest"
|
|
},
|
|
"output": {
|
|
"shape": "UpdateClassificationJobResponse",
|
|
"documentation": "<p>The request succeeded. The job's status was changed and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Changes the status of a classification job.</p>"
|
|
},
|
|
"UpdateFindingsFilter": {
|
|
"name": "UpdateFindingsFilter",
|
|
"http": {
|
|
"method": "PATCH",
|
|
"requestUri": "/findingsfilters/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "UpdateFindingsFilterRequest"
|
|
},
|
|
"output": {
|
|
"shape": "UpdateFindingsFilterResponse",
|
|
"documentation": "<p>The request succeeded. The specified findings filter was updated.</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Updates the criteria and other settings for a findings filter.</p>"
|
|
},
|
|
"UpdateMacieSession": {
|
|
"name": "UpdateMacieSession",
|
|
"http": {
|
|
"method": "PATCH",
|
|
"requestUri": "/macie",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "UpdateMacieSessionRequest"
|
|
},
|
|
"output": {
|
|
"shape": "UpdateMacieSessionResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Suspends or re-enables an Amazon Macie account, or updates the configuration settings for a Macie account.</p>"
|
|
},
|
|
"UpdateMemberSession": {
|
|
"name": "UpdateMemberSession",
|
|
"http": {
|
|
"method": "PATCH",
|
|
"requestUri": "/macie/members/{id}",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "UpdateMemberSessionRequest"
|
|
},
|
|
"output": {
|
|
"shape": "UpdateMemberSessionResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Enables an Amazon Macie administrator to suspend or re-enable a member account.</p>"
|
|
},
|
|
"UpdateOrganizationConfiguration": {
|
|
"name": "UpdateOrganizationConfiguration",
|
|
"http": {
|
|
"method": "PATCH",
|
|
"requestUri": "/admin/configuration",
|
|
"responseCode": 200
|
|
},
|
|
"input": {
|
|
"shape": "UpdateOrganizationConfigurationRequest"
|
|
},
|
|
"output": {
|
|
"shape": "UpdateOrganizationConfigurationResponse",
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape": "ValidationException",
|
|
"documentation": "<p>The request failed because it contains a syntax error.</p>"
|
|
},
|
|
{
|
|
"shape": "InternalServerException",
|
|
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
|
|
},
|
|
{
|
|
"shape": "ServiceQuotaExceededException",
|
|
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
|
|
},
|
|
{
|
|
"shape": "AccessDeniedException",
|
|
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
|
|
},
|
|
{
|
|
"shape": "ResourceNotFoundException",
|
|
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
|
|
},
|
|
{
|
|
"shape": "ThrottlingException",
|
|
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
|
|
},
|
|
{
|
|
"shape": "ConflictException",
|
|
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
|
|
}
|
|
],
|
|
"documentation": "<p>Updates the Amazon Macie configuration settings for an AWS organization.</p>"
|
|
}
|
|
},
|
|
"shapes": {
|
|
"AcceptInvitationRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"administratorAccountId": {
|
|
"shape": "__string",
|
|
"locationName": "administratorAccountId",
|
|
"documentation": "<p>The AWS account ID for the account that sent the invitation.</p>"
|
|
},
|
|
"invitationId": {
|
|
"shape": "__string",
|
|
"locationName": "invitationId",
|
|
"documentation": "<p>The unique identifier for the invitation to accept.</p>"
|
|
},
|
|
"masterAccount": {
|
|
"shape": "__string",
|
|
"locationName": "masterAccount",
|
|
"documentation": "<p>(Deprecated) The AWS account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"invitationId"
|
|
]
|
|
},
|
|
"AcceptInvitationResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"AccessControlList": {
|
|
"type": "structure",
|
|
"members": {
|
|
"allowsPublicReadAccess": {
|
|
"shape": "__boolean",
|
|
"locationName": "allowsPublicReadAccess",
|
|
"documentation": "<p>Specifies whether the ACL grants the general public with read access permissions for the bucket.</p>"
|
|
},
|
|
"allowsPublicWriteAccess": {
|
|
"shape": "__boolean",
|
|
"locationName": "allowsPublicWriteAccess",
|
|
"documentation": "<p>Specifies whether the ACL grants the general public with write access permissions for the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.</p>"
|
|
},
|
|
"AccessDeniedException": {
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape": "__string",
|
|
"locationName": "message",
|
|
"documentation": "<p>The explanation of the error that occurred.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an error that occurred due to insufficient access to a specified resource.</p>",
|
|
"exception": true,
|
|
"error": {
|
|
"httpStatusCode": 403
|
|
}
|
|
},
|
|
"AccountDetail": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The AWS account ID for the account.</p>"
|
|
},
|
|
"email": {
|
|
"shape": "__string",
|
|
"locationName": "email",
|
|
"documentation": "<p>The email address for the account.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies details for an account to associate with an Amazon Macie administrator account.</p>",
|
|
"required": [
|
|
"email",
|
|
"accountId"
|
|
]
|
|
},
|
|
"AccountLevelPermissions": {
|
|
"type": "structure",
|
|
"members": {
|
|
"blockPublicAccess": {
|
|
"shape": "BlockPublicAccess",
|
|
"locationName": "blockPublicAccess",
|
|
"documentation": "<p>The block public access settings for the AWS account that owns the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the account-level permissions settings that apply to an S3 bucket.</p>"
|
|
},
|
|
"AdminAccount": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The AWS account ID for the account.</p>"
|
|
},
|
|
"status": {
|
|
"shape": "AdminStatus",
|
|
"locationName": "status",
|
|
"documentation": "<p>The current status of the account as the delegated administrator of Amazon Macie for the organization.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the delegated Amazon Macie administrator account for an AWS organization.</p>"
|
|
},
|
|
"AdminStatus": {
|
|
"type": "string",
|
|
"documentation": "<p>The current status of an account as the delegated Amazon Macie administrator account for an AWS organization. Possible values are:</p>",
|
|
"enum": [
|
|
"ENABLED",
|
|
"DISABLING_IN_PROGRESS"
|
|
]
|
|
},
|
|
"ApiCallDetails": {
|
|
"type": "structure",
|
|
"members": {
|
|
"api": {
|
|
"shape": "__string",
|
|
"locationName": "api",
|
|
"documentation": "<p>The name of the operation that was invoked most recently and produced the finding.</p>"
|
|
},
|
|
"apiServiceName": {
|
|
"shape": "__string",
|
|
"locationName": "apiServiceName",
|
|
"documentation": "<p>The URL of the AWS service that provides the operation, for example: s3.amazonaws.com.</p>"
|
|
},
|
|
"firstSeen": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "firstSeen",
|
|
"documentation": "<p>The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.</p>"
|
|
},
|
|
"lastSeen": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "lastSeen",
|
|
"documentation": "<p>The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an API operation that an entity invoked for an affected resource.</p>"
|
|
},
|
|
"AssumedRole": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accessKeyId": {
|
|
"shape": "__string",
|
|
"locationName": "accessKeyId",
|
|
"documentation": "<p>The AWS access key ID that identifies the credentials.</p>"
|
|
},
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account that owns the entity that was used to get the credentials.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the entity that was used to get the credentials.</p>"
|
|
},
|
|
"principalId": {
|
|
"shape": "__string",
|
|
"locationName": "principalId",
|
|
"documentation": "<p>The unique identifier for the entity that was used to get the credentials.</p>"
|
|
},
|
|
"sessionContext": {
|
|
"shape": "SessionContext",
|
|
"locationName": "sessionContext",
|
|
"documentation": "<p>The details of the session that was created for the credentials, including the entity that issued the session.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API.</p>"
|
|
},
|
|
"AwsAccount": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account.</p>"
|
|
},
|
|
"principalId": {
|
|
"shape": "__string",
|
|
"locationName": "principalId",
|
|
"documentation": "<p>The unique identifier for the entity that performed the action.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for an AWS account other than your own account.</p>"
|
|
},
|
|
"AwsService": {
|
|
"type": "structure",
|
|
"members": {
|
|
"invokedBy": {
|
|
"shape": "__string",
|
|
"locationName": "invokedBy",
|
|
"documentation": "<p>The name of the AWS service that performed the action.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an AWS service that performed an action on an affected resource.</p>"
|
|
},
|
|
"BatchGetCustomDataIdentifierSummary": {
|
|
"type": "structure",
|
|
"members": {
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the custom data identifier.</p>"
|
|
},
|
|
"createdAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "createdAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>"
|
|
},
|
|
"deleted": {
|
|
"shape": "__boolean",
|
|
"locationName": "deleted",
|
|
"documentation": "<p>Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.</p>"
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>The custom description of the custom data identifier.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the custom data identifier.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The custom name of the custom data identifier.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about a custom data identifier.</p>"
|
|
},
|
|
"BatchGetCustomDataIdentifiersRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"ids": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "ids",
|
|
"documentation": "<p>An array of strings that lists the unique identifiers for the custom data identifiers to retrieve information about.</p>"
|
|
}
|
|
}
|
|
},
|
|
"BatchGetCustomDataIdentifiersResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"customDataIdentifiers": {
|
|
"shape": "__listOfBatchGetCustomDataIdentifierSummary",
|
|
"locationName": "customDataIdentifiers",
|
|
"documentation": "<p>An array of objects, one for each custom data identifier that meets the criteria specified in the request.</p>"
|
|
},
|
|
"notFoundIdentifierIds": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "notFoundIdentifierIds",
|
|
"documentation": "<p>An array of identifiers, one for each identifier that was specified in the request, but doesn't correlate to an existing custom data identifier.</p>"
|
|
}
|
|
}
|
|
},
|
|
"BlockPublicAccess": {
|
|
"type": "structure",
|
|
"members": {
|
|
"blockPublicAcls": {
|
|
"shape": "__boolean",
|
|
"locationName": "blockPublicAcls",
|
|
"documentation": "<p>Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.</p>"
|
|
},
|
|
"blockPublicPolicy": {
|
|
"shape": "__boolean",
|
|
"locationName": "blockPublicPolicy",
|
|
"documentation": "<p>Specifies whether Amazon S3 blocks public bucket policies for the bucket.</p>"
|
|
},
|
|
"ignorePublicAcls": {
|
|
"shape": "__boolean",
|
|
"locationName": "ignorePublicAcls",
|
|
"documentation": "<p>Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.</p>"
|
|
},
|
|
"restrictPublicBuckets": {
|
|
"shape": "__boolean",
|
|
"locationName": "restrictPublicBuckets",
|
|
"documentation": "<p>Specifies whether Amazon S3 restricts public bucket policies for the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account level or bucket level. For detailed information about each setting, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html\">Blocking public access to your Amazon S3 storage</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
|
|
},
|
|
"BucketCountByEffectivePermission": {
|
|
"type": "structure",
|
|
"members": {
|
|
"publiclyAccessible": {
|
|
"shape": "__long",
|
|
"locationName": "publiclyAccessible",
|
|
"documentation": "<p>The total number of buckets that allow the general public to have read or write access to the bucket.</p>"
|
|
},
|
|
"publiclyReadable": {
|
|
"shape": "__long",
|
|
"locationName": "publiclyReadable",
|
|
"documentation": "<p>The total number of buckets that allow the general public to have read access to the bucket.</p>"
|
|
},
|
|
"publiclyWritable": {
|
|
"shape": "__long",
|
|
"locationName": "publiclyWritable",
|
|
"documentation": "<p>The total number of buckets that allow the general public to have write access to the bucket.</p>"
|
|
},
|
|
"unknown": {
|
|
"shape": "__long",
|
|
"locationName": "unknown",
|
|
"documentation": "<p>The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the number of S3 buckets that are publicly accessible based on a combination of permissions settings for each bucket.</p>"
|
|
},
|
|
"BucketCountByEncryptionType": {
|
|
"type": "structure",
|
|
"members": {
|
|
"kmsManaged": {
|
|
"shape": "__long",
|
|
"locationName": "kmsManaged",
|
|
"documentation": " <p>The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt new objects by default. These buckets use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p>"
|
|
},
|
|
"s3Managed": {
|
|
"shape": "__long",
|
|
"locationName": "s3Managed",
|
|
"documentation": "<p>The total number of buckets that use an Amazon S3 managed key to encrypt new objects by default. These buckets use Amazon S3 managed encryption (SSE-S3).</p>"
|
|
},
|
|
"unencrypted": {
|
|
"shape": "__long",
|
|
"locationName": "unencrypted",
|
|
"documentation": "<p>The total number of buckets that don't encrypt new objects by default. Default encryption is disabled for these buckets.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the number of S3 buckets that use certain types of server-side encryption by default or don't encrypt new objects by default.</p>"
|
|
},
|
|
"BucketCountBySharedAccessType": {
|
|
"type": "structure",
|
|
"members": {
|
|
"external": {
|
|
"shape": "__long",
|
|
"locationName": "external",
|
|
"documentation": "<p>The total number of buckets that are shared with an AWS account that isn't part of the same Amazon Macie organization.</p>"
|
|
},
|
|
"internal": {
|
|
"shape": "__long",
|
|
"locationName": "internal",
|
|
"documentation": "<p>The total number of buckets that are shared with an AWS account that's part of the same Amazon Macie organization.</p>"
|
|
},
|
|
"notShared": {
|
|
"shape": "__long",
|
|
"locationName": "notShared",
|
|
"documentation": "<p>The total number of buckets that aren't shared with other AWS accounts.</p>"
|
|
},
|
|
"unknown": {
|
|
"shape": "__long",
|
|
"locationName": "unknown",
|
|
"documentation": "<p>The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other AWS accounts.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the number of S3 buckets that are shared with other AWS accounts.</p>"
|
|
},
|
|
"BucketCriteria": {
|
|
"type": "map",
|
|
"documentation": "<p>Specifies, as a map, one or more property-based conditions that filter the results of a query for information about S3 buckets.</p>",
|
|
"key": {
|
|
"shape": "__string"
|
|
},
|
|
"value": {
|
|
"shape": "BucketCriteriaAdditionalProperties"
|
|
}
|
|
},
|
|
"BucketCriteriaAdditionalProperties": {
|
|
"type": "structure",
|
|
"members": {
|
|
"eq": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "eq",
|
|
"documentation": "<p>The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.</p>"
|
|
},
|
|
"gt": {
|
|
"shape": "__long",
|
|
"locationName": "gt",
|
|
"documentation": "<p>The value for the property is greater than the specified value.</p>"
|
|
},
|
|
"gte": {
|
|
"shape": "__long",
|
|
"locationName": "gte",
|
|
"documentation": "<p>The value for the property is greater than or equal to the specified value.</p>"
|
|
},
|
|
"lt": {
|
|
"shape": "__long",
|
|
"locationName": "lt",
|
|
"documentation": "<p>The value for the property is less than the specified value.</p>"
|
|
},
|
|
"lte": {
|
|
"shape": "__long",
|
|
"locationName": "lte",
|
|
"documentation": "<p>The value for the property is less than or equal to the specified value.</p>"
|
|
},
|
|
"neq": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "neq",
|
|
"documentation": "<p>The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.</p>"
|
|
},
|
|
"prefix": {
|
|
"shape": "__string",
|
|
"locationName": "prefix",
|
|
"documentation": "<p>The name of the bucket begins with the specified value.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.</p>"
|
|
},
|
|
"BucketLevelPermissions": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accessControlList": {
|
|
"shape": "AccessControlList",
|
|
"locationName": "accessControlList",
|
|
"documentation": "<p>The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn't been defined for the bucket.</p>"
|
|
},
|
|
"blockPublicAccess": {
|
|
"shape": "BlockPublicAccess",
|
|
"locationName": "blockPublicAccess",
|
|
"documentation": "<p>The block public access settings for the bucket.</p>"
|
|
},
|
|
"bucketPolicy": {
|
|
"shape": "BucketPolicy",
|
|
"locationName": "bucketPolicy",
|
|
"documentation": "<p>The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the bucket-level permissions settings for an S3 bucket.</p>"
|
|
},
|
|
"BucketMetadata": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account that owns the bucket.</p>"
|
|
},
|
|
"bucketArn": {
|
|
"shape": "__string",
|
|
"locationName": "bucketArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the bucket.</p>"
|
|
},
|
|
"bucketCreatedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "bucketCreatedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the bucket was created.</p>"
|
|
},
|
|
"bucketName": {
|
|
"shape": "__string",
|
|
"locationName": "bucketName",
|
|
"documentation": "<p>The name of the bucket.</p>"
|
|
},
|
|
"classifiableObjectCount": {
|
|
"shape": "__long",
|
|
"locationName": "classifiableObjectCount",
|
|
"documentation": "<p>The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>"
|
|
},
|
|
"classifiableSizeInBytes": {
|
|
"shape": "__long",
|
|
"locationName": "classifiableSizeInBytes",
|
|
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.</p>"
|
|
},
|
|
"jobDetails": {
|
|
"shape": "JobDetails",
|
|
"locationName": "jobDetails",
|
|
"documentation": "<p>Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.</p>"
|
|
},
|
|
"lastUpdated": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "lastUpdated",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.</p>"
|
|
},
|
|
"objectCount": {
|
|
"shape": "__long",
|
|
"locationName": "objectCount",
|
|
"documentation": "<p>The total number of objects in the bucket.</p>"
|
|
},
|
|
"objectCountByEncryptionType": {
|
|
"shape": "ObjectCountByEncryptionType",
|
|
"locationName": "objectCountByEncryptionType",
|
|
"documentation": "<p>The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.</p>"
|
|
},
|
|
"publicAccess": {
|
|
"shape": "BucketPublicAccess",
|
|
"locationName": "publicAccess",
|
|
"documentation": "<p>Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.</p>"
|
|
},
|
|
"region": {
|
|
"shape": "__string",
|
|
"locationName": "region",
|
|
"documentation": "<p>The AWS Region that hosts the bucket.</p>"
|
|
},
|
|
"replicationDetails": {
|
|
"shape": "ReplicationDetails",
|
|
"locationName": "replicationDetails",
|
|
"documentation": "<p>Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.</p>"
|
|
},
|
|
"serverSideEncryption": {
|
|
"shape": "BucketServerSideEncryption",
|
|
"locationName": "serverSideEncryption",
|
|
"documentation": "<p>Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.</p>"
|
|
},
|
|
"sharedAccess": {
|
|
"shape": "SharedAccess",
|
|
"locationName": "sharedAccess",
|
|
"documentation": " <p>Specifies whether the bucket is shared with another AWS account. Possible values are:</p> <ul><li><p>EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.</p></li> <li><p>INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.</p></li> <li><p>NOT_SHARED - The bucket isn't shared with other AWS accounts.</p></li> <li><p>UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.</p></li></ul>"
|
|
},
|
|
"sizeInBytes": {
|
|
"shape": "__long",
|
|
"locationName": "sizeInBytes",
|
|
"documentation": "<p>The total storage size, in bytes, of the bucket.</p> <p>If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.</p>"
|
|
},
|
|
"sizeInBytesCompressed": {
|
|
"shape": "__long",
|
|
"locationName": "sizeInBytesCompressed",
|
|
"documentation": "<p>The total compressed storage size, in bytes, of the bucket.</p> <p>If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "__listOfKeyValuePair",
|
|
"locationName": "tags",
|
|
"documentation": "<p>An array that specifies the tags (keys and values) that are associated with the bucket.</p>"
|
|
},
|
|
"unclassifiableObjectCount": {
|
|
"shape": "ObjectLevelStatistics",
|
|
"locationName": "unclassifiableObjectCount",
|
|
"documentation": "<p>The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>"
|
|
},
|
|
"unclassifiableObjectSizeInBytes": {
|
|
"shape": "ObjectLevelStatistics",
|
|
"locationName": "unclassifiableObjectSizeInBytes",
|
|
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>"
|
|
},
|
|
"versioning": {
|
|
"shape": "__boolean",
|
|
"locationName": "versioning",
|
|
"documentation": "<p>Specifies whether versioning is enabled for the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an S3 bucket that Amazon Macie monitors and analyzes.</p>"
|
|
},
|
|
"BucketPermissionConfiguration": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountLevelPermissions": {
|
|
"shape": "AccountLevelPermissions",
|
|
"locationName": "accountLevelPermissions",
|
|
"documentation": "<p>The account-level permissions settings that apply to the bucket.</p>"
|
|
},
|
|
"bucketLevelPermissions": {
|
|
"shape": "BucketLevelPermissions",
|
|
"locationName": "bucketLevelPermissions",
|
|
"documentation": "<p>The bucket-level permissions settings for the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the account-level and bucket-level permissions settings for an S3 bucket.</p>"
|
|
},
|
|
"BucketPolicy": {
|
|
"type": "structure",
|
|
"members": {
|
|
"allowsPublicReadAccess": {
|
|
"shape": "__boolean",
|
|
"locationName": "allowsPublicReadAccess",
|
|
"documentation": "<p>Specifies whether the bucket policy allows the general public to have read access to the bucket.</p>"
|
|
},
|
|
"allowsPublicWriteAccess": {
|
|
"shape": "__boolean",
|
|
"locationName": "allowsPublicWriteAccess",
|
|
"documentation": "<p>Specifies whether the bucket policy allows the general public to have write access to the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the permissions settings of a bucket policy for an S3 bucket.</p>"
|
|
},
|
|
"BucketPublicAccess": {
|
|
"type": "structure",
|
|
"members": {
|
|
"effectivePermission": {
|
|
"shape": "EffectivePermission",
|
|
"locationName": "effectivePermission",
|
|
"documentation": " <p>Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:</p> <ul><li><p>NOT_PUBLIC - The bucket isn't publicly accessible.</p></li> <li><p>PUBLIC - The bucket is publicly accessible.</p></li> <li><p>UNKNOWN - Amazon Macie can't determine whether the bucket is publicly accessible.</p></li></ul>"
|
|
},
|
|
"permissionConfiguration": {
|
|
"shape": "BucketPermissionConfiguration",
|
|
"locationName": "permissionConfiguration",
|
|
"documentation": "<p>The account-level and bucket-level permissions for the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.</p>"
|
|
},
|
|
"BucketServerSideEncryption": {
|
|
"type": "structure",
|
|
"members": {
|
|
"kmsMasterKeyId": {
|
|
"shape": "__string",
|
|
"locationName": "kmsMasterKeyId",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used by default to encrypt objects that are added to the bucket. This value is null if the bucket uses an Amazon S3 managed key to encrypt new objects or the bucket doesn't encrypt new objects by default.</p>"
|
|
},
|
|
"type": {
|
|
"shape": "Type",
|
|
"locationName": "type",
|
|
"documentation": "<p>The type of server-side encryption that's used by default when storing new objects in the bucket. Possible values are:</p> <ul><li><p>AES256 - New objects are encrypted with an Amazon S3 managed key and use Amazon S3 managed encryption (SSE-S3).</p></li> <li><p>aws:kms - New objects are encrypted with an AWS KMS CMK, specified by the kmsMasterKeyId property, and use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p></li> <li><p>NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.</p></li></ul>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the default server-side encryption settings for an S3 bucket. For detailed information about these settings, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html\">Setting default server-side encryption behavior for Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
|
|
},
|
|
"BucketSortCriteria": {
|
|
"type": "structure",
|
|
"members": {
|
|
"attributeName": {
|
|
"shape": "__string",
|
|
"locationName": "attributeName",
|
|
"documentation": "<p>The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, or sizeInBytes.</p>"
|
|
},
|
|
"orderBy": {
|
|
"shape": "OrderBy",
|
|
"locationName": "orderBy",
|
|
"documentation": "<p>The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies criteria for sorting the results of a query for information about S3 buckets.</p>"
|
|
},
|
|
"Cell": {
|
|
"type": "structure",
|
|
"members": {
|
|
"cellReference": {
|
|
"shape": "__string",
|
|
"locationName": "cellReference",
|
|
"documentation": "<p>The location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.</p>"
|
|
},
|
|
"column": {
|
|
"shape": "__long",
|
|
"locationName": "column",
|
|
"documentation": "<p>The column number of the column that contains the data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier. For example, 1 for column A, 2 for column B, and so on.</p>"
|
|
},
|
|
"columnName": {
|
|
"shape": "__string",
|
|
"locationName": "columnName",
|
|
"documentation": "<p>The name of the column that contains the data, if available. This value is also null if Amazon Macie detects sensitive data in the name of any column in the file.</p>"
|
|
},
|
|
"row": {
|
|
"shape": "__long",
|
|
"locationName": "row",
|
|
"documentation": "<p>The row number of the row that contains the data.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.</p>"
|
|
},
|
|
"Cells": {
|
|
"type": "list",
|
|
"documentation": "<p>Specifies the location of occurrences of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.</p>",
|
|
"member": {
|
|
"shape": "Cell"
|
|
}
|
|
},
|
|
"ClassificationDetails": {
|
|
"type": "structure",
|
|
"members": {
|
|
"detailedResultsLocation": {
|
|
"shape": "__string",
|
|
"locationName": "detailedResultsLocation",
|
|
"documentation": "<p>The path to the folder or file (in Amazon S3) that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.</p>"
|
|
},
|
|
"jobArn": {
|
|
"shape": "__string",
|
|
"locationName": "jobArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the classification job that produced the finding.</p>"
|
|
},
|
|
"jobId": {
|
|
"shape": "__string",
|
|
"locationName": "jobId",
|
|
"documentation": "<p>The unique identifier for the classification job that produced the finding.</p>"
|
|
},
|
|
"result": {
|
|
"shape": "ClassificationResult",
|
|
"locationName": "result",
|
|
"documentation": "<p>The status and other details for the finding.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about a sensitive data finding, including the classification job that produced the finding.</p>"
|
|
},
|
|
"ClassificationExportConfiguration": {
|
|
"type": "structure",
|
|
"members": {
|
|
"s3Destination": {
|
|
"shape": "S3Destination",
|
|
"locationName": "s3Destination",
|
|
"documentation": "<p>The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.</p>"
|
|
},
|
|
"ClassificationResult": {
|
|
"type": "structure",
|
|
"members": {
|
|
"additionalOccurrences": {
|
|
"shape": "__boolean",
|
|
"locationName": "additionalOccurrences",
|
|
"documentation": "<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": {
|
|
"shape": "CustomDataIdentifiers",
|
|
"locationName": "customDataIdentifiers",
|
|
"documentation": "<p>The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.</p>"
|
|
},
|
|
"mimeType": {
|
|
"shape": "__string",
|
|
"locationName": "mimeType",
|
|
"documentation": "<p>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.</p>"
|
|
},
|
|
"sensitiveData": {
|
|
"shape": "SensitiveData",
|
|
"locationName": "sensitiveData",
|
|
"documentation": "<p>The category, types, and number of occurrences of the sensitive data that produced the finding.</p>"
|
|
},
|
|
"sizeClassified": {
|
|
"shape": "__long",
|
|
"locationName": "sizeClassified",
|
|
"documentation": "<p>The total size, in bytes, of the data that the finding applies to.</p>"
|
|
},
|
|
"status": {
|
|
"shape": "ClassificationResultStatus",
|
|
"locationName": "status",
|
|
"documentation": "<p>The status of the finding.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.</p>"
|
|
},
|
|
"ClassificationResultStatus": {
|
|
"type": "structure",
|
|
"members": {
|
|
"code": {
|
|
"shape": "__string",
|
|
"locationName": "code",
|
|
"documentation": " <p>The status of the finding. Possible values are:</p> <ul><li><p>COMPLETE - Amazon Macie successfully completed its analysis of the object that the finding applies to.</p></li> <li><p>PARTIAL - Macie analyzed only a subset of the data in the object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.</p></li> <li><p>SKIPPED - Macie wasn't able to analyze the object that the finding applies to. For example, the object is a malformed file or a file that uses an unsupported format.</p></li></ul>"
|
|
},
|
|
"reason": {
|
|
"shape": "__string",
|
|
"locationName": "reason",
|
|
"documentation": "<p>A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the status of a sensitive data finding.</p>"
|
|
},
|
|
"ConflictException": {
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape": "__string",
|
|
"locationName": "message",
|
|
"documentation": "<p>The explanation of the error that occurred.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an error that occurred due to a versioning conflict for a specified resource.</p>",
|
|
"exception": true,
|
|
"error": {
|
|
"httpStatusCode": 409
|
|
}
|
|
},
|
|
"CreateClassificationJobRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"clientToken": {
|
|
"shape": "__string",
|
|
"locationName": "clientToken",
|
|
"documentation": "<p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>",
|
|
"idempotencyToken": true
|
|
},
|
|
"customDataIdentifierIds": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "customDataIdentifierIds",
|
|
"documentation": "<p>The custom data identifiers to use for data analysis and classification.</p>"
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>A custom description of the job. The description can contain as many as 200 characters.</p>"
|
|
},
|
|
"initialRun": {
|
|
"shape": "__boolean",
|
|
"locationName": "initialRun",
|
|
"documentation": "<p>Specifies whether to analyze all existing, eligible objects immediately after the job is created.</p>"
|
|
},
|
|
"jobType": {
|
|
"shape": "JobType",
|
|
"locationName": "jobType",
|
|
"documentation": "<p>The schedule for running the job. Valid values are:</p> <ul><li><p>ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.</p></li> <li><p>SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.</p></li></ul>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>A custom name for the job. The name can contain as many as 500 characters.</p>"
|
|
},
|
|
"s3JobDefinition": {
|
|
"shape": "S3JobDefinition",
|
|
"locationName": "s3JobDefinition",
|
|
"documentation": "<p>The S3 buckets that contain the objects to analyze, and the scope of that analysis.</p>"
|
|
},
|
|
"samplingPercentage": {
|
|
"shape": "__integer",
|
|
"locationName": "samplingPercentage",
|
|
"documentation": "<p>The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.</p>"
|
|
},
|
|
"scheduleFrequency": {
|
|
"shape": "JobScheduleFrequency",
|
|
"locationName": "scheduleFrequency",
|
|
"documentation": "<p>The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that specifies the tags to associate with the job.</p> <p>A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"s3JobDefinition",
|
|
"jobType",
|
|
"clientToken",
|
|
"name"
|
|
]
|
|
},
|
|
"CreateClassificationJobResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"jobArn": {
|
|
"shape": "__string",
|
|
"locationName": "jobArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the job.</p>"
|
|
},
|
|
"jobId": {
|
|
"shape": "__string",
|
|
"locationName": "jobId",
|
|
"documentation": "<p>The unique identifier for the job.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateCustomDataIdentifierRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"clientToken": {
|
|
"shape": "__string",
|
|
"locationName": "clientToken",
|
|
"documentation": "<p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>",
|
|
"idempotencyToken": true
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>A custom description of the custom data identifier. The description can contain as many as 512 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.</p>"
|
|
},
|
|
"ignoreWords": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "ignoreWords",
|
|
"documentation": "<p>An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.</p>"
|
|
},
|
|
"keywords": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "keywords",
|
|
"documentation": "<p>An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters. Keywords aren't case sensitive.</p>"
|
|
},
|
|
"maximumMatchDistance": {
|
|
"shape": "__integer",
|
|
"locationName": "maximumMatchDistance",
|
|
"documentation": "<p>The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>A custom name for the custom data identifier. The name can contain as many as 128 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.</p>"
|
|
},
|
|
"regex": {
|
|
"shape": "__string",
|
|
"locationName": "regex",
|
|
"documentation": "<p>The regular expression (<i>regex</i>) that defines the pattern to match. The expression can contain as many as 512 characters.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that specifies the tags to associate with the custom data identifier.</p> <p>A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateCustomDataIdentifierResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"customDataIdentifierId": {
|
|
"shape": "__string",
|
|
"locationName": "customDataIdentifierId",
|
|
"documentation": "<p>The unique identifier for the custom data identifier that was created.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateFindingsFilterRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"action": {
|
|
"shape": "FindingsFilterAction",
|
|
"locationName": "action",
|
|
"documentation": "<p>The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>"
|
|
},
|
|
"clientToken": {
|
|
"shape": "__string",
|
|
"locationName": "clientToken",
|
|
"documentation": "<p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>",
|
|
"idempotencyToken": true
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>A custom description of the filter. The description can contain as many as 512 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.</p>"
|
|
},
|
|
"findingCriteria": {
|
|
"shape": "FindingCriteria",
|
|
"locationName": "findingCriteria",
|
|
"documentation": "<p>The criteria to use to filter findings.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.</p>"
|
|
},
|
|
"position": {
|
|
"shape": "__integer",
|
|
"locationName": "position",
|
|
"documentation": "<p>The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that specifies the tags to associate with the filter.</p> <p>A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"action",
|
|
"findingCriteria",
|
|
"name"
|
|
]
|
|
},
|
|
"CreateFindingsFilterResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the filter that was created.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the filter that was created.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateInvitationsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountIds": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "accountIds",
|
|
"documentation": "<p>An array that lists AWS account IDs, one for each account to send the invitation to.</p>"
|
|
},
|
|
"disableEmailNotification": {
|
|
"shape": "__boolean",
|
|
"locationName": "disableEmailNotification",
|
|
"documentation": "<p>Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in AWS Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.</p>"
|
|
},
|
|
"message": {
|
|
"shape": "__string",
|
|
"locationName": "message",
|
|
"documentation": "<p>A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"accountIds"
|
|
]
|
|
},
|
|
"CreateInvitationsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"unprocessedAccounts": {
|
|
"shape": "__listOfUnprocessedAccount",
|
|
"locationName": "unprocessedAccounts",
|
|
"documentation": "<p>An array of objects, one for each account whose invitation hasn't been processed. Each object identifies the account and explains why the invitation hasn't been processed for the account.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateMemberRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"account": {
|
|
"shape": "AccountDetail",
|
|
"locationName": "account",
|
|
"documentation": "<p>The details for the account to associate with the administrator account.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.</p> <p>An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"account"
|
|
]
|
|
},
|
|
"CreateMemberResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the account that was associated with the administrator account.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateSampleFindingsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"findingTypes": {
|
|
"shape": "__listOfFindingType",
|
|
"locationName": "findingTypes",
|
|
"documentation": "<p>An array that lists one or more types of findings to include in the set of sample findings. Currently, the only supported value is Policy:IAMUser/S3BucketEncryptionDisabled.</p> "
|
|
}
|
|
}
|
|
},
|
|
"CreateSampleFindingsResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"Criterion": {
|
|
"type": "map",
|
|
"documentation": "<p>Specifies a condition that defines a property, operator, and one or more values to filter the results of a query for findings. The number of values depends on the property and operator specified by the condition. For information about defining filter conditions, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/findings-filter-basics.html\">Fundamentals of filtering findings</a> in the <i>Amazon Macie User Guide</i>.</p>",
|
|
"key": {
|
|
"shape": "__string"
|
|
},
|
|
"value": {
|
|
"shape": "CriterionAdditionalProperties"
|
|
}
|
|
},
|
|
"CriterionAdditionalProperties": {
|
|
"type": "structure",
|
|
"members": {
|
|
"eq": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "eq",
|
|
"documentation": "<p>The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.</p>"
|
|
},
|
|
"eqExactMatch": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "eqExactMatch",
|
|
"documentation": "<p>The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.</p> <p>You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.</p>"
|
|
},
|
|
"gt": {
|
|
"shape": "__long",
|
|
"locationName": "gt",
|
|
"documentation": "<p>The value for the property is greater than the specified value.</p>"
|
|
},
|
|
"gte": {
|
|
"shape": "__long",
|
|
"locationName": "gte",
|
|
"documentation": "<p>The value for the property is greater than or equal to the specified value.</p>"
|
|
},
|
|
"lt": {
|
|
"shape": "__long",
|
|
"locationName": "lt",
|
|
"documentation": "<p>The value for the property is less than the specified value.</p>"
|
|
},
|
|
"lte": {
|
|
"shape": "__long",
|
|
"locationName": "lte",
|
|
"documentation": "<p>The value for the property is less than or equal to the specified value.</p>"
|
|
},
|
|
"neq": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "neq",
|
|
"documentation": "<p>The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/findings-filter-basics.html\">Fundamentals of filtering findings</a> in the <i>Amazon Macie User Guide</i>.</p>"
|
|
},
|
|
"Currency": {
|
|
"type": "string",
|
|
"documentation": "<p>The type of currency that the data for an Amazon Macie usage metric is reported in. Possible values are:</p>",
|
|
"enum": [
|
|
"USD"
|
|
]
|
|
},
|
|
"CustomDataIdentifierSummary": {
|
|
"type": "structure",
|
|
"members": {
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the custom data identifier.</p>"
|
|
},
|
|
"createdAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "createdAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>"
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>The custom description of the custom data identifier.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the custom data identifier.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The custom name of the custom data identifier.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about a custom data identifier.</p>"
|
|
},
|
|
"CustomDataIdentifiers": {
|
|
"type": "structure",
|
|
"members": {
|
|
"detections": {
|
|
"shape": "CustomDetections",
|
|
"locationName": "detections",
|
|
"documentation": "<p>The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.</p>"
|
|
},
|
|
"totalCount": {
|
|
"shape": "__long",
|
|
"locationName": "totalCount",
|
|
"documentation": "<p>The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the finding.</p>"
|
|
},
|
|
"CustomDetection": {
|
|
"type": "structure",
|
|
"members": {
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the custom data identifier.</p>"
|
|
},
|
|
"count": {
|
|
"shape": "__long",
|
|
"locationName": "count",
|
|
"documentation": "<p>The total number of occurrences of the sensitive data that the custom data identifier detected.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The name of the custom data identifier.</p>"
|
|
},
|
|
"occurrences": {
|
|
"shape": "Occurrences",
|
|
"locationName": "occurrences",
|
|
"documentation": "<p>The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.</p>"
|
|
},
|
|
"CustomDetections": {
|
|
"type": "list",
|
|
"documentation": "<p>Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that each identifier detected.</p>",
|
|
"member": {
|
|
"shape": "CustomDetection"
|
|
}
|
|
},
|
|
"DailySchedule": {
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "<p>Specifies that a classification job runs once a day, every day. This is an empty object.</p>"
|
|
},
|
|
"DayOfWeek": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SUNDAY",
|
|
"MONDAY",
|
|
"TUESDAY",
|
|
"WEDNESDAY",
|
|
"THURSDAY",
|
|
"FRIDAY",
|
|
"SATURDAY"
|
|
]
|
|
},
|
|
"DeclineInvitationsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountIds": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "accountIds",
|
|
"documentation": "<p>An array that lists AWS account IDs, one for each account that sent an invitation to decline.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"accountIds"
|
|
]
|
|
},
|
|
"DeclineInvitationsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"unprocessedAccounts": {
|
|
"shape": "__listOfUnprocessedAccount",
|
|
"locationName": "unprocessedAccounts",
|
|
"documentation": "<p>An array of objects, one for each account whose invitation hasn't been declined. Each object identifies the account and explains why the request hasn't been processed for that account.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DefaultDetection": {
|
|
"type": "structure",
|
|
"members": {
|
|
"count": {
|
|
"shape": "__long",
|
|
"locationName": "count",
|
|
"documentation": "<p>The total number of occurrences of the type of sensitive data that was detected.</p>"
|
|
},
|
|
"occurrences": {
|
|
"shape": "Occurrences",
|
|
"locationName": "occurrences",
|
|
"documentation": "<p>The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.</p>"
|
|
},
|
|
"type": {
|
|
"shape": "__string",
|
|
"locationName": "type",
|
|
"documentation": "<p>The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about a type of sensitive data that was detected by managed data identifiers and produced a sensitive data finding.</p>"
|
|
},
|
|
"DefaultDetections": {
|
|
"type": "list",
|
|
"documentation": "<p>Provides information about sensitive data that was detected by managed data identifiers and produced a sensitive data finding, and the number of occurrences of each type of sensitive data that was detected.</p>",
|
|
"member": {
|
|
"shape": "DefaultDetection"
|
|
}
|
|
},
|
|
"DeleteCustomDataIdentifierRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"DeleteCustomDataIdentifierResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DeleteFindingsFilterRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"DeleteFindingsFilterResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DeleteInvitationsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountIds": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "accountIds",
|
|
"documentation": "<p>An array that lists AWS account IDs, one for each account that sent an invitation to delete.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"accountIds"
|
|
]
|
|
},
|
|
"DeleteInvitationsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"unprocessedAccounts": {
|
|
"shape": "__listOfUnprocessedAccount",
|
|
"locationName": "unprocessedAccounts",
|
|
"documentation": "<p>An array of objects, one for each account whose invitation hasn't been deleted. Each object identifies the account and explains why the request hasn't been processed for that account.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteMemberRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"DeleteMemberResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DescribeBucketsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"criteria": {
|
|
"shape": "BucketCriteria",
|
|
"locationName": "criteria",
|
|
"documentation": "<p>The criteria to use to filter the query results.</p>"
|
|
},
|
|
"maxResults": {
|
|
"shape": "__integer",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of the response. The default value is 50.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
},
|
|
"sortCriteria": {
|
|
"shape": "BucketSortCriteria",
|
|
"locationName": "sortCriteria",
|
|
"documentation": "<p>The criteria to use to sort the query results.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeBucketsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"buckets": {
|
|
"shape": "__listOfBucketMetadata",
|
|
"locationName": "buckets",
|
|
"documentation": "<p>An array of objects, one for each bucket that meets the filter criteria specified in the request.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeClassificationJobRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"jobId": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "jobId",
|
|
"documentation": "<p>The unique identifier for the classification job.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"jobId"
|
|
]
|
|
},
|
|
"DescribeClassificationJobResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"clientToken": {
|
|
"shape": "__string",
|
|
"locationName": "clientToken",
|
|
"documentation": "<p>The token that was provided to ensure the idempotency of the request to create the job.</p>",
|
|
"idempotencyToken": true
|
|
},
|
|
"createdAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "createdAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the job was created.</p>"
|
|
},
|
|
"customDataIdentifierIds": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "customDataIdentifierIds",
|
|
"documentation": "<p>The custom data identifiers that the job uses to analyze data.</p>"
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>The custom description of the job.</p>"
|
|
},
|
|
"initialRun": {
|
|
"shape": "__boolean",
|
|
"locationName": "initialRun",
|
|
"documentation": "<p>Specifies whether the job is configured to analyze all existing, eligible objects immediately after it's created.</p>"
|
|
},
|
|
"jobArn": {
|
|
"shape": "__string",
|
|
"locationName": "jobArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the job.</p>"
|
|
},
|
|
"jobId": {
|
|
"shape": "__string",
|
|
"locationName": "jobId",
|
|
"documentation": "<p>The unique identifier for the job.</p>"
|
|
},
|
|
"jobStatus": {
|
|
"shape": "JobStatus",
|
|
"locationName": "jobStatus",
|
|
"documentation": "<p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.</p></li> <li><p>COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.</p></li> <li><p>IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.</p></li> <li><p>PAUSED - Amazon Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.</p></li> <li><p>RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.</p></li> <li><p>USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>"
|
|
},
|
|
"jobType": {
|
|
"shape": "JobType",
|
|
"locationName": "jobType",
|
|
"documentation": "<p>The schedule for running the job. Possible values are:</p> <ul><li><p>ONE_TIME - The job runs only once.</p></li> <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.</p></li></ul>"
|
|
},
|
|
"lastRunErrorStatus": {
|
|
"shape": "LastRunErrorStatus",
|
|
"locationName": "lastRunErrorStatus",
|
|
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.</p>"
|
|
},
|
|
"lastRunTime": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "lastRunTime",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The custom name of the job.</p>"
|
|
},
|
|
"s3JobDefinition": {
|
|
"shape": "S3JobDefinition",
|
|
"locationName": "s3JobDefinition",
|
|
"documentation": "<p>The S3 buckets that the job is configured to analyze, and the scope of that analysis.</p>"
|
|
},
|
|
"samplingPercentage": {
|
|
"shape": "__integer",
|
|
"locationName": "samplingPercentage",
|
|
"documentation": "<p>The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.</p>"
|
|
},
|
|
"scheduleFrequency": {
|
|
"shape": "JobScheduleFrequency",
|
|
"locationName": "scheduleFrequency",
|
|
"documentation": "<p>The recurrence pattern for running the job. If the job is configured to run only once, this value is null.</p>"
|
|
},
|
|
"statistics": {
|
|
"shape": "Statistics",
|
|
"locationName": "statistics",
|
|
"documentation": "<p>The number of times that the job has run and processing statistics for the job's current run.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.</p>"
|
|
},
|
|
"userPausedDetails": {
|
|
"shape": "UserPausedDetails",
|
|
"locationName": "userPausedDetails",
|
|
"documentation": "<p>If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeOrganizationConfigurationRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DescribeOrganizationConfigurationResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"autoEnable": {
|
|
"shape": "__boolean",
|
|
"locationName": "autoEnable",
|
|
"documentation": "<p>Specifies whether Amazon Macie is enabled automatically for accounts that are added to the AWS organization.</p>"
|
|
},
|
|
"maxAccountLimitReached": {
|
|
"shape": "__boolean",
|
|
"locationName": "maxAccountLimitReached",
|
|
"documentation": "<p>Specifies whether the maximum number of Amazon Macie member accounts are part of the AWS organization.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DisableMacieRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DisableMacieResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DisableOrganizationAdminAccountRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"adminAccountId": {
|
|
"shape": "__string",
|
|
"location": "querystring",
|
|
"locationName": "adminAccountId",
|
|
"documentation": "<p>The AWS account ID of the delegated Amazon Macie administrator account.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"adminAccountId"
|
|
]
|
|
},
|
|
"DisableOrganizationAdminAccountResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DisassociateFromAdministratorAccountRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DisassociateFromAdministratorAccountResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DisassociateFromMasterAccountRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DisassociateFromMasterAccountResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DisassociateMemberRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"DisassociateMemberResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"DomainDetails": {
|
|
"type": "structure",
|
|
"members": {
|
|
"domainName": {
|
|
"shape": "__string",
|
|
"locationName": "domainName",
|
|
"documentation": "<p>The name of the domain.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the domain name of the device that an entity used to perform an action on an affected resource.</p>"
|
|
},
|
|
"EffectivePermission": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PUBLIC",
|
|
"NOT_PUBLIC",
|
|
"UNKNOWN"
|
|
]
|
|
},
|
|
"Empty": {
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
|
|
},
|
|
"EnableMacieRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"clientToken": {
|
|
"shape": "__string",
|
|
"locationName": "clientToken",
|
|
"documentation": "<p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>",
|
|
"idempotencyToken": true
|
|
},
|
|
"findingPublishingFrequency": {
|
|
"shape": "FindingPublishingFrequency",
|
|
"locationName": "findingPublishingFrequency",
|
|
"documentation": "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events)."
|
|
},
|
|
"status": {
|
|
"shape": "MacieStatus",
|
|
"locationName": "status",
|
|
"documentation": "<p>Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.</p>"
|
|
}
|
|
}
|
|
},
|
|
"EnableMacieResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"EnableOrganizationAdminAccountRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"adminAccountId": {
|
|
"shape": "__string",
|
|
"locationName": "adminAccountId",
|
|
"documentation": "<p>The AWS account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.</p>"
|
|
},
|
|
"clientToken": {
|
|
"shape": "__string",
|
|
"locationName": "clientToken",
|
|
"documentation": "<p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>",
|
|
"idempotencyToken": true
|
|
}
|
|
},
|
|
"required": [
|
|
"adminAccountId"
|
|
]
|
|
},
|
|
"EnableOrganizationAdminAccountResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"EncryptionType": {
|
|
"type": "string",
|
|
"documentation": "<p>The type of server-side encryption that's used to encrypt an S3 object or objects in an S3 bucket. Valid values are:</p>",
|
|
"enum": [
|
|
"NONE",
|
|
"AES256",
|
|
"aws:kms",
|
|
"UNKNOWN"
|
|
]
|
|
},
|
|
"ErrorCode": {
|
|
"type": "string",
|
|
"documentation": "<p>The source of an issue or delay. Possible values are:</p>",
|
|
"enum": [
|
|
"ClientError",
|
|
"InternalError"
|
|
]
|
|
},
|
|
"FederatedUser": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accessKeyId": {
|
|
"shape": "__string",
|
|
"locationName": "accessKeyId",
|
|
"documentation": "<p>The AWS access key ID that identifies the credentials.</p>"
|
|
},
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account that owns the entity that was used to get the credentials.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the entity that was used to get the credentials.</p>"
|
|
},
|
|
"principalId": {
|
|
"shape": "__string",
|
|
"locationName": "principalId",
|
|
"documentation": "<p>The unique identifier for the entity that was used to get the credentials.</p>"
|
|
},
|
|
"sessionContext": {
|
|
"shape": "SessionContext",
|
|
"locationName": "sessionContext",
|
|
"documentation": "<p>The details of the session that was created for the credentials, including the entity that issued the session.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>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 AWS Security Token Service (AWS STS) API.</p>"
|
|
},
|
|
"Finding": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account that the finding applies to. This is typically the account that owns the affected resource.</p>"
|
|
},
|
|
"archived": {
|
|
"shape": "__boolean",
|
|
"locationName": "archived",
|
|
"documentation": "<p>Specifies whether the finding is archived.</p>"
|
|
},
|
|
"category": {
|
|
"shape": "FindingCategory",
|
|
"locationName": "category",
|
|
"documentation": "<p>The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.</p>"
|
|
},
|
|
"classificationDetails": {
|
|
"shape": "ClassificationDetails",
|
|
"locationName": "classificationDetails",
|
|
"documentation": "<p>The details of a sensitive data finding. This value is null for a policy finding.</p>"
|
|
},
|
|
"count": {
|
|
"shape": "__long",
|
|
"locationName": "count",
|
|
"documentation": "<p>The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.</p>"
|
|
},
|
|
"createdAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "createdAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the finding was created.</p>"
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>The description of the finding.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.</p>"
|
|
},
|
|
"partition": {
|
|
"shape": "__string",
|
|
"locationName": "partition",
|
|
"documentation": "<p>The AWS partition that Amazon Macie created the finding in.</p>"
|
|
},
|
|
"policyDetails": {
|
|
"shape": "PolicyDetails",
|
|
"locationName": "policyDetails",
|
|
"documentation": "<p>The details of a policy finding. This value is null for a sensitive data finding.</p>"
|
|
},
|
|
"region": {
|
|
"shape": "__string",
|
|
"locationName": "region",
|
|
"documentation": "<p>The AWS Region that Amazon Macie created the finding in.</p>"
|
|
},
|
|
"resourcesAffected": {
|
|
"shape": "ResourcesAffected",
|
|
"locationName": "resourcesAffected",
|
|
"documentation": "<p>The resources that the finding applies to.</p>"
|
|
},
|
|
"sample": {
|
|
"shape": "__boolean",
|
|
"locationName": "sample",
|
|
"documentation": "<p>Specifies whether the finding is a sample finding. A <i>sample finding</i> is a finding that uses example data to demonstrate what a finding might contain.</p>"
|
|
},
|
|
"schemaVersion": {
|
|
"shape": "__string",
|
|
"locationName": "schemaVersion",
|
|
"documentation": "<p>The version of the schema that was used to define the data structures in the finding.</p>"
|
|
},
|
|
"severity": {
|
|
"shape": "Severity",
|
|
"locationName": "severity",
|
|
"documentation": "<p>The severity level and score for the finding.</p>"
|
|
},
|
|
"title": {
|
|
"shape": "__string",
|
|
"locationName": "title",
|
|
"documentation": "<p>The brief description of the finding.</p>"
|
|
},
|
|
"type": {
|
|
"shape": "FindingType",
|
|
"locationName": "type",
|
|
"documentation": "<p>The type of the finding.</p>"
|
|
},
|
|
"updatedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "updatedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides the details of a finding.</p>"
|
|
},
|
|
"FindingAction": {
|
|
"type": "structure",
|
|
"members": {
|
|
"actionType": {
|
|
"shape": "FindingActionType",
|
|
"locationName": "actionType",
|
|
"documentation": "<p>The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.</p>"
|
|
},
|
|
"apiCallDetails": {
|
|
"shape": "ApiCallDetails",
|
|
"locationName": "apiCallDetails",
|
|
"documentation": "<p>The invocation details of the API operation that an entity invoked for the affected resource, if the value for the actionType property is AWS_API_CALL.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an action that occurred for a resource and produced a policy finding.</p>"
|
|
},
|
|
"FindingActionType": {
|
|
"type": "string",
|
|
"documentation": "<p>The type of action that occurred for the resource and produced the policy finding:</p>",
|
|
"enum": [
|
|
"AWS_API_CALL"
|
|
]
|
|
},
|
|
"FindingActor": {
|
|
"type": "structure",
|
|
"members": {
|
|
"domainDetails": {
|
|
"shape": "DomainDetails",
|
|
"locationName": "domainDetails",
|
|
"documentation": "<p>The domain name of the device that the entity used to perform the action on the affected resource.</p>"
|
|
},
|
|
"ipAddressDetails": {
|
|
"shape": "IpAddressDetails",
|
|
"locationName": "ipAddressDetails",
|
|
"documentation": "<p>The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.</p>"
|
|
},
|
|
"userIdentity": {
|
|
"shape": "UserIdentity",
|
|
"locationName": "userIdentity",
|
|
"documentation": "<p>The type and other characteristics of the entity that performed the action on the affected resource.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an entity that performed an action that produced a policy finding for a resource.</p>"
|
|
},
|
|
"FindingCategory": {
|
|
"type": "string",
|
|
"documentation": "<p>The category of the finding. Valid values are:</p>",
|
|
"enum": [
|
|
"CLASSIFICATION",
|
|
"POLICY"
|
|
]
|
|
},
|
|
"FindingCriteria": {
|
|
"type": "structure",
|
|
"members": {
|
|
"criterion": {
|
|
"shape": "Criterion",
|
|
"locationName": "criterion",
|
|
"documentation": "<p>A condition that specifies the property, operator, and one or more values to use to filter the results.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.</p>"
|
|
},
|
|
"FindingPublishingFrequency": {
|
|
"type": "string",
|
|
"documentation": "<p>The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). For more information, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/findings-monitor.html\">Monitoring and processing findings</a> in the <i>Amazon Macie User Guide</i>. Valid values are:</p>",
|
|
"enum": [
|
|
"FIFTEEN_MINUTES",
|
|
"ONE_HOUR",
|
|
"SIX_HOURS"
|
|
]
|
|
},
|
|
"FindingStatisticsSortAttributeName": {
|
|
"type": "string",
|
|
"documentation": "<p>The grouping to sort the results by. Valid values are:</p>",
|
|
"enum": [
|
|
"groupKey",
|
|
"count"
|
|
]
|
|
},
|
|
"FindingStatisticsSortCriteria": {
|
|
"type": "structure",
|
|
"members": {
|
|
"attributeName": {
|
|
"shape": "FindingStatisticsSortAttributeName",
|
|
"locationName": "attributeName",
|
|
"documentation": "<p>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.</p>"
|
|
},
|
|
"orderBy": {
|
|
"shape": "OrderBy",
|
|
"locationName": "orderBy",
|
|
"documentation": "<p>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.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.</p>"
|
|
},
|
|
"FindingType": {
|
|
"type": "string",
|
|
"documentation": "<p>The type of finding. For details about each type, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/findings-types.html\">Types of Amazon Macie findings</a> in the <i>Amazon Macie User Guide</i>. Valid values are:</p>",
|
|
"enum": [
|
|
"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"
|
|
]
|
|
},
|
|
"FindingsFilterAction": {
|
|
"type": "string",
|
|
"documentation": "<p>The action to perform on findings that meet the filter criteria. To suppress (automatically archive) findings that meet the criteria, set this value to ARCHIVE. Valid values are:</p>",
|
|
"enum": [
|
|
"ARCHIVE",
|
|
"NOOP"
|
|
]
|
|
},
|
|
"FindingsFilterListItem": {
|
|
"type": "structure",
|
|
"members": {
|
|
"action": {
|
|
"shape": "FindingsFilterAction",
|
|
"locationName": "action",
|
|
"documentation": "<p>The action that's performed on findings that meet the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the filter.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the filter.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The custom name of the filter.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about a findings filter.</p>"
|
|
},
|
|
"GetAdministratorAccountRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"GetAdministratorAccountResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"administrator": {
|
|
"shape": "Invitation",
|
|
"locationName": "administrator",
|
|
"documentation": "<p>The AWS account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetBucketStatisticsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetBucketStatisticsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"bucketCount": {
|
|
"shape": "__long",
|
|
"locationName": "bucketCount",
|
|
"documentation": "<p>The total number of buckets.</p>"
|
|
},
|
|
"bucketCountByEffectivePermission": {
|
|
"shape": "BucketCountByEffectivePermission",
|
|
"locationName": "bucketCountByEffectivePermission",
|
|
"documentation": "<p>The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.</p>"
|
|
},
|
|
"bucketCountByEncryptionType": {
|
|
"shape": "BucketCountByEncryptionType",
|
|
"locationName": "bucketCountByEncryptionType",
|
|
"documentation": "<p>The total number of buckets, grouped by default server-side encryption type. This object also reports the total number of buckets that don't encrypt new objects by default.</p>"
|
|
},
|
|
"bucketCountBySharedAccessType": {
|
|
"shape": "BucketCountBySharedAccessType",
|
|
"locationName": "bucketCountBySharedAccessType",
|
|
"documentation": "<p>The total number of buckets that are shared with another AWS account.</p>"
|
|
},
|
|
"classifiableObjectCount": {
|
|
"shape": "__long",
|
|
"locationName": "classifiableObjectCount",
|
|
"documentation": "<p>The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>"
|
|
},
|
|
"classifiableSizeInBytes": {
|
|
"shape": "__long",
|
|
"locationName": "classifiableSizeInBytes",
|
|
"documentation": "<p>The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.</p>"
|
|
},
|
|
"lastUpdated": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "lastUpdated",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the buckets.</p>"
|
|
},
|
|
"objectCount": {
|
|
"shape": "__long",
|
|
"locationName": "objectCount",
|
|
"documentation": "<p>The total number of objects in the buckets.</p>"
|
|
},
|
|
"sizeInBytes": {
|
|
"shape": "__long",
|
|
"locationName": "sizeInBytes",
|
|
"documentation": "<p>The total storage size, in bytes, of the buckets.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.</p>"
|
|
},
|
|
"sizeInBytesCompressed": {
|
|
"shape": "__long",
|
|
"locationName": "sizeInBytesCompressed",
|
|
"documentation": "<p>The total compressed storage size, in bytes, of the buckets.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.</p>"
|
|
},
|
|
"unclassifiableObjectCount": {
|
|
"shape": "ObjectLevelStatistics",
|
|
"locationName": "unclassifiableObjectCount",
|
|
"documentation": "<p>The total number of objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>"
|
|
},
|
|
"unclassifiableObjectSizeInBytes": {
|
|
"shape": "ObjectLevelStatistics",
|
|
"locationName": "unclassifiableObjectSizeInBytes",
|
|
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetClassificationExportConfigurationRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"GetClassificationExportConfigurationResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"configuration": {
|
|
"shape": "ClassificationExportConfiguration",
|
|
"locationName": "configuration",
|
|
"documentation": "<p>The location where data classification results are stored, and the encryption settings that are used when storing results in that location.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetCustomDataIdentifierRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"GetCustomDataIdentifierResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the custom data identifier.</p>"
|
|
},
|
|
"createdAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "createdAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>"
|
|
},
|
|
"deleted": {
|
|
"shape": "__boolean",
|
|
"locationName": "deleted",
|
|
"documentation": "<p>Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.</p>"
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>The custom description of the custom data identifier.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the custom data identifier.</p>"
|
|
},
|
|
"ignoreWords": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "ignoreWords",
|
|
"documentation": "<p>An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.</p>"
|
|
},
|
|
"keywords": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "keywords",
|
|
"documentation": "<p>An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.</p>"
|
|
},
|
|
"maximumMatchDistance": {
|
|
"shape": "__integer",
|
|
"locationName": "maximumMatchDistance",
|
|
"documentation": "<p>The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The custom name of the custom data identifier.</p>"
|
|
},
|
|
"regex": {
|
|
"shape": "__string",
|
|
"locationName": "regex",
|
|
"documentation": "<p>The regular expression (<i>regex</i>) that defines the pattern to match.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetFindingStatisticsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"findingCriteria": {
|
|
"shape": "FindingCriteria",
|
|
"locationName": "findingCriteria",
|
|
"documentation": "<p>The criteria to use to filter the query results.</p>"
|
|
},
|
|
"groupBy": {
|
|
"shape": "GroupBy",
|
|
"locationName": "groupBy",
|
|
"documentation": "<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>"
|
|
},
|
|
"size": {
|
|
"shape": "__integer",
|
|
"locationName": "size",
|
|
"documentation": "<p>The maximum number of items to include in each page of the response.</p>"
|
|
},
|
|
"sortCriteria": {
|
|
"shape": "FindingStatisticsSortCriteria",
|
|
"locationName": "sortCriteria",
|
|
"documentation": "<p>The criteria to use to sort the query results.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupBy"
|
|
]
|
|
},
|
|
"GetFindingStatisticsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"countsByGroup": {
|
|
"shape": "__listOfGroupCount",
|
|
"locationName": "countsByGroup",
|
|
"documentation": "<p>An array of objects, one for each group of findings that meet the filter criteria specified in the request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetFindingsFilterRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"GetFindingsFilterResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"action": {
|
|
"shape": "FindingsFilterAction",
|
|
"locationName": "action",
|
|
"documentation": "<p>The action that's performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the filter.</p>"
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>The custom description of the filter.</p>"
|
|
},
|
|
"findingCriteria": {
|
|
"shape": "FindingCriteria",
|
|
"locationName": "findingCriteria",
|
|
"documentation": "<p>The criteria that's used to filter findings.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the filter.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The custom name of the filter.</p>"
|
|
},
|
|
"position": {
|
|
"shape": "__integer",
|
|
"locationName": "position",
|
|
"documentation": "<p>The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetFindingsPublicationConfigurationRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"GetFindingsPublicationConfigurationResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"securityHubConfiguration": {
|
|
"shape": "SecurityHubConfiguration",
|
|
"locationName": "securityHubConfiguration",
|
|
"documentation": "<p>The configuration settings that determine which findings are published to AWS Security Hub.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetFindingsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"findingIds": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "findingIds",
|
|
"documentation": "<p>An array of strings that lists the unique identifiers for the findings to retrieve.</p>"
|
|
},
|
|
"sortCriteria": {
|
|
"shape": "SortCriteria",
|
|
"locationName": "sortCriteria",
|
|
"documentation": "<p>The criteria for sorting the results of the request.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"findingIds"
|
|
]
|
|
},
|
|
"GetFindingsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"findings": {
|
|
"shape": "__listOfFinding",
|
|
"locationName": "findings",
|
|
"documentation": "<p>An array of objects, one for each finding that meets the criteria specified in the request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetInvitationsCountRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"GetInvitationsCountResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"invitationsCount": {
|
|
"shape": "__long",
|
|
"locationName": "invitationsCount",
|
|
"documentation": "<p>The total number of invitations that were received by the account, not including the currently accepted invitation.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetMacieSessionRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"GetMacieSessionResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"createdAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "createdAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.</p>"
|
|
},
|
|
"findingPublishingFrequency": {
|
|
"shape": "FindingPublishingFrequency",
|
|
"locationName": "findingPublishingFrequency",
|
|
"documentation": "<p>The frequency with which Macie publishes updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).</p>"
|
|
},
|
|
"serviceRole": {
|
|
"shape": "__string",
|
|
"locationName": "serviceRole",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the service-linked role that allows Macie to monitor and analyze data in AWS resources for the account.</p>"
|
|
},
|
|
"status": {
|
|
"shape": "MacieStatus",
|
|
"locationName": "status",
|
|
"documentation": "<p>The current status of the Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.</p>"
|
|
},
|
|
"updatedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "updatedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Macie account.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetMasterAccountRequest": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"GetMasterAccountResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"master": {
|
|
"shape": "Invitation",
|
|
"locationName": "master",
|
|
"documentation": "<p>(Deprecated) The AWS account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetMemberRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"GetMemberResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The AWS account ID for the account.</p>"
|
|
},
|
|
"administratorAccountId": {
|
|
"shape": "__string",
|
|
"locationName": "administratorAccountId",
|
|
"documentation": "<p>The AWS account ID for the administrator account.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the account.</p>"
|
|
},
|
|
"email": {
|
|
"shape": "__string",
|
|
"locationName": "email",
|
|
"documentation": "<p>The email address for the account.</p>"
|
|
},
|
|
"invitedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "invitedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.</p>"
|
|
},
|
|
"masterAccountId": {
|
|
"shape": "__string",
|
|
"locationName": "masterAccountId",
|
|
"documentation": "<p>(Deprecated) The AWS account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>"
|
|
},
|
|
"relationshipStatus": {
|
|
"shape": "RelationshipStatus",
|
|
"locationName": "relationshipStatus",
|
|
"documentation": "<p>The current status of the relationship between the account and the administrator account.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.</p>"
|
|
},
|
|
"updatedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "updatedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetUsageStatisticsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"filterBy": {
|
|
"shape": "__listOfUsageStatisticsFilter",
|
|
"locationName": "filterBy",
|
|
"documentation": "<p>An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.</p>"
|
|
},
|
|
"maxResults": {
|
|
"shape": "__integer",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of the response.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
},
|
|
"sortBy": {
|
|
"shape": "UsageStatisticsSortBy",
|
|
"locationName": "sortBy",
|
|
"documentation": "<p>The criteria to use to sort the query results.</p>"
|
|
},
|
|
"timeRange": {
|
|
"shape": "TimeRange",
|
|
"locationName": "timeRange",
|
|
"documentation": "<p>The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetUsageStatisticsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
},
|
|
"records": {
|
|
"shape": "__listOfUsageRecord",
|
|
"locationName": "records",
|
|
"documentation": "<p>An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.</p>"
|
|
},
|
|
"timeRange": {
|
|
"shape": "TimeRange",
|
|
"locationName": "timeRange",
|
|
"documentation": "<p>The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetUsageTotalsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"timeRange": {
|
|
"shape": "__string",
|
|
"location": "querystring",
|
|
"locationName": "timeRange",
|
|
"documentation": "<p>The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetUsageTotalsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"timeRange": {
|
|
"shape": "TimeRange",
|
|
"locationName": "timeRange",
|
|
"documentation": "<p>The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.</p>"
|
|
},
|
|
"usageTotals": {
|
|
"shape": "__listOfUsageTotal",
|
|
"locationName": "usageTotals",
|
|
"documentation": "<p>An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GroupBy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"resourcesAffected.s3Bucket.name",
|
|
"type",
|
|
"classificationDetails.jobId",
|
|
"severity.description"
|
|
]
|
|
},
|
|
"GroupCount": {
|
|
"type": "structure",
|
|
"members": {
|
|
"count": {
|
|
"shape": "__long",
|
|
"locationName": "count",
|
|
"documentation": "<p>The total number of findings in the group of query results.</p>"
|
|
},
|
|
"groupKey": {
|
|
"shape": "__string",
|
|
"locationName": "groupKey",
|
|
"documentation": "<p>The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides a group of results for a query that retrieved aggregated statistical data about findings.</p>"
|
|
},
|
|
"IamUser": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account that's associated with the IAM user who performed the action.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.</p>"
|
|
},
|
|
"principalId": {
|
|
"shape": "__string",
|
|
"locationName": "principalId",
|
|
"documentation": "<p>The unique identifier for the IAM user who performed the action.</p>"
|
|
},
|
|
"userName": {
|
|
"shape": "__string",
|
|
"locationName": "userName",
|
|
"documentation": "<p>The user name of the IAM user who performed the action.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an AWS Identity and Access Management (IAM) user who performed an action on an affected resource.</p>"
|
|
},
|
|
"InternalServerException": {
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape": "__string",
|
|
"locationName": "message",
|
|
"documentation": "<p>The explanation of the error that occurred.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an error that occurred due to an unknown internal server error, exception, or failure.</p>",
|
|
"exception": true,
|
|
"error": {
|
|
"httpStatusCode": 500
|
|
}
|
|
},
|
|
"Invitation": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The AWS account ID for the account that sent the invitation.</p>"
|
|
},
|
|
"invitationId": {
|
|
"shape": "__string",
|
|
"locationName": "invitationId",
|
|
"documentation": "<p>The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.</p>"
|
|
},
|
|
"invitedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "invitedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.</p>"
|
|
},
|
|
"relationshipStatus": {
|
|
"shape": "RelationshipStatus",
|
|
"locationName": "relationshipStatus",
|
|
"documentation": "<p>The status of the relationship between the account that sent the invitation (<i>inviter account</i>) and the account that received the invitation (<i>invitee account</i>).</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an Amazon Macie membership invitation that was received by an account.</p>"
|
|
},
|
|
"IpAddressDetails": {
|
|
"type": "structure",
|
|
"members": {
|
|
"ipAddressV4": {
|
|
"shape": "__string",
|
|
"locationName": "ipAddressV4",
|
|
"documentation": "<p>The Internet Protocol version 4 (IPv4) address of the device.</p>"
|
|
},
|
|
"ipCity": {
|
|
"shape": "IpCity",
|
|
"locationName": "ipCity",
|
|
"documentation": "<p>The city that the IP address originated from.</p>"
|
|
},
|
|
"ipCountry": {
|
|
"shape": "IpCountry",
|
|
"locationName": "ipCountry",
|
|
"documentation": "<p>The country that the IP address originated from.</p>"
|
|
},
|
|
"ipGeoLocation": {
|
|
"shape": "IpGeoLocation",
|
|
"locationName": "ipGeoLocation",
|
|
"documentation": "<p>The geographic coordinates of the location that the IP address originated from.</p>"
|
|
},
|
|
"ipOwner": {
|
|
"shape": "IpOwner",
|
|
"locationName": "ipOwner",
|
|
"documentation": "<p>The registered owner of the IP address.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the IP address of the device that an entity used to perform an action on an affected resource.</p>"
|
|
},
|
|
"IpCity": {
|
|
"type": "structure",
|
|
"members": {
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The name of the city.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the city that an IP address originated from.</p>"
|
|
},
|
|
"IpCountry": {
|
|
"type": "structure",
|
|
"members": {
|
|
"code": {
|
|
"shape": "__string",
|
|
"locationName": "code",
|
|
"documentation": "<p>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.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The name of the country that the IP address originated from.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the country that an IP address originated from.</p>"
|
|
},
|
|
"IpGeoLocation": {
|
|
"type": "structure",
|
|
"members": {
|
|
"lat": {
|
|
"shape": "__double",
|
|
"locationName": "lat",
|
|
"documentation": "<p>The latitude coordinate of the location, rounded to four decimal places.</p>"
|
|
},
|
|
"lon": {
|
|
"shape": "__double",
|
|
"locationName": "lon",
|
|
"documentation": "<p>The longitude coordinate of the location, rounded to four decimal places.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides geographic coordinates that indicate where a specified IP address originated from.</p>"
|
|
},
|
|
"IpOwner": {
|
|
"type": "structure",
|
|
"members": {
|
|
"asn": {
|
|
"shape": "__string",
|
|
"locationName": "asn",
|
|
"documentation": "<p>The autonomous system number (ASN) for the autonomous system that included the IP address.</p>"
|
|
},
|
|
"asnOrg": {
|
|
"shape": "__string",
|
|
"locationName": "asnOrg",
|
|
"documentation": "<p>The organization identifier that's associated with the autonomous system number (ASN) for the autonomous system that included the IP address.</p>"
|
|
},
|
|
"isp": {
|
|
"shape": "__string",
|
|
"locationName": "isp",
|
|
"documentation": "<p>The name of the internet service provider (ISP) that owned the IP address.</p>"
|
|
},
|
|
"org": {
|
|
"shape": "__string",
|
|
"locationName": "org",
|
|
"documentation": "<p>The name of the organization that owned the IP address.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the registered owner of an IP address.</p>"
|
|
},
|
|
"IsDefinedInJob": {
|
|
"type": "string",
|
|
"enum": [
|
|
"TRUE",
|
|
"FALSE",
|
|
"UNKNOWN"
|
|
]
|
|
},
|
|
"IsMonitoredByJob": {
|
|
"type": "string",
|
|
"enum": [
|
|
"TRUE",
|
|
"FALSE",
|
|
"UNKNOWN"
|
|
]
|
|
},
|
|
"JobComparator": {
|
|
"type": "string",
|
|
"documentation": "<p>The operator to use in a condition. Valid values are:</p>",
|
|
"enum": [
|
|
"EQ",
|
|
"GT",
|
|
"GTE",
|
|
"LT",
|
|
"LTE",
|
|
"NE",
|
|
"CONTAINS",
|
|
"STARTS_WITH"
|
|
]
|
|
},
|
|
"JobDetails": {
|
|
"type": "structure",
|
|
"members": {
|
|
"isDefinedInJob": {
|
|
"shape": "IsDefinedInJob",
|
|
"locationName": "isDefinedInJob",
|
|
"documentation": "<p>Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:</p> <ul><li><p>TRUE - One or more jobs is configured to analyze data in the bucket, and at least one of those jobs has a status other than CANCELLED.</p></li> <li><p>FALSE - No jobs are configured to analyze data in the bucket, or all the jobs that are configured to analyze data in the bucket have a status of CANCELLED.</p></li> <li><p>UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.</p></li></ul> <p></p>"
|
|
},
|
|
"isMonitoredByJob": {
|
|
"shape": "IsMonitoredByJob",
|
|
"locationName": "isMonitoredByJob",
|
|
"documentation": "<p>Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:</p> <ul><li><p>TRUE - One or more recurring jobs is configured to analyze data in the bucket, and at least one of those jobs has a status other than CANCELLED.</p></li> <li><p>FALSE - No recurring jobs are configured to analyze data in the bucket, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.</p></li> <li><p>UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.</p></li></ul>"
|
|
},
|
|
"lastJobId": {
|
|
"shape": "__string",
|
|
"locationName": "lastJobId",
|
|
"documentation": "<p>The unique identifier for the job that ran most recently (either the latest run of a recurring job or the only run of a one-time job) and is configured to analyze data in the bucket.</p> <p>This value is null if the value for the isDefinedInJob property is FALSE or UNKNOWN.</p>"
|
|
},
|
|
"lastJobRunTime": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "lastJobRunTime",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.</p> <p>This value is null if the value for the isDefinedInJob property is FALSE or UNKNOWN.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies whether any one-time or recurring classification jobs are configured to analyze data in an S3 bucket, and, if so, the details of the job that ran most recently.</p>"
|
|
},
|
|
"JobScheduleFrequency": {
|
|
"type": "structure",
|
|
"members": {
|
|
"dailySchedule": {
|
|
"shape": "DailySchedule",
|
|
"locationName": "dailySchedule",
|
|
"documentation": "<p>Specifies a daily recurrence pattern for running the job.</p>"
|
|
},
|
|
"monthlySchedule": {
|
|
"shape": "MonthlySchedule",
|
|
"locationName": "monthlySchedule",
|
|
"documentation": "<p>Specifies a monthly recurrence pattern for running the job.</p>"
|
|
},
|
|
"weeklySchedule": {
|
|
"shape": "WeeklySchedule",
|
|
"locationName": "weeklySchedule",
|
|
"documentation": "<p>Specifies a weekly recurrence pattern for running the job.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies the recurrence pattern for running a classification job.</p>"
|
|
},
|
|
"JobScopeTerm": {
|
|
"type": "structure",
|
|
"members": {
|
|
"simpleScopeTerm": {
|
|
"shape": "SimpleScopeTerm",
|
|
"locationName": "simpleScopeTerm",
|
|
"documentation": "<p>A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job.</p>"
|
|
},
|
|
"tagScopeTerm": {
|
|
"shape": "TagScopeTerm",
|
|
"locationName": "tagScopeTerm",
|
|
"documentation": "<p>A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a property- or tag-based condition that defines criteria for including or excluding objects from a classification job.</p>"
|
|
},
|
|
"JobScopingBlock": {
|
|
"type": "structure",
|
|
"members": {
|
|
"and": {
|
|
"shape": "__listOfJobScopeTerm",
|
|
"locationName": "and",
|
|
"documentation": "<p>An array of conditions, one for each condition that determines which objects to include or exclude from the job.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.</p>"
|
|
},
|
|
"JobStatus": {
|
|
"type": "string",
|
|
"documentation": "<p>The status of a classification job. Possible values are:</p>",
|
|
"enum": [
|
|
"RUNNING",
|
|
"PAUSED",
|
|
"CANCELLED",
|
|
"COMPLETE",
|
|
"IDLE",
|
|
"USER_PAUSED"
|
|
]
|
|
},
|
|
"JobSummary": {
|
|
"type": "structure",
|
|
"members": {
|
|
"bucketDefinitions": {
|
|
"shape": "__listOfS3BucketDefinitionForJob",
|
|
"locationName": "bucketDefinitions",
|
|
"documentation": "<p>The S3 buckets that the job is configured to analyze.</p>"
|
|
},
|
|
"createdAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "createdAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the job was created.</p>"
|
|
},
|
|
"jobId": {
|
|
"shape": "__string",
|
|
"locationName": "jobId",
|
|
"documentation": "<p>The unique identifier for the job.</p>"
|
|
},
|
|
"jobStatus": {
|
|
"shape": "JobStatus",
|
|
"locationName": "jobStatus",
|
|
"documentation": "<p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.</p></li> <li><p>COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.</p></li> <li><p>IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.</p></li> <li><p>PAUSED - Amazon Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.</p></li> <li><p>RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.</p></li> <li><p>USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>"
|
|
},
|
|
"jobType": {
|
|
"shape": "JobType",
|
|
"locationName": "jobType",
|
|
"documentation": "<p>The schedule for running the job. Possible values are:</p> <ul><li><p>ONE_TIME - The job runs only once.</p></li> <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly basis.</p></li></ul>"
|
|
},
|
|
"lastRunErrorStatus": {
|
|
"shape": "LastRunErrorStatus",
|
|
"locationName": "lastRunErrorStatus",
|
|
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The custom name of the job.</p>"
|
|
},
|
|
"userPausedDetails": {
|
|
"shape": "UserPausedDetails",
|
|
"locationName": "userPausedDetails",
|
|
"documentation": "<p>If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about a classification job, including the current status of the job.</p>"
|
|
},
|
|
"JobType": {
|
|
"type": "string",
|
|
"documentation": "<p>The schedule for running a classification job. Valid values are:</p>",
|
|
"enum": [
|
|
"ONE_TIME",
|
|
"SCHEDULED"
|
|
]
|
|
},
|
|
"KeyValuePair": {
|
|
"type": "structure",
|
|
"members": {
|
|
"key": {
|
|
"shape": "__string",
|
|
"locationName": "key",
|
|
"documentation": "<p>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.</p>"
|
|
},
|
|
"value": {
|
|
"shape": "__string",
|
|
"locationName": "value",
|
|
"documentation": "<p>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.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>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.</p>"
|
|
},
|
|
"KeyValuePairList": {
|
|
"type": "list",
|
|
"documentation": "<p>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.</p>",
|
|
"member": {
|
|
"shape": "KeyValuePair"
|
|
}
|
|
},
|
|
"LastRunErrorStatus": {
|
|
"type": "structure",
|
|
"members": {
|
|
"code": {
|
|
"shape": "LastRunErrorStatusCode",
|
|
"locationName": "code",
|
|
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:</p> <ul><li><p>ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.</p></li> <li><p>NONE - No errors occurred. Macie processed all the data specified for the job.</p></li></ul>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.</p>"
|
|
},
|
|
"LastRunErrorStatusCode": {
|
|
"type": "string",
|
|
"documentation": "<p>Specifies whether any account- or bucket-level access errors occurred during the run of a one-time classification job or the most recent run of a recurring classification job. Possible values are:</p>",
|
|
"enum": [
|
|
"NONE",
|
|
"ERROR"
|
|
]
|
|
},
|
|
"ListClassificationJobsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"filterCriteria": {
|
|
"shape": "ListJobsFilterCriteria",
|
|
"locationName": "filterCriteria",
|
|
"documentation": "<p>The criteria to use to filter the results.</p>"
|
|
},
|
|
"maxResults": {
|
|
"shape": "__integer",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of the response.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
},
|
|
"sortCriteria": {
|
|
"shape": "ListJobsSortCriteria",
|
|
"locationName": "sortCriteria",
|
|
"documentation": "<p>The criteria to use to sort the results.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListClassificationJobsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"items": {
|
|
"shape": "__listOfJobSummary",
|
|
"locationName": "items",
|
|
"documentation": "<p>An array of objects, one for each job that meets the filter criteria specified in the request.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListCustomDataIdentifiersRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"maxResults": {
|
|
"shape": "__integer",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of the response.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListCustomDataIdentifiersResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"items": {
|
|
"shape": "__listOfCustomDataIdentifierSummary",
|
|
"locationName": "items",
|
|
"documentation": "<p>An array of objects, one for each custom data identifier.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListFindingsFiltersRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"maxResults": {
|
|
"shape": "MaxResults",
|
|
"location": "querystring",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of a paginated response.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"location": "querystring",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListFindingsFiltersResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"findingsFilterListItems": {
|
|
"shape": "__listOfFindingsFilterListItem",
|
|
"locationName": "findingsFilterListItems",
|
|
"documentation": "<p>An array of objects, one for each filter that's associated with the account.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListFindingsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"findingCriteria": {
|
|
"shape": "FindingCriteria",
|
|
"locationName": "findingCriteria",
|
|
"documentation": "<p>The criteria to use to filter the results.</p>"
|
|
},
|
|
"maxResults": {
|
|
"shape": "__integer",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of the response.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
},
|
|
"sortCriteria": {
|
|
"shape": "SortCriteria",
|
|
"locationName": "sortCriteria",
|
|
"documentation": "<p>The criteria to use to sort the results.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListFindingsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"findingIds": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "findingIds",
|
|
"documentation": "<p>An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListInvitationsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"maxResults": {
|
|
"shape": "MaxResults",
|
|
"location": "querystring",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of a paginated response.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"location": "querystring",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListInvitationsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"invitations": {
|
|
"shape": "__listOfInvitation",
|
|
"locationName": "invitations",
|
|
"documentation": "<p>An array of objects, one for each invitation that was received by the account.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListJobsFilterCriteria": {
|
|
"type": "structure",
|
|
"members": {
|
|
"excludes": {
|
|
"shape": "__listOfListJobsFilterTerm",
|
|
"locationName": "excludes",
|
|
"documentation": "<p>An array of objects, one for each condition that determines which jobs to exclude from the results.</p>"
|
|
},
|
|
"includes": {
|
|
"shape": "__listOfListJobsFilterTerm",
|
|
"locationName": "includes",
|
|
"documentation": "<p>An array of objects, one for each condition that determines which jobs to include in the results.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies criteria for filtering the results of a request for information about classification jobs.</p>"
|
|
},
|
|
"ListJobsFilterKey": {
|
|
"type": "string",
|
|
"documentation": "<p>The property to use to filter the results. Valid values are:</p>",
|
|
"enum": [
|
|
"jobType",
|
|
"jobStatus",
|
|
"createdAt",
|
|
"name"
|
|
]
|
|
},
|
|
"ListJobsFilterTerm": {
|
|
"type": "structure",
|
|
"members": {
|
|
"comparator": {
|
|
"shape": "JobComparator",
|
|
"locationName": "comparator",
|
|
"documentation": "<p>The operator to use to filter the results.</p>"
|
|
},
|
|
"key": {
|
|
"shape": "ListJobsFilterKey",
|
|
"locationName": "key",
|
|
"documentation": "<p>The property to use to filter the results.</p>"
|
|
},
|
|
"values": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "values",
|
|
"documentation": "<p>An array that lists one or more values to use to filter the results.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a condition that filters the results of a request for information about classification jobs. Each condition consists of a property, an operator, and one or more values.</p>"
|
|
},
|
|
"ListJobsSortAttributeName": {
|
|
"type": "string",
|
|
"documentation": "<p>The property to sort the results by. Valid values are:</p>",
|
|
"enum": [
|
|
"createdAt",
|
|
"jobStatus",
|
|
"name",
|
|
"jobType"
|
|
]
|
|
},
|
|
"ListJobsSortCriteria": {
|
|
"type": "structure",
|
|
"members": {
|
|
"attributeName": {
|
|
"shape": "ListJobsSortAttributeName",
|
|
"locationName": "attributeName",
|
|
"documentation": "<p>The property to sort the results by.</p>"
|
|
},
|
|
"orderBy": {
|
|
"shape": "OrderBy",
|
|
"locationName": "orderBy",
|
|
"documentation": "<p>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.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies criteria for sorting the results of a request for information about classification jobs.</p>"
|
|
},
|
|
"ListMembersRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"maxResults": {
|
|
"shape": "MaxResults",
|
|
"location": "querystring",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of a paginated response.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"location": "querystring",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
},
|
|
"onlyAssociated": {
|
|
"shape": "__string",
|
|
"location": "querystring",
|
|
"locationName": "onlyAssociated",
|
|
"documentation": "<p>Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListMembersResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"members": {
|
|
"shape": "__listOfMember",
|
|
"locationName": "members",
|
|
"documentation": "<p>An array of objects, one for each account that's associated with the administrator account and meets the criteria specified by the onlyAssociated request parameter.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListOrganizationAdminAccountsRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"maxResults": {
|
|
"shape": "MaxResults",
|
|
"location": "querystring",
|
|
"locationName": "maxResults",
|
|
"documentation": "<p>The maximum number of items to include in each page of a paginated response.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"location": "querystring",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListOrganizationAdminAccountsResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"adminAccounts": {
|
|
"shape": "__listOfAdminAccount",
|
|
"locationName": "adminAccounts",
|
|
"documentation": "<p>An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.</p>"
|
|
},
|
|
"nextToken": {
|
|
"shape": "__string",
|
|
"locationName": "nextToken",
|
|
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListTagsForResourceRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"resourceArn": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "resourceArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"resourceArn"
|
|
]
|
|
},
|
|
"ListTagsForResourceResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the resource.</p>"
|
|
}
|
|
}
|
|
},
|
|
"MacieStatus": {
|
|
"type": "string",
|
|
"documentation": "<p>The status of an Amazon Macie account. Valid values are:</p>",
|
|
"enum": [
|
|
"PAUSED",
|
|
"ENABLED"
|
|
]
|
|
},
|
|
"MaxResults": {
|
|
"type": "integer",
|
|
"min": 1,
|
|
"max": 25
|
|
},
|
|
"Member": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The AWS account ID for the account.</p>"
|
|
},
|
|
"administratorAccountId": {
|
|
"shape": "__string",
|
|
"locationName": "administratorAccountId",
|
|
"documentation": "<p>The AWS account ID for the administrator account.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the account.</p>"
|
|
},
|
|
"email": {
|
|
"shape": "__string",
|
|
"locationName": "email",
|
|
"documentation": "<p>The email address for the account.</p>"
|
|
},
|
|
"invitedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "invitedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.</p>"
|
|
},
|
|
"masterAccountId": {
|
|
"shape": "__string",
|
|
"locationName": "masterAccountId",
|
|
"documentation": "<p>(Deprecated) The AWS account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>"
|
|
},
|
|
"relationshipStatus": {
|
|
"shape": "RelationshipStatus",
|
|
"locationName": "relationshipStatus",
|
|
"documentation": "<p>The current status of the relationship between the account and the administrator account.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.</p>"
|
|
},
|
|
"updatedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "updatedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an account that's associated with an Amazon Macie administrator account.</p>"
|
|
},
|
|
"MonthlySchedule": {
|
|
"type": "structure",
|
|
"members": {
|
|
"dayOfMonth": {
|
|
"shape": "__integer",
|
|
"locationName": "dayOfMonth",
|
|
"documentation": "<p>The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.</p> <p>If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a monthly recurrence pattern for running a classification job.</p>"
|
|
},
|
|
"ObjectCountByEncryptionType": {
|
|
"type": "structure",
|
|
"members": {
|
|
"customerManaged": {
|
|
"shape": "__long",
|
|
"locationName": "customerManaged",
|
|
"documentation": "<p>The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side encryption (SSE-C).</p>"
|
|
},
|
|
"kmsManaged": {
|
|
"shape": "__long",
|
|
"locationName": "kmsManaged",
|
|
"documentation": "<p>The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p>"
|
|
},
|
|
"s3Managed": {
|
|
"shape": "__long",
|
|
"locationName": "s3Managed",
|
|
"documentation": "<p>The total number of objects that are encrypted using an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).</p>"
|
|
},
|
|
"unencrypted": {
|
|
"shape": "__long",
|
|
"locationName": "unencrypted",
|
|
"documentation": "<p>The total number of objects that aren't encrypted or use client-side encryption.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren't encrypted.</p>"
|
|
},
|
|
"ObjectLevelStatistics": {
|
|
"type": "structure",
|
|
"members": {
|
|
"fileType": {
|
|
"shape": "__long",
|
|
"locationName": "fileType",
|
|
"documentation": "<p>The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.</p>"
|
|
},
|
|
"storageClass": {
|
|
"shape": "__long",
|
|
"locationName": "storageClass",
|
|
"documentation": "<p>The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.</p>"
|
|
},
|
|
"total": {
|
|
"shape": "__long",
|
|
"locationName": "total",
|
|
"documentation": "<p>The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results. If versioning is enabled for a bucket, total storage size values are based on the size of the latest version of each applicable object in the bucket.</p>"
|
|
},
|
|
"Occurrences": {
|
|
"type": "structure",
|
|
"members": {
|
|
"cells": {
|
|
"shape": "Cells",
|
|
"locationName": "cells",
|
|
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell or field that contains the data. This value is null for all other types of files.</p>"
|
|
},
|
|
"lineRanges": {
|
|
"shape": "Ranges",
|
|
"locationName": "lineRanges",
|
|
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.</p> <p>This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.</p>"
|
|
},
|
|
"offsetRanges": {
|
|
"shape": "Ranges",
|
|
"locationName": "offsetRanges",
|
|
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.</p> <p>This value is typically null. For binary text files, Amazon Macie adds location data to a lineRanges.Range or Page object, depending on the file type.</p>"
|
|
},
|
|
"pages": {
|
|
"shape": "Pages",
|
|
"locationName": "pages",
|
|
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.</p>"
|
|
},
|
|
"records": {
|
|
"shape": "Records",
|
|
"locationName": "records",
|
|
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the record index and the path to the field in the record that contains the data. This value is null for all other types of files.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.</p>"
|
|
},
|
|
"OrderBy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ASC",
|
|
"DESC"
|
|
]
|
|
},
|
|
"Page": {
|
|
"type": "structure",
|
|
"members": {
|
|
"lineRange": {
|
|
"shape": "Range",
|
|
"locationName": "lineRange",
|
|
"documentation": "<p>The line that contains the data, and the position of the data on that line.</p>"
|
|
},
|
|
"offsetRange": {
|
|
"shape": "Range",
|
|
"locationName": "offsetRange",
|
|
"documentation": "<p>The position of the data on the page, relative to the beginning of the page.</p>"
|
|
},
|
|
"pageNumber": {
|
|
"shape": "__long",
|
|
"locationName": "pageNumber",
|
|
"documentation": "<p>The page number of the page that contains the data.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.</p>"
|
|
},
|
|
"Pages": {
|
|
"type": "list",
|
|
"documentation": "<p>Specifies the location of occurrences of sensitive data in an Adobe Portable Document Format file.</p>",
|
|
"member": {
|
|
"shape": "Page"
|
|
}
|
|
},
|
|
"PolicyDetails": {
|
|
"type": "structure",
|
|
"members": {
|
|
"action": {
|
|
"shape": "FindingAction",
|
|
"locationName": "action",
|
|
"documentation": "<p>The action that produced the finding.</p>"
|
|
},
|
|
"actor": {
|
|
"shape": "FindingActor",
|
|
"locationName": "actor",
|
|
"documentation": "<p>The entity that performed the action that produced the finding.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides the details of a policy finding.</p>"
|
|
},
|
|
"PutClassificationExportConfigurationRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"configuration": {
|
|
"shape": "ClassificationExportConfiguration",
|
|
"locationName": "configuration",
|
|
"documentation": "<p>The location to store data classification results in, and the encryption settings to use when storing results in that location.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"configuration"
|
|
]
|
|
},
|
|
"PutClassificationExportConfigurationResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"configuration": {
|
|
"shape": "ClassificationExportConfiguration",
|
|
"locationName": "configuration",
|
|
"documentation": "<p>The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutFindingsPublicationConfigurationRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"clientToken": {
|
|
"shape": "__string",
|
|
"locationName": "clientToken",
|
|
"documentation": "<p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>",
|
|
"idempotencyToken": true
|
|
},
|
|
"securityHubConfiguration": {
|
|
"shape": "SecurityHubConfiguration",
|
|
"locationName": "securityHubConfiguration",
|
|
"documentation": "<p>The configuration settings that determine which findings to publish to AWS Security Hub.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutFindingsPublicationConfigurationResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"Range": {
|
|
"type": "structure",
|
|
"members": {
|
|
"end": {
|
|
"shape": "__long",
|
|
"locationName": "end",
|
|
"documentation": "<p>Possible values are:</p> <ul><li><p>In an Occurrences.lineRanges array, the number of lines from the beginning of the file to the end of the sensitive data.</p></li> <li><p>In an Occurrences.offsetRanges array, the number of characters from the beginning of the file to the end of the sensitive data.</p></li> <li><p>In a Page object, the number of lines (lineRange) or characters (offsetRange) from the beginning of the page to the end of the sensitive data.</p></li></ul>"
|
|
},
|
|
"start": {
|
|
"shape": "__long",
|
|
"locationName": "start",
|
|
"documentation": "<p>Possible values are:</p> <ul><li><p>In an Occurrences.lineRanges array, the number of lines from the beginning of the file to the beginning of the sensitive data.</p></li> <li><p>In an Occurrences.offsetRanges array, the number of characters from the beginning of the file to the beginning of the sensitive data.</p></li> <li><p>In a Page object, the number of lines (lineRange) or characters (offsetRange) from the beginning of the page to the beginning of the sensitive data.</p></li></ul>"
|
|
},
|
|
"startColumn": {
|
|
"shape": "__long",
|
|
"locationName": "startColumn",
|
|
"documentation": "<p>The column number for the column that contains the data, if the file contains structured data.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.</p>"
|
|
},
|
|
"Ranges": {
|
|
"type": "list",
|
|
"documentation": "<p>Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.</p>",
|
|
"member": {
|
|
"shape": "Range"
|
|
}
|
|
},
|
|
"Record": {
|
|
"type": "structure",
|
|
"members": {
|
|
"jsonPath": {
|
|
"shape": "__string",
|
|
"locationName": "jsonPath",
|
|
"documentation": "<p>The path, as a JSONPath expression, to the field in the record that contains the data. If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field.</p> <p>If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.</p>"
|
|
},
|
|
"recordIndex": {
|
|
"shape": "__long",
|
|
"locationName": "recordIndex",
|
|
"documentation": "<p>The record index, starting from 0, for the record that contains the data.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies the location of an occurrence of sensitive data in an Apache Avro object container or Apache Parquet file.</p>"
|
|
},
|
|
"Records": {
|
|
"type": "list",
|
|
"documentation": "<p>Specifies the location of occurrences of sensitive data in an Apache Parquet file.</p>",
|
|
"member": {
|
|
"shape": "Record"
|
|
}
|
|
},
|
|
"RelationshipStatus": {
|
|
"type": "string",
|
|
"documentation": "<p>The current status of the relationship between an account and an associated Amazon Macie administrator account (<i>inviter account</i>). Possible values are:</p>",
|
|
"enum": [
|
|
"Enabled",
|
|
"Paused",
|
|
"Invited",
|
|
"Created",
|
|
"Removed",
|
|
"Resigned",
|
|
"EmailVerificationInProgress",
|
|
"EmailVerificationFailed",
|
|
"RegionDisabled",
|
|
"AccountSuspended"
|
|
]
|
|
},
|
|
"ReplicationDetails": {
|
|
"type": "structure",
|
|
"members": {
|
|
"replicated": {
|
|
"shape": "__boolean",
|
|
"locationName": "replicated",
|
|
"documentation": "<p>Specifies whether the bucket is configured to replicate one or more objects to any destination.</p>"
|
|
},
|
|
"replicatedExternally": {
|
|
"shape": "__boolean",
|
|
"locationName": "replicatedExternally",
|
|
"documentation": "<p>Specifies whether the bucket is configured to replicate one or more objects to an AWS account that isn't part of the same Amazon Macie organization.</p>"
|
|
},
|
|
"replicationAccounts": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "replicationAccounts",
|
|
"documentation": "<p>An array of AWS account IDs, one for each AWS account that the bucket is configured to replicate one or more objects to.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other AWS accounts and, if so, which accounts.</p>"
|
|
},
|
|
"ResourceNotFoundException": {
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape": "__string",
|
|
"locationName": "message",
|
|
"documentation": "<p>The explanation of the error that occurred.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an error that occurred because a specified resource wasn't found.</p>",
|
|
"exception": true,
|
|
"error": {
|
|
"httpStatusCode": 404
|
|
}
|
|
},
|
|
"ResourcesAffected": {
|
|
"type": "structure",
|
|
"members": {
|
|
"s3Bucket": {
|
|
"shape": "S3Bucket",
|
|
"locationName": "s3Bucket",
|
|
"documentation": "<p>An array of objects, one for each S3 bucket that the finding applies to. Each object provides a set of metadata about an affected S3 bucket.</p>"
|
|
},
|
|
"s3Object": {
|
|
"shape": "S3Object",
|
|
"locationName": "s3Object",
|
|
"documentation": "<p>An array of objects, one for each S3 object that the finding applies to. Each object provides a set of metadata about an affected S3 object.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the resources that a finding applies to.</p>"
|
|
},
|
|
"S3Bucket": {
|
|
"type": "structure",
|
|
"members": {
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the bucket.</p>"
|
|
},
|
|
"createdAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "createdAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the bucket was created.</p>"
|
|
},
|
|
"defaultServerSideEncryption": {
|
|
"shape": "ServerSideEncryption",
|
|
"locationName": "defaultServerSideEncryption",
|
|
"documentation": "<p>The type of server-side encryption that's used by default to encrypt objects in the bucket.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>The name of the bucket.</p>"
|
|
},
|
|
"owner": {
|
|
"shape": "S3BucketOwner",
|
|
"locationName": "owner",
|
|
"documentation": "<p>The display name and account identifier for the user who owns the bucket.</p>"
|
|
},
|
|
"publicAccess": {
|
|
"shape": "BucketPublicAccess",
|
|
"locationName": "publicAccess",
|
|
"documentation": "<p>The permissions settings that determine whether the bucket is publicly accessible.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "KeyValuePairList",
|
|
"locationName": "tags",
|
|
"documentation": "<p>The tags that are associated with the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an S3 bucket that a finding applies to.</p>"
|
|
},
|
|
"S3BucketDefinitionForJob": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account that owns the buckets.</p>"
|
|
},
|
|
"buckets": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "buckets",
|
|
"documentation": "<p>An array that lists the names of the buckets.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies which AWS account owns the S3 buckets that a classification job analyzes, and the buckets to analyze for the account.</p>",
|
|
"required": [
|
|
"accountId",
|
|
"buckets"
|
|
]
|
|
},
|
|
"S3BucketOwner": {
|
|
"type": "structure",
|
|
"members": {
|
|
"displayName": {
|
|
"shape": "__string",
|
|
"locationName": "displayName",
|
|
"documentation": "<p>The display name of the user who owns the bucket.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The AWS account ID for the user who owns the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the user who owns an S3 bucket.</p>"
|
|
},
|
|
"S3Destination": {
|
|
"type": "structure",
|
|
"members": {
|
|
"bucketName": {
|
|
"shape": "__string",
|
|
"locationName": "bucketName",
|
|
"documentation": "<p>The name of the bucket.</p>"
|
|
},
|
|
"keyPrefix": {
|
|
"shape": "__string",
|
|
"locationName": "keyPrefix",
|
|
"documentation": "<p>The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.</p>"
|
|
},
|
|
"kmsKeyArn": {
|
|
"shape": "__string",
|
|
"locationName": "kmsKeyArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encryption of the results. This must be the ARN of an existing CMK that's in the same AWS Region as the bucket.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.</p>",
|
|
"required": [
|
|
"bucketName",
|
|
"kmsKeyArn"
|
|
]
|
|
},
|
|
"S3JobDefinition": {
|
|
"type": "structure",
|
|
"members": {
|
|
"bucketDefinitions": {
|
|
"shape": "__listOfS3BucketDefinitionForJob",
|
|
"locationName": "bucketDefinitions",
|
|
"documentation": "<p>An array of objects, one for each AWS account that owns buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for the account.</p>"
|
|
},
|
|
"scoping": {
|
|
"shape": "Scoping",
|
|
"locationName": "scoping",
|
|
"documentation": "<p>The property- and tag-based conditions that determine which objects to include or exclude from the analysis.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.</p>"
|
|
},
|
|
"S3Object": {
|
|
"type": "structure",
|
|
"members": {
|
|
"bucketArn": {
|
|
"shape": "__string",
|
|
"locationName": "bucketArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the bucket that contains the object.</p>"
|
|
},
|
|
"eTag": {
|
|
"shape": "__string",
|
|
"locationName": "eTag",
|
|
"documentation": "<p>The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.</p>"
|
|
},
|
|
"extension": {
|
|
"shape": "__string",
|
|
"locationName": "extension",
|
|
"documentation": "<p>The file name extension of the object. If the object doesn't have a file name extension, this value is \"\".</p>"
|
|
},
|
|
"key": {
|
|
"shape": "__string",
|
|
"locationName": "key",
|
|
"documentation": "<p>The full key (name) that's assigned to the object.</p>"
|
|
},
|
|
"lastModified": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "lastModified",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the object was last modified.</p>"
|
|
},
|
|
"path": {
|
|
"shape": "__string",
|
|
"locationName": "path",
|
|
"documentation": "<p>The path to the object, including the full key (name).</p>"
|
|
},
|
|
"publicAccess": {
|
|
"shape": "__boolean",
|
|
"locationName": "publicAccess",
|
|
"documentation": "<p>Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.</p>"
|
|
},
|
|
"serverSideEncryption": {
|
|
"shape": "ServerSideEncryption",
|
|
"locationName": "serverSideEncryption",
|
|
"documentation": "<p>The type of server-side encryption that's used to encrypt the object.</p>"
|
|
},
|
|
"size": {
|
|
"shape": "__long",
|
|
"locationName": "size",
|
|
"documentation": "<p>The total storage size, in bytes, of the object.</p>"
|
|
},
|
|
"storageClass": {
|
|
"shape": "StorageClass",
|
|
"locationName": "storageClass",
|
|
"documentation": "<p>The storage class of the object.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "KeyValuePairList",
|
|
"locationName": "tags",
|
|
"documentation": "<p>The tags that are associated with the object.</p>"
|
|
},
|
|
"versionId": {
|
|
"shape": "__string",
|
|
"locationName": "versionId",
|
|
"documentation": "<p>The identifier for the affected version of the object.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an S3 object that a finding applies to.</p>"
|
|
},
|
|
"ScopeFilterKey": {
|
|
"type": "string",
|
|
"documentation": "<p>The property to use in a condition that determines which objects are analyzed by a classification job. Valid values are:</p>",
|
|
"enum": [
|
|
"BUCKET_CREATION_DATE",
|
|
"OBJECT_EXTENSION",
|
|
"OBJECT_LAST_MODIFIED_DATE",
|
|
"OBJECT_SIZE",
|
|
"TAG",
|
|
"OBJECT_KEY"
|
|
]
|
|
},
|
|
"Scoping": {
|
|
"type": "structure",
|
|
"members": {
|
|
"excludes": {
|
|
"shape": "JobScopingBlock",
|
|
"locationName": "excludes",
|
|
"documentation": "<p>The property- or tag-based conditions that determine which objects to exclude from the analysis.</p>"
|
|
},
|
|
"includes": {
|
|
"shape": "JobScopingBlock",
|
|
"locationName": "includes",
|
|
"documentation": "<p>The property- or tag-based conditions that determine which objects to include in the analysis.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes. Exclude conditions take precedence over include conditions.</p>"
|
|
},
|
|
"SecurityHubConfiguration": {
|
|
"type": "structure",
|
|
"members": {
|
|
"publishClassificationFindings": {
|
|
"shape": "__boolean",
|
|
"locationName": "publishClassificationFindings",
|
|
"documentation": "<p>Specifies whether to publish sensitive data findings to AWS Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.</p>"
|
|
},
|
|
"publishPolicyFindings": {
|
|
"shape": "__boolean",
|
|
"locationName": "publishPolicyFindings",
|
|
"documentation": "<p>Specifies whether to publish policy findings to AWS Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies configuration settings that determine which findings are published to AWS Security Hub automatically. For information about how Macie publishes findings to Security Hub, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/securityhub-integration.html\">Amazon Macie integration with Security Hub</a> in the <i>Amazon Macie User Guide</i>.</p>",
|
|
"required": [
|
|
"publishPolicyFindings",
|
|
"publishClassificationFindings"
|
|
]
|
|
},
|
|
"SensitiveData": {
|
|
"type": "list",
|
|
"documentation": "<p>Provides information about the category and number of occurrences of sensitive data that produced a finding.</p>",
|
|
"member": {
|
|
"shape": "SensitiveDataItem"
|
|
}
|
|
},
|
|
"SensitiveDataItem": {
|
|
"type": "structure",
|
|
"members": {
|
|
"category": {
|
|
"shape": "SensitiveDataItemCategory",
|
|
"locationName": "category",
|
|
"documentation": "<p>The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or AWS secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as driver's license identification numbers.</p>"
|
|
},
|
|
"detections": {
|
|
"shape": "DefaultDetections",
|
|
"locationName": "detections",
|
|
"documentation": "<p>An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.</p>"
|
|
},
|
|
"totalCount": {
|
|
"shape": "__long",
|
|
"locationName": "totalCount",
|
|
"documentation": "<p>The total number of occurrences of the sensitive data that was detected.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.</p>"
|
|
},
|
|
"SensitiveDataItemCategory": {
|
|
"type": "string",
|
|
"documentation": "<p>The category of sensitive data that was detected and produced the finding. Possible values are:</p>",
|
|
"enum": [
|
|
"FINANCIAL_INFORMATION",
|
|
"PERSONAL_INFORMATION",
|
|
"CREDENTIALS",
|
|
"CUSTOM_IDENTIFIER"
|
|
]
|
|
},
|
|
"ServerSideEncryption": {
|
|
"type": "structure",
|
|
"members": {
|
|
"encryptionType": {
|
|
"shape": "EncryptionType",
|
|
"locationName": "encryptionType",
|
|
"documentation": "<p>The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption is disabled for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.</p>"
|
|
},
|
|
"kmsMasterKeyId": {
|
|
"shape": "__string",
|
|
"locationName": "kmsMasterKeyId",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used to encrypt data in the bucket or the object. If an AWS KMS CMK isn't used, this value is null.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the server-side encryption settings for an S3 bucket or S3 object.</p>"
|
|
},
|
|
"ServiceLimit": {
|
|
"type": "structure",
|
|
"members": {
|
|
"isServiceLimited": {
|
|
"shape": "__boolean",
|
|
"locationName": "isServiceLimited",
|
|
"documentation": "<p>Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.</p>"
|
|
},
|
|
"unit": {
|
|
"shape": "Unit",
|
|
"locationName": "unit",
|
|
"documentation": "<p>The unit of measurement for the value specified by the value field.</p>"
|
|
},
|
|
"value": {
|
|
"shape": "__long",
|
|
"locationName": "value",
|
|
"documentation": "<p>The value for the metric specified by the UsageByAccount.type field in the response.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a current quota for an Amazon Macie account.</p>"
|
|
},
|
|
"ServiceQuotaExceededException": {
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape": "__string",
|
|
"locationName": "message",
|
|
"documentation": "<p>The explanation of the error that occurred.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an error that occurred due to one or more service quotas for an account.</p>",
|
|
"exception": true,
|
|
"error": {
|
|
"httpStatusCode": 402
|
|
}
|
|
},
|
|
"SessionContext": {
|
|
"type": "structure",
|
|
"members": {
|
|
"attributes": {
|
|
"shape": "SessionContextAttributes",
|
|
"locationName": "attributes",
|
|
"documentation": "<p>The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.</p>"
|
|
},
|
|
"sessionIssuer": {
|
|
"shape": "SessionIssuer",
|
|
"locationName": "sessionIssuer",
|
|
"documentation": "<p>The source and type of credentials that were issued to the entity.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about a session that was created for an entity that performed an action by using temporary security credentials.</p>"
|
|
},
|
|
"SessionContextAttributes": {
|
|
"type": "structure",
|
|
"members": {
|
|
"creationDate": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "creationDate",
|
|
"documentation": "<p>The date and time, in UTC and ISO 8601 format, when the credentials were issued.</p>"
|
|
},
|
|
"mfaAuthenticated": {
|
|
"shape": "__boolean",
|
|
"locationName": "mfaAuthenticated",
|
|
"documentation": "<p>Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the context in which temporary security credentials were issued to an entity.</p>"
|
|
},
|
|
"SessionIssuer": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account that owns the entity that was used to get the credentials.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.</p>"
|
|
},
|
|
"principalId": {
|
|
"shape": "__string",
|
|
"locationName": "principalId",
|
|
"documentation": "<p>The unique identifier for the entity that was used to get the credentials.</p>"
|
|
},
|
|
"type": {
|
|
"shape": "__string",
|
|
"locationName": "type",
|
|
"documentation": "<p>The source of the temporary security credentials, such as Root, IAMUser, or Role.</p>"
|
|
},
|
|
"userName": {
|
|
"shape": "__string",
|
|
"locationName": "userName",
|
|
"documentation": "<p>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.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the source and type of temporary security credentials that were issued to an entity.</p>"
|
|
},
|
|
"Severity": {
|
|
"type": "structure",
|
|
"members": {
|
|
"description": {
|
|
"shape": "SeverityDescription",
|
|
"locationName": "description",
|
|
"documentation": "<p>The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).</p>"
|
|
},
|
|
"score": {
|
|
"shape": "__long",
|
|
"locationName": "score",
|
|
"documentation": "<p>The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides the numerical and qualitative representations of a finding's severity.</p>"
|
|
},
|
|
"SeverityDescription": {
|
|
"type": "string",
|
|
"documentation": "<p>The qualitative representation of the finding's severity. Possible values are:</p>",
|
|
"enum": [
|
|
"Low",
|
|
"Medium",
|
|
"High"
|
|
]
|
|
},
|
|
"SharedAccess": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EXTERNAL",
|
|
"INTERNAL",
|
|
"NOT_SHARED",
|
|
"UNKNOWN"
|
|
]
|
|
},
|
|
"SimpleScopeTerm": {
|
|
"type": "structure",
|
|
"members": {
|
|
"comparator": {
|
|
"shape": "JobComparator",
|
|
"locationName": "comparator",
|
|
"documentation": "<p>The operator to use in the condition. Valid operators for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - EQ (equals) or NE (not equals)</p></li> <li><p>OBJECT_KEY - STARTS_WITH</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS</p></li> <li><p>OBJECT_SIZE - Any operator except CONTAINS</p></li> <li><p>TAG - EQ (equals) or NE (not equals)</p></li></ul>"
|
|
},
|
|
"key": {
|
|
"shape": "ScopeFilterKey",
|
|
"locationName": "key",
|
|
"documentation": "<p>The object property to use in the condition.</p>"
|
|
},
|
|
"values": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "values",
|
|
"documentation": "<p>An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses an OR operator to join the values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported property (key) are:</p> <ul><li><p>OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf</p></li> <li><p>OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.</p></li> <li><p>OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z</p></li> <li><p>OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.</p></li> <li><p>TAG - A string that represents a tag key for an object. For advanced options, use a TagScopeTerm object, instead of a SimpleScopeTerm object, to define a tag-based condition for the job.</p></li></ul> <p>Macie doesn't support use of wildcard characters in values. Also, string values are case sensitive.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a property-based condition that determines whether an object is included or excluded from a classification job.</p>"
|
|
},
|
|
"SortCriteria": {
|
|
"type": "structure",
|
|
"members": {
|
|
"attributeName": {
|
|
"shape": "__string",
|
|
"locationName": "attributeName",
|
|
"documentation": "<p>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.</p>"
|
|
},
|
|
"orderBy": {
|
|
"shape": "OrderBy",
|
|
"locationName": "orderBy",
|
|
"documentation": "<p>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.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies criteria for sorting the results of a request for findings.</p>"
|
|
},
|
|
"Statistics": {
|
|
"type": "structure",
|
|
"members": {
|
|
"approximateNumberOfObjectsToProcess": {
|
|
"shape": "__double",
|
|
"locationName": "approximateNumberOfObjectsToProcess",
|
|
"documentation": "<p>The approximate number of objects that the job has yet to process during its current run.</p>"
|
|
},
|
|
"numberOfRuns": {
|
|
"shape": "__double",
|
|
"locationName": "numberOfRuns",
|
|
"documentation": "<p>The number of times that the job has run.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides processing statistics for a classification job.</p>"
|
|
},
|
|
"StorageClass": {
|
|
"type": "string",
|
|
"documentation": "<p>The storage class of the S3 object. Possible values are:</p>",
|
|
"enum": [
|
|
"STANDARD",
|
|
"REDUCED_REDUNDANCY",
|
|
"STANDARD_IA",
|
|
"INTELLIGENT_TIERING",
|
|
"DEEP_ARCHIVE",
|
|
"ONEZONE_IA",
|
|
"GLACIER"
|
|
]
|
|
},
|
|
"TagMap": {
|
|
"type": "map",
|
|
"documentation": "<p>A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.</p>",
|
|
"key": {
|
|
"shape": "__string"
|
|
},
|
|
"value": {
|
|
"shape": "__string"
|
|
}
|
|
},
|
|
"TagResourceRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"resourceArn": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "resourceArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.</p>"
|
|
},
|
|
"tags": {
|
|
"shape": "TagMap",
|
|
"locationName": "tags",
|
|
"documentation": "<p>A map of key-value pairs that specifies the tags to associate with the resource.</p> <p>A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"resourceArn",
|
|
"tags"
|
|
]
|
|
},
|
|
"TagResourceResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"TagScopeTerm": {
|
|
"type": "structure",
|
|
"members": {
|
|
"comparator": {
|
|
"shape": "JobComparator",
|
|
"locationName": "comparator",
|
|
"documentation": "<p>The operator to use in the condition. Valid operators are EQ (equals) or NE (not equals).</p>"
|
|
},
|
|
"key": {
|
|
"shape": "__string",
|
|
"locationName": "key",
|
|
"documentation": "<p>The tag key to use in the condition.</p>"
|
|
},
|
|
"tagValues": {
|
|
"shape": "__listOfTagValuePair",
|
|
"locationName": "tagValues",
|
|
"documentation": "<p>The tag keys or tag key and value pairs to use in the condition.</p>"
|
|
},
|
|
"target": {
|
|
"shape": "TagTarget",
|
|
"locationName": "target",
|
|
"documentation": "<p>The type of object to apply the condition to.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a tag-based condition that determines whether an object is included or excluded from a classification job.</p>"
|
|
},
|
|
"TagTarget": {
|
|
"type": "string",
|
|
"documentation": "<p>The type of object to apply a tag-based condition to. Valid values are:</p>",
|
|
"enum": [
|
|
"S3_OBJECT"
|
|
]
|
|
},
|
|
"TagValuePair": {
|
|
"type": "structure",
|
|
"members": {
|
|
"key": {
|
|
"shape": "__string",
|
|
"locationName": "key",
|
|
"documentation": "<p>The value for the tag key to use in the condition.</p>"
|
|
},
|
|
"value": {
|
|
"shape": "__string",
|
|
"locationName": "value",
|
|
"documentation": "<p>The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a tag key or tag key and value pair to use in a tag-based condition for a classification job.</p>"
|
|
},
|
|
"TestCustomDataIdentifierRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"ignoreWords": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "ignoreWords",
|
|
"documentation": "<p>An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.</p>"
|
|
},
|
|
"keywords": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "keywords",
|
|
"documentation": "<p>An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters. Keywords aren't case sensitive.</p>"
|
|
},
|
|
"maximumMatchDistance": {
|
|
"shape": "__integer",
|
|
"locationName": "maximumMatchDistance",
|
|
"documentation": "<p>The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.</p>"
|
|
},
|
|
"regex": {
|
|
"shape": "__string",
|
|
"locationName": "regex",
|
|
"documentation": "<p>The regular expression (<i>regex</i>) that defines the pattern to match. The expression can contain as many as 512 characters.</p>"
|
|
},
|
|
"sampleText": {
|
|
"shape": "__string",
|
|
"locationName": "sampleText",
|
|
"documentation": "<p>The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"regex",
|
|
"sampleText"
|
|
]
|
|
},
|
|
"TestCustomDataIdentifierResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"matchCount": {
|
|
"shape": "__integer",
|
|
"locationName": "matchCount",
|
|
"documentation": "<p>The number of instances of sample text that matched the detection criteria specified in the custom data identifier.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ThrottlingException": {
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape": "__string",
|
|
"locationName": "message",
|
|
"documentation": "<p>The explanation of the error that occurred.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an error that occurred because too many requests were sent during a certain amount of time.</p>",
|
|
"exception": true,
|
|
"error": {
|
|
"httpStatusCode": 429
|
|
}
|
|
},
|
|
"TimeRange": {
|
|
"type": "string",
|
|
"documentation": "<p>An inclusive time period that Amazon Macie usage data applies to. Possible values are:</p>",
|
|
"enum": [
|
|
"MONTH_TO_DATE",
|
|
"PAST_30_DAYS"
|
|
]
|
|
},
|
|
"Type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE",
|
|
"AES256",
|
|
"aws:kms"
|
|
]
|
|
},
|
|
"Unit": {
|
|
"type": "string",
|
|
"enum": [
|
|
"TERABYTES"
|
|
]
|
|
},
|
|
"UnprocessedAccount": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The AWS account ID for the account that the request applies to.</p>"
|
|
},
|
|
"errorCode": {
|
|
"shape": "ErrorCode",
|
|
"locationName": "errorCode",
|
|
"documentation": "<p>The source of the issue or delay in processing the request.</p>"
|
|
},
|
|
"errorMessage": {
|
|
"shape": "__string",
|
|
"locationName": "errorMessage",
|
|
"documentation": "<p>The reason why the request hasn't been processed.</p>"
|
|
}
|
|
},
|
|
"documentation": " <p>Provides information about an account-related request that hasn't been processed.</p>"
|
|
},
|
|
"UntagResourceRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"resourceArn": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "resourceArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.</p>"
|
|
},
|
|
"tagKeys": {
|
|
"shape": "__listOf__string",
|
|
"location": "querystring",
|
|
"locationName": "tagKeys",
|
|
"documentation": "<p>The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"tagKeys",
|
|
"resourceArn"
|
|
]
|
|
},
|
|
"UntagResourceResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"UpdateClassificationJobRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"jobId": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "jobId",
|
|
"documentation": "<p>The unique identifier for the classification job.</p>"
|
|
},
|
|
"jobStatus": {
|
|
"shape": "JobStatus",
|
|
"locationName": "jobStatus",
|
|
"documentation": "<p>The new status for the job. Valid values are:</p> <ul><li><p>CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.</p> <p>If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.</p></li> <li><p>RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.</p> <p>If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.</p></li> <li><p>USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.</p> <p>If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>"
|
|
}
|
|
},
|
|
"required": [
|
|
"jobId",
|
|
"jobStatus"
|
|
]
|
|
},
|
|
"UpdateClassificationJobResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"UpdateFindingsFilterRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"action": {
|
|
"shape": "FindingsFilterAction",
|
|
"locationName": "action",
|
|
"documentation": "<p>The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.</p>"
|
|
},
|
|
"description": {
|
|
"shape": "__string",
|
|
"locationName": "description",
|
|
"documentation": "<p>A custom description of the filter. The description can contain as many as 512 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.</p>"
|
|
},
|
|
"findingCriteria": {
|
|
"shape": "FindingCriteria",
|
|
"locationName": "findingCriteria",
|
|
"documentation": "<p>The criteria to use to filter findings.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
},
|
|
"name": {
|
|
"shape": "__string",
|
|
"locationName": "name",
|
|
"documentation": "<p>A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.</p>"
|
|
},
|
|
"position": {
|
|
"shape": "__integer",
|
|
"locationName": "position",
|
|
"documentation": "<p>The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"UpdateFindingsFilterResponse": {
|
|
"type": "structure",
|
|
"members": {
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the filter that was updated.</p>"
|
|
},
|
|
"id": {
|
|
"shape": "__string",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the filter that was updated.</p>"
|
|
}
|
|
}
|
|
},
|
|
"UpdateMacieSessionRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"findingPublishingFrequency": {
|
|
"shape": "FindingPublishingFrequency",
|
|
"locationName": "findingPublishingFrequency",
|
|
"documentation": "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events)."
|
|
},
|
|
"status": {
|
|
"shape": "MacieStatus",
|
|
"locationName": "status",
|
|
"documentation": "<p>Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>"
|
|
}
|
|
}
|
|
},
|
|
"UpdateMacieSessionResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"UpdateMemberSessionRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"id": {
|
|
"shape": "__string",
|
|
"location": "uri",
|
|
"locationName": "id",
|
|
"documentation": "<p>The unique identifier for the Amazon Macie resource or account that the request applies to.</p>"
|
|
},
|
|
"status": {
|
|
"shape": "MacieStatus",
|
|
"locationName": "status",
|
|
"documentation": "<p>Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"status"
|
|
]
|
|
},
|
|
"UpdateMemberSessionResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"UpdateOrganizationConfigurationRequest": {
|
|
"type": "structure",
|
|
"members": {
|
|
"autoEnable": {
|
|
"shape": "__boolean",
|
|
"locationName": "autoEnable",
|
|
"documentation": "<p>Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the AWS organization.</p>"
|
|
}
|
|
},
|
|
"required": [
|
|
"autoEnable"
|
|
]
|
|
},
|
|
"UpdateOrganizationConfigurationResponse": {
|
|
"type": "structure",
|
|
"members": {}
|
|
},
|
|
"UsageByAccount": {
|
|
"type": "structure",
|
|
"members": {
|
|
"currency": {
|
|
"shape": "Currency",
|
|
"locationName": "currency",
|
|
"documentation": "<p>The type of currency that the value for the metric (estimatedCost) is reported in.</p>"
|
|
},
|
|
"estimatedCost": {
|
|
"shape": "__string",
|
|
"locationName": "estimatedCost",
|
|
"documentation": "<p>The estimated value for the metric.</p>"
|
|
},
|
|
"serviceLimit": {
|
|
"shape": "ServiceLimit",
|
|
"locationName": "serviceLimit",
|
|
"documentation": "<p>The current value for the quota that corresponds to the metric specified by the type field.</p>"
|
|
},
|
|
"type": {
|
|
"shape": "UsageType",
|
|
"locationName": "type",
|
|
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides data for a specific usage metric and the corresponding quota for an Amazon Macie account.</p>"
|
|
},
|
|
"UsageRecord": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account that the data applies to.</p>"
|
|
},
|
|
"freeTrialStartDate": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "freeTrialStartDate",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the free trial started for the account.</p>"
|
|
},
|
|
"usage": {
|
|
"shape": "__listOfUsageByAccount",
|
|
"locationName": "usage",
|
|
"documentation": "<p>An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides quota and aggregated usage data for an Amazon Macie account.</p>"
|
|
},
|
|
"UsageStatisticsFilter": {
|
|
"type": "structure",
|
|
"members": {
|
|
"comparator": {
|
|
"shape": "UsageStatisticsFilterComparator",
|
|
"locationName": "comparator",
|
|
"documentation": "<p>The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.</p>"
|
|
},
|
|
"key": {
|
|
"shape": "UsageStatisticsFilterKey",
|
|
"locationName": "key",
|
|
"documentation": "<p>The field to use in the condition.</p>"
|
|
},
|
|
"values": {
|
|
"shape": "__listOf__string",
|
|
"locationName": "values",
|
|
"documentation": "<p>An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported field are:</p> <ul><li><p>accountId - The unique identifier for an AWS account.</p></li></ul> <ul><li><p>freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.</p></li></ul> <ul><li><p>serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.</p></li></ul> <ul><li><p>total - A string that represents the current estimated cost for an account.</p></li></ul>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.</p>"
|
|
},
|
|
"UsageStatisticsFilterComparator": {
|
|
"type": "string",
|
|
"documentation": "<p>The operator to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
|
|
"enum": [
|
|
"GT",
|
|
"GTE",
|
|
"LT",
|
|
"LTE",
|
|
"EQ",
|
|
"NE",
|
|
"CONTAINS"
|
|
]
|
|
},
|
|
"UsageStatisticsFilterKey": {
|
|
"type": "string",
|
|
"documentation": "<p>The field to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
|
|
"enum": [
|
|
"accountId",
|
|
"serviceLimit",
|
|
"freeTrialStartDate",
|
|
"total"
|
|
]
|
|
},
|
|
"UsageStatisticsSortBy": {
|
|
"type": "structure",
|
|
"members": {
|
|
"key": {
|
|
"shape": "UsageStatisticsSortKey",
|
|
"locationName": "key",
|
|
"documentation": "<p>The field to sort the results by.</p>"
|
|
},
|
|
"orderBy": {
|
|
"shape": "OrderBy",
|
|
"locationName": "orderBy",
|
|
"documentation": "<p>The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies criteria for sorting the results of a query for Amazon Macie account quotas and usage data.</p>"
|
|
},
|
|
"UsageStatisticsSortKey": {
|
|
"type": "string",
|
|
"documentation": "<p>The field to use to sort the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
|
|
"enum": [
|
|
"accountId",
|
|
"total",
|
|
"serviceLimitValue",
|
|
"freeTrialStartDate"
|
|
]
|
|
},
|
|
"UsageTotal": {
|
|
"type": "structure",
|
|
"members": {
|
|
"currency": {
|
|
"shape": "Currency",
|
|
"locationName": "currency",
|
|
"documentation": "<p>The type of currency that the value for the metric (estimatedCost) is reported in.</p>"
|
|
},
|
|
"estimatedCost": {
|
|
"shape": "__string",
|
|
"locationName": "estimatedCost",
|
|
"documentation": "<p>The estimated value for the metric.</p>"
|
|
},
|
|
"type": {
|
|
"shape": "UsageType",
|
|
"locationName": "type",
|
|
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.</p>"
|
|
},
|
|
"UsageType": {
|
|
"type": "string",
|
|
"documentation": "<p>The name of an Amazon Macie usage metric for an account. Possible values are:</p>",
|
|
"enum": [
|
|
"DATA_INVENTORY_EVALUATION",
|
|
"SENSITIVE_DATA_DISCOVERY"
|
|
]
|
|
},
|
|
"UserIdentity": {
|
|
"type": "structure",
|
|
"members": {
|
|
"assumedRole": {
|
|
"shape": "AssumedRole",
|
|
"locationName": "assumedRole",
|
|
"documentation": "<p>If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.</p>"
|
|
},
|
|
"awsAccount": {
|
|
"shape": "AwsAccount",
|
|
"locationName": "awsAccount",
|
|
"documentation": "<p>If the action was performed using the credentials for another AWS account, the details of that account.</p>"
|
|
},
|
|
"awsService": {
|
|
"shape": "AwsService",
|
|
"locationName": "awsService",
|
|
"documentation": "<p>If the action was performed by an AWS account that belongs to an AWS service, the name of the service.</p>"
|
|
},
|
|
"federatedUser": {
|
|
"shape": "FederatedUser",
|
|
"locationName": "federatedUser",
|
|
"documentation": "<p>If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.</p>"
|
|
},
|
|
"iamUser": {
|
|
"shape": "IamUser",
|
|
"locationName": "iamUser",
|
|
"documentation": "<p>If the action was performed using the credentials for an AWS Identity and Access Management (IAM) user, the name and other details about the user.</p>"
|
|
},
|
|
"root": {
|
|
"shape": "UserIdentityRoot",
|
|
"locationName": "root",
|
|
"documentation": "<p>If the action was performed using the credentials for your AWS account, the details of your account.</p>"
|
|
},
|
|
"type": {
|
|
"shape": "UserIdentityType",
|
|
"locationName": "type",
|
|
"documentation": "<p>The type of entity that performed the action.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about the type and other characteristics of an entity that performed an action on an affected resource.</p>"
|
|
},
|
|
"UserIdentityRoot": {
|
|
"type": "structure",
|
|
"members": {
|
|
"accountId": {
|
|
"shape": "__string",
|
|
"locationName": "accountId",
|
|
"documentation": "<p>The unique identifier for the AWS account.</p>"
|
|
},
|
|
"arn": {
|
|
"shape": "__string",
|
|
"locationName": "arn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.</p>"
|
|
},
|
|
"principalId": {
|
|
"shape": "__string",
|
|
"locationName": "principalId",
|
|
"documentation": "<p>The unique identifier for the entity that performed the action.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for your AWS account.</p>"
|
|
},
|
|
"UserIdentityType": {
|
|
"type": "string",
|
|
"documentation": "<p>The type of entity that performed the action on the affected resource. Possible values are:</p>",
|
|
"enum": [
|
|
"AssumedRole",
|
|
"IAMUser",
|
|
"FederatedUser",
|
|
"Root",
|
|
"AWSAccount",
|
|
"AWSService"
|
|
]
|
|
},
|
|
"UserPausedDetails": {
|
|
"type": "structure",
|
|
"members": {
|
|
"jobExpiresAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "jobExpiresAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.</p>"
|
|
},
|
|
"jobImminentExpirationHealthEventArn": {
|
|
"shape": "__string",
|
|
"locationName": "jobImminentExpirationHealthEventArn",
|
|
"documentation": "<p>The Amazon Resource Name (ARN) of the AWS Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.</p>"
|
|
},
|
|
"jobPausedAt": {
|
|
"shape": "__timestampIso8601",
|
|
"locationName": "jobPausedAt",
|
|
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when you paused the job.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn't resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.</p>"
|
|
},
|
|
"ValidationException": {
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape": "__string",
|
|
"locationName": "message",
|
|
"documentation": "<p>The explanation of the error that occurred.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Provides information about an error that occurred due to a syntax error in a request.</p>",
|
|
"exception": true,
|
|
"error": {
|
|
"httpStatusCode": 400
|
|
}
|
|
},
|
|
"WeeklySchedule": {
|
|
"type": "structure",
|
|
"members": {
|
|
"dayOfWeek": {
|
|
"shape": "DayOfWeek",
|
|
"locationName": "dayOfWeek",
|
|
"documentation": "<p>The day of the week when Amazon Macie runs the job.</p>"
|
|
}
|
|
},
|
|
"documentation": "<p>Specifies a weekly recurrence pattern for running a classification job.</p>"
|
|
},
|
|
"__boolean": {
|
|
"type": "boolean"
|
|
},
|
|
"__double": {
|
|
"type": "double"
|
|
},
|
|
"__integer": {
|
|
"type": "integer"
|
|
},
|
|
"__listOfAdminAccount": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "AdminAccount"
|
|
}
|
|
},
|
|
"__listOfBatchGetCustomDataIdentifierSummary": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "BatchGetCustomDataIdentifierSummary"
|
|
}
|
|
},
|
|
"__listOfBucketMetadata": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "BucketMetadata"
|
|
}
|
|
},
|
|
"__listOfCustomDataIdentifierSummary": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "CustomDataIdentifierSummary"
|
|
}
|
|
},
|
|
"__listOfFinding": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "Finding"
|
|
}
|
|
},
|
|
"__listOfFindingType": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "FindingType"
|
|
}
|
|
},
|
|
"__listOfFindingsFilterListItem": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "FindingsFilterListItem"
|
|
}
|
|
},
|
|
"__listOfGroupCount": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "GroupCount"
|
|
}
|
|
},
|
|
"__listOfInvitation": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "Invitation"
|
|
}
|
|
},
|
|
"__listOfJobScopeTerm": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "JobScopeTerm"
|
|
}
|
|
},
|
|
"__listOfJobSummary": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "JobSummary"
|
|
}
|
|
},
|
|
"__listOfKeyValuePair": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "KeyValuePair"
|
|
}
|
|
},
|
|
"__listOfListJobsFilterTerm": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "ListJobsFilterTerm"
|
|
}
|
|
},
|
|
"__listOfMember": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "Member"
|
|
}
|
|
},
|
|
"__listOfS3BucketDefinitionForJob": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "S3BucketDefinitionForJob"
|
|
}
|
|
},
|
|
"__listOfTagValuePair": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "TagValuePair"
|
|
}
|
|
},
|
|
"__listOfUnprocessedAccount": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "UnprocessedAccount"
|
|
}
|
|
},
|
|
"__listOfUsageByAccount": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "UsageByAccount"
|
|
}
|
|
},
|
|
"__listOfUsageRecord": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "UsageRecord"
|
|
}
|
|
},
|
|
"__listOfUsageStatisticsFilter": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "UsageStatisticsFilter"
|
|
}
|
|
},
|
|
"__listOfUsageTotal": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "UsageTotal"
|
|
}
|
|
},
|
|
"__listOf__string": {
|
|
"type": "list",
|
|
"member": {
|
|
"shape": "__string"
|
|
}
|
|
},
|
|
"__long": {
|
|
"type": "long"
|
|
},
|
|
"__string": {
|
|
"type": "string"
|
|
},
|
|
"__timestampIso8601": {
|
|
"type": "timestamp",
|
|
"timestampFormat": "iso8601"
|
|
},
|
|
"__timestampUnix": {
|
|
"type": "timestamp",
|
|
"timestampFormat": "unixTimestamp"
|
|
}
|
|
},
|
|
"documentation": "<p>Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.</p>"
|
|
} |