prowler-sdk-poc
Version:
740 lines • 151 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class CostExplorer extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CostExplorer.Types.ClientConfiguration)
config: Config & CostExplorer.Types.ClientConfiguration;
/**
* Creates a new cost anomaly detection monitor with the requested type and monitor specification.
*/
createAnomalyMonitor(params: CostExplorer.Types.CreateAnomalyMonitorRequest, callback?: (err: AWSError, data: CostExplorer.Types.CreateAnomalyMonitorResponse) => void): Request<CostExplorer.Types.CreateAnomalyMonitorResponse, AWSError>;
/**
* Creates a new cost anomaly detection monitor with the requested type and monitor specification.
*/
createAnomalyMonitor(callback?: (err: AWSError, data: CostExplorer.Types.CreateAnomalyMonitorResponse) => void): Request<CostExplorer.Types.CreateAnomalyMonitorResponse, AWSError>;
/**
* 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.
*/
createAnomalySubscription(params: CostExplorer.Types.CreateAnomalySubscriptionRequest, callback?: (err: AWSError, data: CostExplorer.Types.CreateAnomalySubscriptionResponse) => void): Request<CostExplorer.Types.CreateAnomalySubscriptionResponse, AWSError>;
/**
* 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.
*/
createAnomalySubscription(callback?: (err: AWSError, data: CostExplorer.Types.CreateAnomalySubscriptionResponse) => void): Request<CostExplorer.Types.CreateAnomalySubscriptionResponse, AWSError>;
/**
* Creates a new Cost Category with the requested name and rules.
*/
createCostCategoryDefinition(params: CostExplorer.Types.CreateCostCategoryDefinitionRequest, callback?: (err: AWSError, data: CostExplorer.Types.CreateCostCategoryDefinitionResponse) => void): Request<CostExplorer.Types.CreateCostCategoryDefinitionResponse, AWSError>;
/**
* Creates a new Cost Category with the requested name and rules.
*/
createCostCategoryDefinition(callback?: (err: AWSError, data: CostExplorer.Types.CreateCostCategoryDefinitionResponse) => void): Request<CostExplorer.Types.CreateCostCategoryDefinitionResponse, AWSError>;
/**
* Deletes a cost anomaly monitor.
*/
deleteAnomalyMonitor(params: CostExplorer.Types.DeleteAnomalyMonitorRequest, callback?: (err: AWSError, data: CostExplorer.Types.DeleteAnomalyMonitorResponse) => void): Request<CostExplorer.Types.DeleteAnomalyMonitorResponse, AWSError>;
/**
* Deletes a cost anomaly monitor.
*/
deleteAnomalyMonitor(callback?: (err: AWSError, data: CostExplorer.Types.DeleteAnomalyMonitorResponse) => void): Request<CostExplorer.Types.DeleteAnomalyMonitorResponse, AWSError>;
/**
* Deletes a cost anomaly subscription.
*/
deleteAnomalySubscription(params: CostExplorer.Types.DeleteAnomalySubscriptionRequest, callback?: (err: AWSError, data: CostExplorer.Types.DeleteAnomalySubscriptionResponse) => void): Request<CostExplorer.Types.DeleteAnomalySubscriptionResponse, AWSError>;
/**
* Deletes a cost anomaly subscription.
*/
deleteAnomalySubscription(callback?: (err: AWSError, data: CostExplorer.Types.DeleteAnomalySubscriptionResponse) => void): Request<CostExplorer.Types.DeleteAnomalySubscriptionResponse, AWSError>;
/**
* Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
*/
deleteCostCategoryDefinition(params: CostExplorer.Types.DeleteCostCategoryDefinitionRequest, callback?: (err: AWSError, data: CostExplorer.Types.DeleteCostCategoryDefinitionResponse) => void): Request<CostExplorer.Types.DeleteCostCategoryDefinitionResponse, AWSError>;
/**
* Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
*/
deleteCostCategoryDefinition(callback?: (err: AWSError, data: CostExplorer.Types.DeleteCostCategoryDefinitionResponse) => void): Request<CostExplorer.Types.DeleteCostCategoryDefinitionResponse, AWSError>;
/**
* 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.
*/
describeCostCategoryDefinition(params: CostExplorer.Types.DescribeCostCategoryDefinitionRequest, callback?: (err: AWSError, data: CostExplorer.Types.DescribeCostCategoryDefinitionResponse) => void): Request<CostExplorer.Types.DescribeCostCategoryDefinitionResponse, AWSError>;
/**
* 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.
*/
describeCostCategoryDefinition(callback?: (err: AWSError, data: CostExplorer.Types.DescribeCostCategoryDefinitionResponse) => void): Request<CostExplorer.Types.DescribeCostCategoryDefinitionResponse, AWSError>;
/**
* Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object.
*/
getAnomalies(params: CostExplorer.Types.GetAnomaliesRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetAnomaliesResponse) => void): Request<CostExplorer.Types.GetAnomaliesResponse, AWSError>;
/**
* Retrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object.
*/
getAnomalies(callback?: (err: AWSError, data: CostExplorer.Types.GetAnomaliesResponse) => void): Request<CostExplorer.Types.GetAnomaliesResponse, AWSError>;
/**
* Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
*/
getAnomalyMonitors(params: CostExplorer.Types.GetAnomalyMonitorsRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetAnomalyMonitorsResponse) => void): Request<CostExplorer.Types.GetAnomalyMonitorsResponse, AWSError>;
/**
* Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
*/
getAnomalyMonitors(callback?: (err: AWSError, data: CostExplorer.Types.GetAnomalyMonitorsResponse) => void): Request<CostExplorer.Types.GetAnomalyMonitorsResponse, AWSError>;
/**
* Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
*/
getAnomalySubscriptions(params: CostExplorer.Types.GetAnomalySubscriptionsRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetAnomalySubscriptionsResponse) => void): Request<CostExplorer.Types.GetAnomalySubscriptionsResponse, AWSError>;
/**
* Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
*/
getAnomalySubscriptions(callback?: (err: AWSError, data: CostExplorer.Types.GetAnomalySubscriptionsResponse) => void): Request<CostExplorer.Types.GetAnomalySubscriptionsResponse, AWSError>;
/**
* Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts or UsageQuantity. 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 Organizations have access to all member accounts. For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
*/
getCostAndUsage(params: CostExplorer.Types.GetCostAndUsageRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetCostAndUsageResponse) => void): Request<CostExplorer.Types.GetCostAndUsageResponse, AWSError>;
/**
* Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you want the request to return. For example, you can specify BlendedCosts or UsageQuantity. 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 Organizations have access to all member accounts. For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
*/
getCostAndUsage(callback?: (err: AWSError, data: CostExplorer.Types.GetCostAndUsageResponse) => void): Request<CostExplorer.Types.GetCostAndUsageResponse, AWSError>;
/**
* 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 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 Billing and Cost Management User Guide.
*/
getCostAndUsageWithResources(params: CostExplorer.Types.GetCostAndUsageWithResourcesRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetCostAndUsageWithResourcesResponse) => void): Request<CostExplorer.Types.GetCostAndUsageWithResourcesResponse, AWSError>;
/**
* 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 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 Billing and Cost Management User Guide.
*/
getCostAndUsageWithResources(callback?: (err: AWSError, data: CostExplorer.Types.GetCostAndUsageWithResourcesResponse) => void): Request<CostExplorer.Types.GetCostAndUsageWithResourcesResponse, AWSError>;
/**
* 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.
*/
getCostCategories(params: CostExplorer.Types.GetCostCategoriesRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetCostCategoriesResponse) => void): Request<CostExplorer.Types.GetCostCategoriesResponse, AWSError>;
/**
* 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.
*/
getCostCategories(callback?: (err: AWSError, data: CostExplorer.Types.GetCostCategoriesResponse) => void): Request<CostExplorer.Types.GetCostCategoriesResponse, AWSError>;
/**
* 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.
*/
getCostForecast(params: CostExplorer.Types.GetCostForecastRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetCostForecastResponse) => void): Request<CostExplorer.Types.GetCostForecastResponse, AWSError>;
/**
* 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.
*/
getCostForecast(callback?: (err: AWSError, data: CostExplorer.Types.GetCostForecastResponse) => void): Request<CostExplorer.Types.GetCostForecastResponse, AWSError>;
/**
* Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
*/
getDimensionValues(params: CostExplorer.Types.GetDimensionValuesRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetDimensionValuesResponse) => void): Request<CostExplorer.Types.GetDimensionValuesResponse, AWSError>;
/**
* Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
*/
getDimensionValues(callback?: (err: AWSError, data: CostExplorer.Types.GetDimensionValuesResponse) => void): Request<CostExplorer.Types.GetDimensionValuesResponse, AWSError>;
/**
* 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 CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY To determine valid values for a dimension, use the GetDimensionValues operation.
*/
getReservationCoverage(params: CostExplorer.Types.GetReservationCoverageRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationCoverageResponse) => void): Request<CostExplorer.Types.GetReservationCoverageResponse, AWSError>;
/**
* 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 CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY To determine valid values for a dimension, use the GetDimensionValues operation.
*/
getReservationCoverage(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationCoverageResponse) => void): Request<CostExplorer.Types.GetReservationCoverageResponse, AWSError>;
/**
* 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. Amazon Web Services 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 Amazon Web Services 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, Amazon Web Services 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. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. Amazon Web Services 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.
*/
getReservationPurchaseRecommendation(params: CostExplorer.Types.GetReservationPurchaseRecommendationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationPurchaseRecommendationResponse) => void): Request<CostExplorer.Types.GetReservationPurchaseRecommendationResponse, AWSError>;
/**
* 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. Amazon Web Services 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 Amazon Web Services 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, Amazon Web Services 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. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. Amazon Web Services 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.
*/
getReservationPurchaseRecommendation(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationPurchaseRecommendationResponse) => void): Request<CostExplorer.Types.GetReservationPurchaseRecommendationResponse, AWSError>;
/**
* 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.
*/
getReservationUtilization(params: CostExplorer.Types.GetReservationUtilizationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetReservationUtilizationResponse) => void): Request<CostExplorer.Types.GetReservationUtilizationResponse, AWSError>;
/**
* 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.
*/
getReservationUtilization(callback?: (err: AWSError, data: CostExplorer.Types.GetReservationUtilizationResponse) => void): Request<CostExplorer.Types.GetReservationUtilizationResponse, AWSError>;
/**
* 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 Billing and Cost Management User Guide.
*/
getRightsizingRecommendation(params: CostExplorer.Types.GetRightsizingRecommendationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetRightsizingRecommendationResponse) => void): Request<CostExplorer.Types.GetRightsizingRecommendationResponse, AWSError>;
/**
* 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 Billing and Cost Management User Guide.
*/
getRightsizingRecommendation(callback?: (err: AWSError, data: CostExplorer.Types.GetRightsizingRecommendationResponse) => void): Request<CostExplorer.Types.GetRightsizingRecommendationResponse, AWSError>;
/**
* 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: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY To determine valid values for a dimension, use the GetDimensionValues operation.
*/
getSavingsPlansCoverage(params: CostExplorer.Types.GetSavingsPlansCoverageRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansCoverageResponse) => void): Request<CostExplorer.Types.GetSavingsPlansCoverageResponse, AWSError>;
/**
* 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: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY To determine valid values for a dimension, use the GetDimensionValues operation.
*/
getSavingsPlansCoverage(callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansCoverageResponse) => void): Request<CostExplorer.Types.GetSavingsPlansCoverageResponse, AWSError>;
/**
* Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
*/
getSavingsPlansPurchaseRecommendation(params: CostExplorer.Types.GetSavingsPlansPurchaseRecommendationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansPurchaseRecommendationResponse) => void): Request<CostExplorer.Types.GetSavingsPlansPurchaseRecommendationResponse, AWSError>;
/**
* Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
*/
getSavingsPlansPurchaseRecommendation(callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansPurchaseRecommendationResponse) => void): Request<CostExplorer.Types.GetSavingsPlansPurchaseRecommendationResponse, AWSError>;
/**
* 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.
*/
getSavingsPlansUtilization(params: CostExplorer.Types.GetSavingsPlansUtilizationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansUtilizationResponse) => void): Request<CostExplorer.Types.GetSavingsPlansUtilizationResponse, AWSError>;
/**
* 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.
*/
getSavingsPlansUtilization(callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansUtilizationResponse) => void): Request<CostExplorer.Types.GetSavingsPlansUtilizationResponse, AWSError>;
/**
* 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.
*/
getSavingsPlansUtilizationDetails(params: CostExplorer.Types.GetSavingsPlansUtilizationDetailsRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansUtilizationDetailsResponse) => void): Request<CostExplorer.Types.GetSavingsPlansUtilizationDetailsResponse, AWSError>;
/**
* 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.
*/
getSavingsPlansUtilizationDetails(callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansUtilizationDetailsResponse) => void): Request<CostExplorer.Types.GetSavingsPlansUtilizationDetailsResponse, AWSError>;
/**
* Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
*/
getTags(params: CostExplorer.Types.GetTagsRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetTagsResponse) => void): Request<CostExplorer.Types.GetTagsResponse, AWSError>;
/**
* Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
*/
getTags(callback?: (err: AWSError, data: CostExplorer.Types.GetTagsResponse) => void): Request<CostExplorer.Types.GetTagsResponse, AWSError>;
/**
* 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.
*/
getUsageForecast(params: CostExplorer.Types.GetUsageForecastRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetUsageForecastResponse) => void): Request<CostExplorer.Types.GetUsageForecastResponse, AWSError>;
/**
* 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.
*/
getUsageForecast(callback?: (err: AWSError, data: CostExplorer.Types.GetUsageForecastResponse) => void): Request<CostExplorer.Types.GetUsageForecastResponse, AWSError>;
/**
* 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.
*/
listCostCategoryDefinitions(params: CostExplorer.Types.ListCostCategoryDefinitionsRequest, callback?: (err: AWSError, data: CostExplorer.Types.ListCostCategoryDefinitionsResponse) => void): Request<CostExplorer.Types.ListCostCategoryDefinitionsResponse, AWSError>;
/**
* 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.
*/
listCostCategoryDefinitions(callback?: (err: AWSError, data: CostExplorer.Types.ListCostCategoryDefinitionsResponse) => void): Request<CostExplorer.Types.ListCostCategoryDefinitionsResponse, AWSError>;
/**
* Modifies the feedback property of a given cost anomaly.
*/
provideAnomalyFeedback(params: CostExplorer.Types.ProvideAnomalyFeedbackRequest, callback?: (err: AWSError, data: CostExplorer.Types.ProvideAnomalyFeedbackResponse) => void): Request<CostExplorer.Types.ProvideAnomalyFeedbackResponse, AWSError>;
/**
* Modifies the feedback property of a given cost anomaly.
*/
provideAnomalyFeedback(callback?: (err: AWSError, data: CostExplorer.Types.ProvideAnomalyFeedbackResponse) => void): Request<CostExplorer.Types.ProvideAnomalyFeedbackResponse, AWSError>;
/**
* Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn'tt change anomalies detected in the past.
*/
updateAnomalyMonitor(params: CostExplorer.Types.UpdateAnomalyMonitorRequest, callback?: (err: AWSError, data: CostExplorer.Types.UpdateAnomalyMonitorResponse) => void): Request<CostExplorer.Types.UpdateAnomalyMonitorResponse, AWSError>;
/**
* Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn'tt change anomalies detected in the past.
*/
updateAnomalyMonitor(callback?: (err: AWSError, data: CostExplorer.Types.UpdateAnomalyMonitorResponse) => void): Request<CostExplorer.Types.UpdateAnomalyMonitorResponse, AWSError>;
/**
* Updates an existing cost anomaly monitor subscription.
*/
updateAnomalySubscription(params: CostExplorer.Types.UpdateAnomalySubscriptionRequest, callback?: (err: AWSError, data: CostExplorer.Types.UpdateAnomalySubscriptionResponse) => void): Request<CostExplorer.Types.UpdateAnomalySubscriptionResponse, AWSError>;
/**
* Updates an existing cost anomaly monitor subscription.
*/
updateAnomalySubscription(callback?: (err: AWSError, data: CostExplorer.Types.UpdateAnomalySubscriptionResponse) => void): Request<CostExplorer.Types.UpdateAnomalySubscriptionResponse, AWSError>;
/**
* 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.
*/
updateCostCategoryDefinition(params: CostExplorer.Types.UpdateCostCategoryDefinitionRequest, callback?: (err: AWSError, data: CostExplorer.Types.UpdateCostCategoryDefinitionResponse) => void): Request<CostExplorer.Types.UpdateCostCategoryDefinitionResponse, AWSError>;
/**
* 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.
*/
updateCostCategoryDefinition(callback?: (err: AWSError, data: CostExplorer.Types.UpdateCostCategoryDefinitionResponse) => void): Request<CostExplorer.Types.UpdateCostCategoryDefinitionResponse, AWSError>;
}
declare namespace CostExplorer {
export type AccountScope = "PAYER"|"LINKED"|string;
export type AmortizedRecurringFee = string;
export type AmortizedUpfrontFee = string;
export type Anomalies = Anomaly[];
export interface Anomaly {
/**
* The unique identifier for the anomaly.
*/
AnomalyId: GenericString;
/**
* The first day the anomaly is detected.
*/
AnomalyStartDate?: YearMonthDay;
/**
* The last day the anomaly is detected.
*/
AnomalyEndDate?: YearMonthDay;
/**
* The dimension for the anomaly (for example, an Amazon Web Services service in a service monitor).
*/
DimensionValue?: GenericString;
/**
* The list of identified root causes for the anomaly.
*/
RootCauses?: RootCauses;
/**
* The latest and maximum score for the anomaly.
*/
AnomalyScore: AnomalyScore;
/**
* The dollar impact for the anomaly.
*/
Impact: Impact;
/**
* The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.
*/
MonitorArn: GenericString;
/**
* The feedback value.
*/
Feedback?: AnomalyFeedbackType;
}
export interface AnomalyDateInterval {
/**
* The first date an anomaly was observed.
*/
StartDate: YearMonthDay;
/**
* The last date an anomaly was observed.
*/
EndDate?: YearMonthDay;
}
export type AnomalyFeedbackType = "YES"|"NO"|"PLANNED_ACTIVITY"|string;
export interface AnomalyMonitor {
/**
* The Amazon Resource Name (ARN) value.
*/
MonitorArn?: GenericString;
/**
* The name of the monitor.
*/
MonitorName: GenericString;
/**
* The date when the monitor was created.
*/
CreationDate?: YearMonthDay;
/**
* The date when the monitor was last updated.
*/
LastUpdatedDate?: YearMonthDay;
/**
* The date when the monitor last evaluated for anomalies.
*/
LastEvaluatedDate?: YearMonthDay;
/**
* The possible type values.
*/
MonitorType: MonitorType;
/**
* The dimensions to evaluate.
*/
MonitorDimension?: MonitorDimension;
MonitorSpecification?: Expression;
/**
* The value for evaluated dimensions.
*/
DimensionalValueCount?: NonNegativeInteger;
}
export type AnomalyMonitors = AnomalyMonitor[];
export interface AnomalyScore {
/**
* The maximum score that's observed during the AnomalyDateInterval.
*/
MaxScore: GenericDouble;
/**
* The last observed score.
*/
CurrentScore: GenericDouble;
}
export interface AnomalySubscription {
/**
* The AnomalySubscription Amazon Resource Name (ARN).
*/
SubscriptionArn?: GenericString;
/**
* Your unique account identifier.
*/
AccountId?: GenericString;
/**
* A list of cost anomaly monitors.
*/
MonitorArnList: MonitorArnList;
/**
* A list of subscribers to notify.
*/
Subscribers: Subscribers;
/**
* The dollar value that triggers a notification if the threshold is exceeded.
*/
Threshold: NullableNonNegativeDouble;
/**
* The frequency that anomaly reports are sent over email.
*/
Frequency: AnomalySubscriptionFrequency;
/**
* The name for the subscription.
*/
SubscriptionName: GenericString;
}
export type AnomalySubscriptionFrequency = "DAILY"|"IMMEDIATE"|"WEEKLY"|string;
export type AnomalySubscriptions = AnomalySubscription[];
export type Arn = string;
export type AttributeType = string;
export type AttributeValue = string;
export type Attributes = {[key: string]: AttributeValue};
export type Context = "COST_AND_USAGE"|"RESERVATIONS"|"SAVINGS_PLANS"|string;
export interface CostCategory {
/**
* The unique identifier for your Cost Category.
*/
CostCategoryArn: Arn;
/**
* The effective state data of your Cost Category.
*/
EffectiveStart: ZonedDateTime;
/**
* The effective end data of your Cost Category.
*/
EffectiveEnd?: ZonedDateTime;
Name: CostCategoryName;
RuleVersion: CostCategoryRuleVersion;
/**
* The rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
*/
Rules: CostCategoryRulesList;
/**
* The split charge rules that are used to allocate your charges between your Cost Category values.
*/
SplitChargeRules?: CostCategorySplitChargeRulesList;
/**
* The list of processing statuses for Cost Management products for a specific cost category.
*/
ProcessingStatus?: CostCategoryProcessingStatusList;
DefaultValue?: CostCategoryValue;
}
export interface CostCategoryInheritedValueDimension {
/**
* The name of the dimension that's used to group costs. If you specify LINKED_ACCOUNT_NAME, the cost category value is based on account name. If you specify TAG, the cost category value will be based on the value of the specified tag key.
*/
DimensionName?: CostCategoryInheritedValueDimensionName;
/**
* The key to extract cost category values.
*/
DimensionKey?: GenericString;
}
export type CostCategoryInheritedValueDimensionName = "LINKED_ACCOUNT_NAME"|"TAG"|string;
export type CostCategoryMaxResults = number;
export type CostCategoryName = string;
export type CostCategoryNamesList = CostCategoryName[];
export interface CostCategoryProcessingStatus {
/**
* The Cost Management product name of the applied status.
*/
Component?: CostCategoryStatusComponent;
/**
* The process status for a specific cost category.
*/
Status?: CostCategoryStatus;
}
export type CostCategoryProcessingStatusList = CostCategoryProcessingStatus[];
export interface CostCategoryReference {
/**
* The unique identifier for your Cost Category.
*/
CostCategoryArn?: Arn;
Name?: CostCategoryName;
/**
* The Cost Category's effective start date.
*/
EffectiveStart?: ZonedDateTime;
/**
* The Cost Category's effective end date.
*/
EffectiveEnd?: ZonedDateTime;
/**
* The number of rules that are associated with a specific Cost Category.
*/
NumberOfRules?: NonNegativeInteger;
/**
* The list of processing statuses for Cost Management products for a specific cost category.
*/
ProcessingStatus?: CostCategoryProcessingStatusList;
/**
* A list of unique cost category values in a specific cost category.
*/
Values?: CostCategoryValuesList;
DefaultValue?: CostCategoryValue;
}
export type CostCategoryReferencesList = CostCategoryReference[];
export interface CostCategoryRule {
Value?: CostCategoryValue;
/**
* An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, and LINKED_ACCOUNT_NAME. Root level OR isn't supported. We recommend that you create a separate rule instead. RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide.
*/
Rule?: Expression;
/**
* The value the line item is categorized as if the line item contains the matched dimension.
*/
InheritedValue?: CostCategoryInheritedValueDimension;
/**
* You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you want to dynamically group costs based on the value of a specific tag key, first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.
*/
Type?: CostCategoryRuleType;
}
export type CostCategoryRuleType = "REGULAR"|"INHERITED_VALUE"|string;
export type CostCategoryRuleVersion = "CostCategoryExpression.v1"|string;
export type CostCategoryRulesList = CostCategoryRule[];
export type CostCategorySplitChargeMethod = "FIXED"|"PROPORTIONAL"|"EVEN"|string;
export interface CostCategorySplitChargeRule {
/**
* The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.
*/
Source: GenericString;
/**
* The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.
*/
Targets: CostCategorySplitChargeRuleTargetsList;
/**
* The method that's used to define how to split your source costs across your targets. Proportional - Allocates charges across your targets based on the proportional weighted cost of each target. Fixed - Allocates charges across your targets based on your defined allocation percentage. >Even - Allocates costs evenly across all targets.
*/
Method: CostCategorySplitChargeMethod;
/**
* The parameters for a split charge method. This is only required for the FIXED method.
*/
Parameters?: CostCategorySplitChargeRuleParametersList;
}
export interface CostCategorySplitChargeRuleParameter {
/**
* The parameter type.
*/
Type: CostCategorySplitChargeRuleParameterType;
/**
* The parameter values.
*/
Values: CostCategorySplitChargeRuleParameterValuesList;
}
export type CostCategorySplitChargeRuleParameterType = "ALLOCATION_PERCENTAGES"|string;
export type CostCategorySplitChargeRuleParameterValuesList = GenericString[];
export type CostCategorySplitChargeRuleParametersList = CostCategorySplitChargeRuleParameter[];
export type CostCategorySplitChargeRuleTargetsList = GenericString[];
export type CostCategorySplitChargeRulesList = CostCategorySplitChargeRule[];
export type CostCategoryStatus = "PROCESSING"|"APPLIED"|string;
export type CostCategoryStatusComponent = "COST_EXPLORER"|string;
export type CostCategoryValue = string;
export interface CostCategoryValues {
Key?: CostCategoryName;
/**
* The specific value of the Cost Category.
*/
Values?: Values;
/**
* The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.
*/
MatchOptions?: MatchOptions;
}
export type CostCategoryValuesList = CostCategoryValue[];
export interface Coverage {
/**
* The amount of instance usage that the reservation covered, in hours.
*/
CoverageHours?: CoverageHours;
/**
* The amount of instance usage that the reservation covered, in normalized units.
*/
CoverageNormalizedUnits?: CoverageNormalizedUnits;
/**
* The amount of cost that the reservation covered.
*/
CoverageCost?: CoverageCost;
}
export interface CoverageByTime {
/**
* The period that this coverage was used over.
*/
TimePeriod?: DateInterval;
/**
* The groups of instances that the reservation covered.
*/
Groups?: ReservationCoverageGroups;
/**
* The total reservation coverage, in hours.
*/
Total?: Coverage;
}
export interface CoverageCost {
/**
* How much an On-Demand Instance costs.
*/
OnDemandCost?: OnDemandCost;
}
export interface CoverageHours {
/**
* The number of instance running hours that On-Demand Instances covered.
*/
OnDemandHours?: OnDemandHours;
/**
* The number of instance running hours that reservations covered.
*/
ReservedHours?: ReservedHours;
/**
* The total instance usage, in hours.
*/
TotalRunningHours?: TotalRunningHours;
/**
* The percentage of instance hours that a reservation covered.
*/
CoverageHoursPercentage?: CoverageHoursPercentage;
}
export type CoverageHoursPercentage = string;
export interface CoverageNormalizedUnits {
/**
* The number of normalized units that are covered by On-Demand Instances instead of a reservation.
*/
OnDemandNormalizedUnits?: OnDemandNormalizedUnits;
/**
* The number of normalized units that a reservation covers.
*/
ReservedNormalizedUnits?: ReservedNormalizedUnits;
/**
* The total number of normalized units that you used.
*/
TotalRunningNormalizedUnits?: TotalRunningNormalizedUnits;
/**
* The percentage of your used instance normalized units that a reservation covers.
*/
CoverageNormalizedUnitsPercentage?: CoverageNormalizedUnitsPercentage;
}
export type CoverageNormalizedUnitsPercentage = string;
export type CoveragesByTime = CoverageByTime[];
export interface CreateAnomalyMonitorRequest {
/**
* The cost anomaly detection monitor object that you want to create.
*/
AnomalyMonitor: AnomalyMonitor;
}
export interface CreateAnomalyMonitorResponse {
/**
* The unique identifier of your newly created cost anomaly detection monitor.
*/
MonitorArn: GenericString;
}
export interface CreateAnomalySubscriptionRequest {
/**
* The cost anomaly subscription object that you want to create.
*/
AnomalySubscription: AnomalySubscription;
}
export interface CreateAnomalySubscriptionResponse {
/**
* The unique identifier of your newly created cost anomaly subscription.
*/
SubscriptionArn: GenericString;
}
export interface CreateCostCategoryDefinitionRequest {
Name: CostCategoryName;
RuleVersion: CostCategoryRuleVersion;
/**
* The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.
*/
Rules: CostCategoryRulesList;
DefaultValue?: CostCategoryValue;
/**
* The split charge rules used to allocate your charges between your Cost Category values.
*/
SplitChargeRules?: CostCategorySplitChargeRulesList;
}
export interface CreateCostCategoryDefinitionResponse {
/**
* The unique identifier for your newly created Cost Category.
*/
CostCategoryArn?: Arn;
/**
* The Cost Category's effective start date.
*/
EffectiveStart?: ZonedDateTime;
}
export interface CurrentInstance {
/**
* Resource ID of the current instance.
*/
ResourceId?: GenericString;
/**
* The name that you given an instance. This field shows as blank if you haven't given the instance a name.
*/
InstanceName?: GenericString;
/**
* Cost allocation resource tags that are applied to the instance.
*/
Tags?: TagValuesList;
/**
* Details about the resource and utilization.
*/
ResourceDetails?: ResourceDetails;
/**
* Utilization information of the current instance during the lookback period.
*/
ResourceUtilization?: ResourceUtilization;
/**
* The number of hours during the lookback period that's covered by reservations.
*/
ReservationCoveredHoursInLookbackPeriod?: GenericString;
/**
* The number of hours during the lookback period that's covered by Savings Plans.
*/
SavingsPlansCoveredHoursInLookbackPeriod?: GenericString;
/**
* The number of hours during the lookback period that's billed at On-Demand rates.
*/
OnDemandHoursInLookbackPeriod?: GenericString;
/**
* The total number of hours that the instance ran during the lookback period.
*/
TotalRunningHoursInLookbackPeriod?: GenericString;
/**
* The current On-Demand cost of operating this instance on a monthly basis.
*/
MonthlyCost?: GenericString;
/**
* The currency code that Amazon Web Services used to calculate the costs for this instance.
*/
CurrencyCode?: GenericString;
}
export interface DateInterval {
/**
* The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
*/
Start: YearMonthDay;
/**
* The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.
*/
End: YearMonthDay;
}
export interface DeleteAnomalyMonitorRequest {
/**
* The unique identifier of the cost anomaly monitor that you want to delete.
*/
MonitorArn: GenericString;
}
export interface DeleteAnomalyMonitorResponse {
}
export interface DeleteAnomalySubscriptionRequest {
/**
* The unique identifier of the cost anomaly subscription that you want to delete.
*/
SubscriptionArn: GenericString;
}
export interface DeleteAnomalySubscriptionResponse {
}
export interface DeleteCostCategoryDefinitionRequest {
/**
* The unique identifier for your Cost Category.
*/
CostCategoryArn: Arn;
}
export interface DeleteCostCatego