AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class BillExpirationException

CostExplorer exception

Class Coverage

The amount of instance usage that a reservation covered.

Class CoverageByTime

Reservation coverage for a specified period, in hours.

Class CoverageHours

How long a running instance either used a reservation or was On-Demand.

Class DataUnavailableException

CostExplorer exception

Class DateInterval

The time period that you want the usage and costs for.

Class DimensionValues

The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

Class DimensionValuesWithAttributes

The metadata of a specific type that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

Class EC2InstanceDetails

Details about the EC2 instances that AWS recommends that you purchase.

Class EC2Specification

The EC2 hardware specifications that you want AWS to provide recommendations for.

Class ElastiCacheInstanceDetails

Details about the ElastiCache instances that AWS recommends that you purchase.

Class ESInstanceDetails

Details about the ES instances that AWS recommends that you purchase.

Class Expression

Use Expression to filter by cost or by usage. There are two patterns:

  • Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for

    INSTANCE_TYPE==m4.xlarge
                OR INSTANCE_TYPE==c4.large
    
    . The Expression for that looks like this:

    { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large”
                ] } }
    

    The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.

  • Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on

    ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE
                == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
    
    . The Expression for that looks like this:

    { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large",
                "c4.large" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not":
                {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } 
    

    Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.

    { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values":
               [ "DataTransfer" ] } } 
    

Class GetCostAndUsageRequest

Container for the parameters to the GetCostAndUsage operation. 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.

Class GetCostAndUsageResponse

This is the response object from the GetCostAndUsage operation.

Class GetDimensionValuesRequest

Container for the parameters to the GetDimensionValues operation. Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

Class GetDimensionValuesResponse

This is the response object from the GetDimensionValues operation.

Class GetReservationCoverageRequest

Container for the parameters to the GetReservationCoverage operation. Retrieves the reservation coverage for your account. This allows 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. 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.

Class GetReservationCoverageResponse

This is the response object from the GetReservationCoverage operation.

Class GetReservationPurchaseRecommendationRequest

Container for the parameters to the GetReservationPurchaseRecommendation operation. 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 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.

Class GetReservationPurchaseRecommendationResponse

This is the response object from the GetReservationPurchaseRecommendation operation.

Class GetReservationUtilizationRequest

Container for the parameters to the GetReservationUtilization operation. 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.

Class GetReservationUtilizationResponse

This is the response object from the GetReservationUtilization operation.

Class GetTagsRequest

Container for the parameters to the GetTags operation. Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

Class GetTagsResponse

This is the response object from the GetTags operation.

Class Group

One level of grouped data within the results.

Class GroupDefinition

Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.

Class InstanceDetails

Details about the instances that AWS recommends that you purchase.

Class InvalidNextTokenException

CostExplorer exception

Class LimitExceededException

CostExplorer exception

Class MetricValue

The aggregated value for a metric.

Class RDSInstanceDetails

Details about the RDS instances that AWS recommends that you purchase.

Class RedshiftInstanceDetails

Details about the Amazon Redshift instances that AWS recommends that you purchase.

Class RequestChangedException

CostExplorer exception

Class ReservationAggregates

The aggregated numbers for your Reserved Instance (RI) usage.

Class ReservationCoverageGroup

A group of reservations that share a set of attributes.

Class ReservationPurchaseRecommendation

A specific reservation that AWS recommends for purchase.

Class ReservationPurchaseRecommendationDetail

Details about your recommended reservation purchase.

Class ReservationPurchaseRecommendationMetadata

Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.

Class ReservationPurchaseRecommendationSummary

A summary about this recommendation, such as the currency code, the amount that AWS estimates that you could save, and the total amount of reservation to purchase.

Class ReservationUtilizationGroup

A group of Reserved Instances (RIs) that share a set of attributes.

Class ResultByTime

The result that is associated with a time period.

Class ServiceSpecification

Hardware specifications for the service that you want recommendations for.

Class TagValues

The values that are available for a tag.

Class UtilizationByTime

The amount of utilization, in hours.