Usage Totals - Amazon Macie

Usage Totals

The Usage Totals resource provides aggregated usage data for your account. This data can provide insight into the estimated cost of using Amazon Macie to monitor and analyze sensitive data for your account during the past 30 days.

You can use this resource to retrieve (query) aggregated usage data for your Macie account during the past 30 days. For a master account, the data reports cumulative usage for all the accounts in your organization. To query additional usage-related data or build a custom query for a select set of accounts, use the Usage Statistics resource.

URI

/usage

HTTP Methods

GET

Operation ID: GetUsageTotals

Retrieves (queries) aggregated usage data for an account.

Responses
Status Code Response Model Description
200 GetUsageTotalsResponse

The request succeeded.

400 ValidationException

The request failed because it contains a syntax error.

402 ServiceQuotaExceededException

The request failed because fulfilling the request would exceed one or more service quotas for your account.

403 AccessDeniedException

The request was denied because you don't have sufficient access to the specified resource.

404 ResourceNotFoundException

The request failed because the specified resource wasn't found.

409 ConflictException

The request failed because it conflicts with the current state of the specified resource.

429 ThrottlingException

The request failed because you sent too many requests during a certain amount of time.

500 InternalServerException

The request failed due to an unknown internal server error, exception, or failure.

Schemas

Response Bodies

Example GetUsageTotalsResponse

{ "usageTotals": [ { "currency": enum, "estimatedCost": "string", "type": enum } ] }

Example ValidationException

{ "message": "string" }

Example ServiceQuotaExceededException

{ "message": "string" }

Example AccessDeniedException

{ "message": "string" }

Example ResourceNotFoundException

{ "message": "string" }

Example ConflictException

{ "message": "string" }

Example ThrottlingException

{ "message": "string" }

Example InternalServerException

{ "message": "string" }

Properties

AccessDeniedException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

ConflictException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

Currency

The type of currency that data for a usage metric is reported in. Possible values are:

  • USD

GetUsageTotalsResponse

Provides the results of a query that retrieved aggregated usage data for an account during the past 30 days.

Property Type Required Description
usageTotals

Array of type UsageTotal

False

An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

InternalServerException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

ResourceNotFoundException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

ServiceQuotaExceededException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

ThrottlingException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

UsageTotal

Provides aggregated data for a usage metric. The value for the metric reports usage data for an account during the past 30 days.

Property Type Required Description
currency

Currency

False

The type of currency that the value for the metric (estimatedCost) is reported in.

estimatedCost

string

False

The estimated value for the metric.

type

UsageType

False

The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing sensitive data.

UsageType

The name of a usage metric for an account. Possible values are:

  • DATA_INVENTORY_EVALUATION

  • SENSITIVE_DATA_DISCOVERY

ValidationException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetUsageTotals