CostExplorer

public struct CostExplorer

Client object for interacting with AWS CostExplorer service.

The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment. Service Endpoint The Cost Explorer API provides the following endpoint: https://ce.us-east-1.amazonaws.com For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.

Member variables

Initialization

  • Initialize the CostExplorer client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Creates a new Cost Category with the requested name and rules.

    Declaration

    Swift

    public func createCostCategoryDefinition(_ input: CreateCostCategoryDefinitionRequest) -> EventLoopFuture<CreateCostCategoryDefinitionResponse>

  • Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.

    Declaration

    Swift

    public func deleteCostCategoryDefinition(_ input: DeleteCostCategoryDefinitionRequest) -> EventLoopFuture<DeleteCostCategoryDefinitionResponse>

  • 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.

    Declaration

    Swift

    public func describeCostCategoryDefinition(_ input: DescribeCostCategoryDefinitionRequest) -> EventLoopFuture<DescribeCostCategoryDefinitionResponse>

  • 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. Master accounts in an organization in AWS Organizations have access to all member accounts.

    Declaration

    Swift

    public func getCostAndUsage(_ input: GetCostAndUsageRequest) -> EventLoopFuture<GetCostAndUsageResponse>

  • 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. Master accounts 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.

    Declaration

    Swift

    public func getCostAndUsageWithResources(_ input: GetCostAndUsageWithResourcesRequest) -> EventLoopFuture<GetCostAndUsageWithResourcesResponse>

  • 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.

    Declaration

    Swift

    public func getCostForecast(_ input: GetCostForecastRequest) -> EventLoopFuture<GetCostForecastResponse>

  • Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

    Declaration

    Swift

    public func getDimensionValues(_ input: GetDimensionValuesRequest) -> EventLoopFuture<GetDimensionValuesResponse>

  • 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 master 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.

    Declaration

    Swift

    public func getReservationCoverage(_ input: GetReservationCoverageRequest) -> EventLoopFuture<GetReservationCoverageResponse>

  • 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.

    Declaration

    Swift

    public func getReservationPurchaseRecommendation(_ input: GetReservationPurchaseRecommendationRequest) -> EventLoopFuture<GetReservationPurchaseRecommendationResponse>

  • Retrieves the reservation utilization for your account. Master accounts 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.

    Declaration

    Swift

    public func getReservationUtilization(_ input: GetReservationUtilizationRequest) -> EventLoopFuture<GetReservationUtilizationResponse>

  • 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.

    Declaration

    Swift

    public func getRightsizingRecommendation(_ input: GetRightsizingRecommendationRequest) -> EventLoopFuture<GetRightsizingRecommendationResponse>

  • 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 master 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.

    Declaration

    Swift

    public func getSavingsPlansCoverage(_ input: GetSavingsPlansCoverageRequest) -> EventLoopFuture<GetSavingsPlansCoverageResponse>

  • Retrieves your request parameters, Savings Plan Recommendations Summary and Details.

    Declaration

    Swift

    public func getSavingsPlansPurchaseRecommendation(_ input: GetSavingsPlansPurchaseRecommendationRequest) -> EventLoopFuture<GetSavingsPlansPurchaseRecommendationResponse>

  • Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Master accounts 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.

    Declaration

    Swift

    public func getSavingsPlansUtilization(_ input: GetSavingsPlansUtilizationRequest) -> EventLoopFuture<GetSavingsPlansUtilizationResponse>

  • 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.

    Declaration

    Swift

    public func getSavingsPlansUtilizationDetails(_ input: GetSavingsPlansUtilizationDetailsRequest) -> EventLoopFuture<GetSavingsPlansUtilizationDetailsResponse>

  • Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

    Declaration

    Swift

    public func getTags(_ input: GetTagsRequest) -> EventLoopFuture<GetTagsResponse>

  • 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.

    Declaration

    Swift

    public func getUsageForecast(_ input: GetUsageForecastRequest) -> EventLoopFuture<GetUsageForecastResponse>

  • 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.

    Declaration

    Swift

    public func listCostCategoryDefinitions(_ input: ListCostCategoryDefinitionsRequest) -> EventLoopFuture<ListCostCategoryDefinitionsResponse>

  • 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.

    Declaration

    Swift

    public func updateCostCategoryDefinition(_ input: UpdateCostCategoryDefinitionRequest) -> EventLoopFuture<UpdateCostCategoryDefinitionResponse>

Paginators

  • 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 master 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.

    Declaration

    Swift

    public func getSavingsPlansCoveragePaginator(_ input: GetSavingsPlansCoverageRequest, onPage: @escaping (GetSavingsPlansCoverageResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getSavingsPlansUtilizationDetailsPaginator(_ input: GetSavingsPlansUtilizationDetailsRequest, onPage: @escaping (GetSavingsPlansUtilizationDetailsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func listCostCategoryDefinitionsPaginator(_ input: ListCostCategoryDefinitionsRequest, onPage: @escaping (ListCostCategoryDefinitionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum AccountScope : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Context : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum CostCategoryRuleVersion : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Dimension : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Granularity : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum GroupDefinitionType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LookbackPeriodInDays : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum MatchOption : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Metric : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum OfferingClass : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum PaymentOption : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum RecommendationTarget : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum RightsizingType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SupportedSavingsPlansType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TermInYears : String, CustomStringConvertible, Codable