Cost Explorer
This page documents function available when using the Cost_Explorer
module, created with @service Cost_Explorer
.
Index
Main.Cost_Explorer.create_anomaly_monitor
Main.Cost_Explorer.create_anomaly_subscription
Main.Cost_Explorer.create_cost_category_definition
Main.Cost_Explorer.delete_anomaly_monitor
Main.Cost_Explorer.delete_anomaly_subscription
Main.Cost_Explorer.delete_cost_category_definition
Main.Cost_Explorer.describe_cost_category_definition
Main.Cost_Explorer.get_anomalies
Main.Cost_Explorer.get_anomaly_monitors
Main.Cost_Explorer.get_anomaly_subscriptions
Main.Cost_Explorer.get_cost_and_usage
Main.Cost_Explorer.get_cost_and_usage_with_resources
Main.Cost_Explorer.get_cost_categories
Main.Cost_Explorer.get_cost_forecast
Main.Cost_Explorer.get_dimension_values
Main.Cost_Explorer.get_reservation_coverage
Main.Cost_Explorer.get_reservation_purchase_recommendation
Main.Cost_Explorer.get_reservation_utilization
Main.Cost_Explorer.get_rightsizing_recommendation
Main.Cost_Explorer.get_savings_plans_coverage
Main.Cost_Explorer.get_savings_plans_purchase_recommendation
Main.Cost_Explorer.get_savings_plans_utilization
Main.Cost_Explorer.get_savings_plans_utilization_details
Main.Cost_Explorer.get_tags
Main.Cost_Explorer.get_usage_forecast
Main.Cost_Explorer.list_cost_category_definitions
Main.Cost_Explorer.provide_anomaly_feedback
Main.Cost_Explorer.update_anomaly_monitor
Main.Cost_Explorer.update_anomaly_subscription
Main.Cost_Explorer.update_cost_category_definition
Documentation
Main.Cost_Explorer.create_anomaly_monitor
— Methodcreate_anomaly_monitor(anomaly_monitor)
create_anomaly_monitor(anomaly_monitor, params::Dict{String,<:Any})
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
Arguments
anomaly_monitor
: The cost anomaly detection monitor object that you want to create.
Main.Cost_Explorer.create_anomaly_subscription
— Methodcreate_anomaly_subscription(anomaly_subscription)
create_anomaly_subscription(anomaly_subscription, params::Dict{String,<:Any})
Adds a subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set a dollar threshold and a time frequency for receiving notifications.
Arguments
anomaly_subscription
: The cost anomaly subscription object that you want to create.
Main.Cost_Explorer.create_cost_category_definition
— Methodcreate_cost_category_definition(name, rule_version, rules)
create_cost_category_definition(name, rule_version, rules, params::Dict{String,<:Any})
Creates a new Cost Category with the requested name and rules.
Arguments
name
:rule_version
:rules
: The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DefaultValue"
:
Main.Cost_Explorer.delete_anomaly_monitor
— Methoddelete_anomaly_monitor(monitor_arn)
delete_anomaly_monitor(monitor_arn, params::Dict{String,<:Any})
Deletes a cost anomaly monitor.
Arguments
monitor_arn
: The unique identifier of the cost anomaly monitor that you want to delete.
Main.Cost_Explorer.delete_anomaly_subscription
— Methoddelete_anomaly_subscription(subscription_arn)
delete_anomaly_subscription(subscription_arn, params::Dict{String,<:Any})
Deletes a cost anomaly subscription.
Arguments
subscription_arn
: The unique identifier of the cost anomaly subscription that you want to delete.
Main.Cost_Explorer.delete_cost_category_definition
— Methoddelete_cost_category_definition(cost_category_arn)
delete_cost_category_definition(cost_category_arn, params::Dict{String,<:Any})
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
Arguments
cost_category_arn
: The unique identifier for your Cost Category.
Main.Cost_Explorer.describe_cost_category_definition
— Methoddescribe_cost_category_definition(cost_category_arn)
describe_cost_category_definition(cost_category_arn, params::Dict{String,<:Any})
Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account. You have the option to use EffectiveOn to return a Cost Category that is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.
Arguments
cost_category_arn
: The unique identifier for your Cost Category.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"EffectiveOn"
: The date when the Cost Category was effective.
Main.Cost_Explorer.get_anomalies
— Methodget_anomalies(date_interval)
get_anomalies(date_interval, params::Dict{String,<:Any})
Retrieves all of the cost anomalies detected on your account, during the time period specified by the DateInterval object.
Arguments
date_interval
: Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an AnomalyEndDate in the specified time range.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Feedback"
: Filters anomaly results by the feedback field on the anomaly object."MaxResults"
: The number of entries a paginated response contains."MonitorArn"
: Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN)."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size."TotalImpact"
: 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.
Main.Cost_Explorer.get_anomaly_monitors
— Methodget_anomaly_monitors()
get_anomaly_monitors(params::Dict{String,<:Any})
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
: The number of entries a paginated response contains."MonitorArnList"
: A list of cost anomaly monitor ARNs."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
Main.Cost_Explorer.get_anomaly_subscriptions
— Methodget_anomaly_subscriptions()
get_anomaly_subscriptions(params::Dict{String,<:Any})
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
: The number of entries a paginated response contains."MonitorArn"
: Cost anomaly monitor ARNs."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size."SubscriptionArnList"
: A list of cost anomaly subscription ARNs.
Main.Cost_Explorer.get_cost_and_usage
— Methodget_cost_and_usage(granularity, metrics, time_period)
get_cost_and_usage(granularity, metrics, time_period, params::Dict{String,<:Any})
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in AWS Organizations have access to all member accounts. For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
Arguments
granularity
: Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.metrics
: Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity. If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups. Metrics is required for GetCostAndUsage requests.time_period
: Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression."GroupBy"
: You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types. When you group by tag key, you get all tag values, including empty strings. Valid values are AZ, INSTANCETYPE, LEGALENTITYNAME, LINKEDACCOUNT, OPERATION, PLATFORM, PURCHASETYPE, SERVICE, TAGS, TENANCY, RECORDTYPE, and USAGE_TYPE."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
Main.Cost_Explorer.get_cost_and_usage_with_resources
— Methodget_cost_and_usage_with_resources(filter, granularity, time_period)
get_cost_and_usage_with_resources(filter, granularity, time_period, params::Dict{String,<:Any})
Retrieves cost and usage metrics with resources for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in AWS Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only. This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.
Arguments
filter
: Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression. The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId. It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.granularity
: Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, MONTHLY, DAILY, or HOURLY.time_period
: Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days (the start date cannot be earlier than 14 days ago). The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"GroupBy"
: You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY."Metrics"
: Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity. If you return the UsageQuantity metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups. Metrics is required for GetCostAndUsageWithResources requests."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
Main.Cost_Explorer.get_cost_categories
— Methodget_cost_categories(time_period)
get_cost_categories(time_period, params::Dict{String,<:Any})
Retrieves an array of Cost Category names and values incurred cost. If some Cost Category names and values are not associated with any cost, they will not be returned by this API.
Arguments
time_period
:
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CostCategoryName"
:"Filter"
:"MaxResults"
: This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter. For GetCostCategories, MaxResults has an upper limit of 1000."NextPageToken"
: If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request."SearchString"
: The value that you want to search the filter values for. If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern."SortBy"
: The value by which you want to sort the data. The key represents cost and usage metrics. The following values are supported: BlendedCost UnblendedCost AmortizedCost NetAmortizedCost NetUnblendedCost UsageQuantity NormalizedUsageAmount Supported values for SortOrder are ASCENDING or DESCENDING. When using SortBy, NextPageToken and SearchString are not supported.
Main.Cost_Explorer.get_cost_forecast
— Methodget_cost_forecast(granularity, metric, time_period)
get_cost_forecast(granularity, metric, time_period, params::Dict{String,<:Any})
Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
Arguments
granularity
: How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts. The GetCostForecast operation supports only DAILY and MONTHLY granularities.metric
: Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?. Valid values for a GetCostForecast call are the following: AMORTIZEDCOST BLENDEDCOST NETAMORTIZEDCOST NETUNBLENDEDCOST UNBLENDED_COSTtime_period
: The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions: AZ INSTANCETYPE LINKEDACCOUNT LINKEDACCOUNTNAME OPERATION PURCHASETYPE REGION SERVICE USAGETYPE USAGETYPEGROUP RECORDTYPE OPERATINGSYSTEM TENANCY SCOPE PLATFORM SUBSCRIPTIONID LEGALENTITYNAME DEPLOYMENTOPTION DATABASEENGINE INSTANCETYPEFAMILY BILLINGENTITY RESERVATIONID SAVINGSPLAN_ARN"PredictionIntervalLevel"
: Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
Main.Cost_Explorer.get_dimension_values
— Methodget_dimension_values(dimension, time_period)
get_dimension_values(dimension, time_period, params::Dict{String,<:Any})
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
Arguments
dimension
: The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.time_period
: The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Context"
: The context for the call to GetDimensionValues. This can be RESERVATIONS or COSTANDUSAGE. The default value is COSTANDUSAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COSTANDUSAGE, the resulting dimension values can be used in the GetCostAndUsage operation. If you set the context to COSTANDUSAGE, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. DATABASEENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. INSTANCETYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LEGALENTITYNAME - The name of the organization that sells you AWS services, such as Amazon Web Services. LINKEDACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account. OPERATINGSYSTEM - The operating system. Examples are Windows or Linux. OPERATION - The action performed. Examples include RunInstance and CreateBucket. PLATFORM- The Amazon EC2 operating system. Examples are Windows or Linux. PURCHASE_TYPE - The
"Filter"
:"MaxResults"
: This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter. For GetDimensionValues, MaxResults has an upper limit of 1000."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size."SearchString"
: The value that you want to search the filter values for."SortBy"
: The value by which you want to sort the data. The key represents cost and usage metrics. The following values are supported: BlendedCost UnblendedCost AmortizedCost NetAmortizedCost NetUnblendedCost UsageQuantity NormalizedUsageAmount Supported values for SortOrder are ASCENDING or DESCENDING. When you specify a SortBy paramater, the context must be COSTANDUSAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.
Main.Cost_Explorer.get_reservation_coverage
— Methodget_reservation_coverage(time_period)
get_reservation_coverage(time_period, params::Dict{String,<:Any})
Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data about reservation usage by the following dimensions: AZ CACHEENGINE DATABASEENGINE DEPLOYMENTOPTION INSTANCETYPE LINKEDACCOUNT OPERATINGSYSTEM PLATFORM REGION SERVICE TAG TENANCY To determine valid values for a dimension, use the GetDimensionValues operation.
Arguments
time_period
: The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHEENGINE DATABASEENGINE DEPLOYMENTOPTION INSTANCETYPE LINKEDACCOUNT OPERATINGSYSTEM PLATFORM REGION SERVICE TAG TENANCY GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together. If you don't provide a SERVICE filter, Cost Explorer defaults to EC2. Cost category is also supported."Granularity"
: The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY. If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. The GetReservationCoverage operation supports only DAILY and MONTHLY granularities."GroupBy"
: You can group the data by the following attributes: AZ CACHEENGINE DATABASEENGINE DEPLOYMENTOPTION INSTANCETYPE LINKEDACCOUNT OPERATINGSYSTEM PLATFORM REGION TENANCY"MaxResults"
: The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects."Metrics"
: The measurement that you want your reservation coverage reported in. Valid values are Hour, Unit, and Cost. You can use multiple values in a request."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size."SortBy"
: The value by which you want to sort the data. The following values are supported for Key: OnDemandCost CoverageHoursPercentage OnDemandHours ReservedHours TotalRunningHours CoverageNormalizedUnitsPercentage OnDemandNormalizedUnits ReservedNormalizedUnits TotalRunningNormalizedUnits Time Supported values for SortOrder are ASCENDING or DESCENDING.
Main.Cost_Explorer.get_reservation_purchase_recommendation
— Methodget_reservation_purchase_recommendation(service)
get_reservation_purchase_recommendation(service, params::Dict{String,<:Any})
Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing. AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings. For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large because that is the smallest size instance in the c4 instance family.
Arguments
service
: The specific service that you want recommendations for.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AccountId"
: The account ID that is associated with the recommendation."AccountScope"
: The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only."Filter"
:"LookbackPeriodInDays"
: The number of previous days that you want AWS to consider when it calculates your recommendations."NextPageToken"
: The pagination token that indicates the next set of results that you want to retrieve."PageSize"
: The number of recommendations that you want returned in a single response object."PaymentOption"
: The reservation purchase option that you want recommendations for."ServiceSpecification"
: The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances."TermInYears"
: The reservation term that you want recommendations for.
Main.Cost_Explorer.get_reservation_utilization
— Methodget_reservation_utilization(time_period)
get_reservation_utilization(time_period, params::Dict{String,<:Any})
Retrieves the reservation utilization for your account. Management account in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.
Arguments
time_period
: Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHEENGINE DEPLOYMENTOPTION INSTANCETYPE LINKEDACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE SCOPE TENANCY GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together."Granularity"
: If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY. The GetReservationUtilization operation supports only DAILY and MONTHLY granularities."GroupBy"
: Groups only by SUBSCRIPTION_ID. Metadata is included."MaxResults"
: The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size."SortBy"
: The value by which you want to sort the data. The following values are supported for Key: UtilizationPercentage UtilizationPercentageInUnits PurchasedHours PurchasedUnits TotalActualHours TotalActualUnits UnusedHours UnusedUnits OnDemandCostOfRIHoursUsed NetRISavings TotalPotentialRISavings AmortizedUpfrontFee AmortizedRecurringFee TotalAmortizedFee RICostForUnusedHours RealizedSavings UnrealizedSavings Supported values for SortOrder are ASCENDING or DESCENDING.
Main.Cost_Explorer.get_rightsizing_recommendation
— Methodget_rightsizing_recommendation(service)
get_rightsizing_recommendation(service, params::Dict{String,<:Any})
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances. Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the AWS Billing and Cost Management User Guide.
Arguments
service
: The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is "AmazonEC2".
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Configuration"
: Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither."Filter"
:"NextPageToken"
: The pagination token that indicates the next set of results that you want to retrieve."PageSize"
: The number of recommendations that you want returned in a single response object.
Main.Cost_Explorer.get_savings_plans_coverage
— Methodget_savings_plans_coverage(time_period)
get_savings_plans_coverage(time_period, params::Dict{String,<:Any})
Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions: LINKEDACCOUNT REGION SERVICE INSTANCEFAMILY To determine valid values for a dimension, use the GetDimensionValues operation.
Arguments
time_period
: The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions: LINKEDACCOUNT REGION SERVICE INSTANCEFAMILY GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together. Cost category is also supported."Granularity"
: The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set. The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities."GroupBy"
: You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE."MaxResults"
: The number of items to be returned in a response. The default is 20, with a minimum value of 1."Metrics"
: The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans."NextToken"
: 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."SortBy"
: The value by which you want to sort the data. The following values are supported for Key: SpendCoveredBySavingsPlan OnDemandCost CoveragePercentage TotalCost InstanceFamily Region Service Supported values for SortOrder are ASCENDING or DESCENDING.
Main.Cost_Explorer.get_savings_plans_purchase_recommendation
— Methodget_savings_plans_purchase_recommendation(lookback_period_in_days, payment_option, savings_plans_type, term_in_years)
get_savings_plans_purchase_recommendation(lookback_period_in_days, payment_option, savings_plans_type, term_in_years, params::Dict{String,<:Any})
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
Arguments
lookback_period_in_days
: The lookback period used to generate the recommendation.payment_option
: The payment option used to generate these recommendations.savings_plans_type
: The Savings Plans recommendation type requested.term_in_years
: The savings plan recommendation term used to generate these recommendations.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AccountScope"
: The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only."Filter"
: You can filter your recommendations by Account ID with the LINKEDACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKEDACCOUNT and Value as the comma-separated Acount ID(s) for which you want to see Savings Plans purchase recommendations. For GetSavingsPlansPurchaseRecommendation, the Filter does not include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs for which you want to see Savings Plans Purchase Recommendations. AND and OR operators are not supported."NextPageToken"
: 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."PageSize"
: The number of recommendations that you want returned in a single response object.
Main.Cost_Explorer.get_savings_plans_utilization
— Methodget_savings_plans_utilization(time_period)
get_savings_plans_utilization(time_period, params::Dict{String,<:Any})
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. You cannot group by any dimension values for GetSavingsPlansUtilization.
Arguments
time_period
: The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions: LINKEDACCOUNT SAVINGSPLANARN SAVINGSPLANSTYPE REGION PAYMENTOPTION INSTANCETYPEFAMILY GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension."Granularity"
: The granularity of the Amazon Web Services utillization data for your Savings Plans. The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities."SortBy"
: The value by which you want to sort the data. The following values are supported for Key: UtilizationPercentage TotalCommitment UsedCommitment UnusedCommitment NetSavings Supported values for SortOrder are ASCENDING or DESCENDING.
Main.Cost_Explorer.get_savings_plans_utilization_details
— Methodget_savings_plans_utilization_details(time_period)
get_savings_plans_utilization_details(time_period, params::Dict{String,<:Any})
Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.
Arguments
time_period
: The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DataType"
: The data type."Filter"
: Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions: LINKEDACCOUNT SAVINGSPLANARN REGION PAYMENTOPTION INSTANCETYPEFAMILY GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension."MaxResults"
: The number of items to be returned in a response. The default is 20, with a minimum value of 1."NextToken"
: 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."SortBy"
: The value by which you want to sort the data. The following values are supported for Key: UtilizationPercentage TotalCommitment UsedCommitment UnusedCommitment NetSavings AmortizedRecurringCommitment AmortizedUpfrontCommitment Supported values for SortOrder are ASCENDING or DESCENDING.
Main.Cost_Explorer.get_tags
— Methodget_tags(time_period)
get_tags(time_period, params::Dict{String,<:Any})
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
Arguments
time_period
: The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
:"MaxResults"
: This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter. For GetTags, MaxResults has an upper limit of 1000."NextPageToken"
: The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size."SearchString"
: The value that you want to search for."SortBy"
: The value by which you want to sort the data. The key represents cost and usage metrics. The following values are supported: BlendedCost UnblendedCost AmortizedCost NetAmortizedCost NetUnblendedCost UsageQuantity NormalizedUsageAmount Supported values for SortOrder are ASCENDING or DESCENDING. When using SortBy, NextPageToken and SearchString are not supported."TagKey"
: The key of the tag that you want to return values for.
Main.Cost_Explorer.get_usage_forecast
— Methodget_usage_forecast(granularity, metric, time_period)
get_usage_forecast(granularity, metric, time_period, params::Dict{String,<:Any})
Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
Arguments
granularity
: How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts. The GetUsageForecast operation supports only DAILY and MONTHLY granularities.metric
: Which metric Cost Explorer uses to create your forecast. Valid values for a GetUsageForecast call are the following: USAGEQUANTITY NORMALIZEDUSAGE_AMOUNTtime_period
: The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions: AZ INSTANCETYPE LINKEDACCOUNT LINKEDACCOUNTNAME OPERATION PURCHASETYPE REGION SERVICE USAGETYPE USAGETYPEGROUP RECORDTYPE OPERATINGSYSTEM TENANCY SCOPE PLATFORM SUBSCRIPTIONID LEGALENTITYNAME DEPLOYMENTOPTION DATABASEENGINE INSTANCETYPEFAMILY BILLINGENTITY RESERVATIONID SAVINGSPLAN_ARN"PredictionIntervalLevel"
: Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.
Main.Cost_Explorer.list_cost_category_definitions
— Methodlist_cost_category_definitions()
list_cost_category_definitions(params::Dict{String,<:Any})
Returns the name, ARN, NumberOfRules and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"EffectiveOn"
: The date when the Cost Category was effective."MaxResults"
: The number of entries a paginated response contains."NextToken"
: 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.
Main.Cost_Explorer.provide_anomaly_feedback
— Methodprovide_anomaly_feedback(anomaly_id, feedback)
provide_anomaly_feedback(anomaly_id, feedback, params::Dict{String,<:Any})
Modifies the feedback property of a given cost anomaly.
Arguments
anomaly_id
: A cost anomaly ID.feedback
: Describes whether the cost anomaly was a planned activity or you considered it an anomaly.
Main.Cost_Explorer.update_anomaly_monitor
— Methodupdate_anomaly_monitor(monitor_arn)
update_anomaly_monitor(monitor_arn, params::Dict{String,<:Any})
Updates an existing cost anomaly monitor. The changes made are applied going forward, and does not change anomalies detected in the past.
Arguments
monitor_arn
: Cost anomaly monitor Amazon Resource Names (ARNs).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MonitorName"
: The new name for the cost anomaly monitor.
Main.Cost_Explorer.update_anomaly_subscription
— Methodupdate_anomaly_subscription(subscription_arn)
update_anomaly_subscription(subscription_arn, params::Dict{String,<:Any})
Updates an existing cost anomaly monitor subscription.
Arguments
subscription_arn
: A cost anomaly subscription Amazon Resource Name (ARN).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Frequency"
: The update to the frequency value at which subscribers will receive notifications."MonitorArnList"
: A list of cost anomaly monitor ARNs."Subscribers"
: The update to the subscriber list."SubscriptionName"
: The subscription's new name."Threshold"
: The update to the threshold value for receiving notifications.
Main.Cost_Explorer.update_cost_category_definition
— Methodupdate_cost_category_definition(cost_category_arn, rule_version, rules)
update_cost_category_definition(cost_category_arn, rule_version, rules, params::Dict{String,<:Any})
Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
Arguments
cost_category_arn
: The unique identifier for your Cost Category.rule_version
:rules
: The Expression object used to categorize costs. For more information, see CostCategoryRule .
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DefaultValue"
: