get-anomalies¶

Description¶

Retrieves all of the cost anomalies detected on your account during the time period that’s specified by the DateInterval object. Anomalies are available for up to 90 days.

Synopsis¶

  get-anomalies
[--monitor-arn <value>]
--date-interval <value>
[--feedback <value>]
[--total-impact <value>]
[--next-page-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--monitor-arn (string)

Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN).

--date-interval (structure)

Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an AnomalyEndDate in the specified time range.

StartDate -> (string)

The first date an anomaly was observed.

EndDate -> (string)

The last date an anomaly was observed.

Shorthand Syntax:

StartDate=string,EndDate=string

JSON Syntax:

{
  "StartDate": "string",
  "EndDate": "string"
}

--feedback (string)

Filters anomaly results by the feedback field on the anomaly object.

Possible values:

YES

NO

PLANNED_ACTIVITY

--total-impact (structure)

Filters anomaly results by the total impact field on the anomaly object. For example, you can filter anomalies GREATER_THAN 200.00 to retrieve anomalies, with an estimated dollar impact greater than 200.

NumericOperator -> (string)

The comparing value that’s used in the filter.

StartValue -> (double)

The lower bound dollar value that’s used in the filter.

EndValue -> (double)

The upper bound dollar value that’s used in the filter.

Shorthand Syntax:

NumericOperator=string,StartValue=double,EndValue=double

JSON Syntax:

{
  "NumericOperator": "EQUAL"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"GREATER_THAN"|"LESS_THAN"|"BETWEEN",
  "StartValue": double,
  "EndValue": double
}

--next-page-token (string)

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

--max-results (integer)

The number of entries a paginated response contains.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

Anomalies -> (list)

A list of cost anomalies.

(structure)

An unusual cost pattern. This consists of the detailed metadata and the current status of the anomaly object.

AnomalyId -> (string)

The unique identifier for the anomaly.

AnomalyStartDate -> (string)

The first day the anomaly is detected.

AnomalyEndDate -> (string)

The last day the anomaly is detected.

DimensionValue -> (string)

The dimension for the anomaly (for example, an Amazon Web Services service in a service monitor).

RootCauses -> (list)

The list of identified root causes for the anomaly.

(structure)

The combination of Amazon Web Services service, linked account, linked account name, Region, and usage type where a cost anomaly is observed, along with the dollar and percentage amount of the anomaly impact. The linked account name will only be available when the account name can be identified.

Service -> (string)

The Amazon Web Services service name that’s associated with the cost anomaly.

Region -> (string)

The Amazon Web Services Region that’s associated with the cost anomaly.

LinkedAccount -> (string)

The member account value that’s associated with the cost anomaly.

LinkedAccountName -> (string)

The member account name value that’s associated with the cost anomaly.

UsageType -> (string)

The UsageType value that’s associated with the cost anomaly.

Impact -> (structure)

The dollar impact for the root cause.

Contribution -> (double)

The dollar amount that this root cause contributed to the anomaly’s TotalImpact.

AnomalyScore -> (structure)

The latest and maximum score for the anomaly.

MaxScore -> (double)

The maximum score that’s observed during the AnomalyDateInterval .

CurrentScore -> (double)

The last observed score.

Impact -> (structure)

The dollar impact for the anomaly.

MaxImpact -> (double)

The maximum dollar value that’s observed for an anomaly.

TotalImpact -> (double)

The cumulative dollar difference between the total actual spend and total expected spend. It is calculated as TotalActualSpend - TotalExpectedSpend .

TotalActualSpend -> (double)

The cumulative dollar amount that was actually spent during the anomaly.

TotalExpectedSpend -> (double)

The cumulative dollar amount that was expected to be spent during the anomaly. It is calculated using advanced machine learning models to determine the typical spending pattern based on historical data for a customer.

TotalImpactPercentage -> (double)

The cumulative percentage difference between the total actual spend and total expected spend. It is calculated as (TotalImpact / TotalExpectedSpend) * 100 . When TotalExpectedSpend is zero, this field is omitted. Expected spend can be zero in situations such as when you start to use a service for the first time.

MonitorArn -> (string)

The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.

Feedback -> (string)

The feedback value.

NextPageToken -> (string)