Skip to content

Commit

Permalink
Updated service API models for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
AWS SDK for Ruby authored and Nobody committed Nov 16, 2018
1 parent 57ca0f4 commit a149fdf
Show file tree
Hide file tree
Showing 11 changed files with 1,354 additions and 92 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
@@ -1,6 +1,16 @@
Unreleased Changes
------------------

* Feature - Aws::CostExplorer - Updated the API, and documentation for AWS Cost Explorer Service.

* Feature - Aws::Comprehend - Updated the API, and documentation for Amazon Comprehend.

* Feature - Aws::ECS - Updated the API, and documentation for Amazon EC2 Container Service.

* Feature - Aws::SSM - Updated the API, and documentation for Amazon Simple Systems Manager (SSM).

* Feature - Aws::WorkSpaces - Updated the API, and documentation for Amazon WorkSpaces.

2.11.172 (2018-11-15)
------------------

Expand Down
65 changes: 65 additions & 0 deletions aws-sdk-core/apis/ce/2017-10-25/api-2.json
Expand Up @@ -30,6 +30,19 @@
{"shape":"RequestChangedException"}
]
},
"GetCostForecast":{
"name":"GetCostForecast",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCostForecastRequest"},
"output":{"shape":"GetCostForecastResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"DataUnavailableException"}
]
},
"GetDimensionValues":{
"name":"GetDimensionValues",
"http":{
Expand Down Expand Up @@ -284,6 +297,19 @@
"type":"list",
"member":{"shape":"Expression"}
},
"ForecastResult":{
"type":"structure",
"members":{
"TimePeriod":{"shape":"DateInterval"},
"MeanValue":{"shape":"GenericString"},
"PredictionIntervalLowerBound":{"shape":"GenericString"},
"PredictionIntervalUpperBound":{"shape":"GenericString"}
}
},
"ForecastResultsByTime":{
"type":"list",
"member":{"shape":"ForecastResult"}
},
"GenericBoolean":{"type":"boolean"},
"GenericString":{"type":"string"},
"GetCostAndUsageRequest":{
Expand All @@ -305,6 +331,28 @@
"ResultsByTime":{"shape":"ResultsByTime"}
}
},
"GetCostForecastRequest":{
"type":"structure",
"required":[
"TimePeriod",
"Metric",
"Granularity"
],
"members":{
"TimePeriod":{"shape":"DateInterval"},
"Metric":{"shape":"Metric"},
"Granularity":{"shape":"Granularity"},
"Filter":{"shape":"Expression"},
"PredictionIntervalLevel":{"shape":"PredictionIntervalLevel"}
}
},
"GetCostForecastResponse":{
"type":"structure",
"members":{
"Total":{"shape":"MetricValue"},
"ForecastResultsByTime":{"shape":"ForecastResultsByTime"}
}
},
"GetDimensionValuesRequest":{
"type":"structure",
"required":[
Expand Down Expand Up @@ -495,6 +543,18 @@
"SIXTY_DAYS"
]
},
"Metric":{
"type":"string",
"enum":[
"BLENDED_COST",
"UNBLENDED_COST",
"AMORTIZED_COST",
"NET_UNBLENDED_COST",
"NET_AMORTIZED_COST",
"USAGE_QUANTITY",
"NORMALIZED_USAGE_AMOUNT"
]
},
"MetricAmount":{"type":"string"},
"MetricName":{"type":"string"},
"MetricNames":{
Expand Down Expand Up @@ -541,6 +601,11 @@
"HEAVY_UTILIZATION"
]
},
"PredictionIntervalLevel":{
"type":"integer",
"max":99,
"min":51
},
"PurchasedHours":{"type":"string"},
"RDSInstanceDetails":{
"type":"structure",
Expand Down
43 changes: 43 additions & 0 deletions aws-sdk-core/apis/ce/2017-10-25/docs-2.json
Expand Up @@ -3,6 +3,7 @@
"service": "<p>The Cost Explorer API allows 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. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p>https://ce.us-east-1.amazonaws.com</p> </li> </ul> <p>For information about costs associated with the Cost Explorer API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>",
"operations": {
"GetCostAndUsage": "<p>Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> </code> operation. Master accounts in an organization in AWS Organizations have access to all member accounts.</p>",
"GetCostForecast": "<p>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. </p>",
"GetDimensionValues": "<p>Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. </p>",
"GetReservationCoverage": "<p>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:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>",
"GetReservationPurchaseRecommendation": "<p>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.</p> <p>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. </p> <p>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 <code>c4.large</code>, because that is the smallest size instance in the c4 instance family.</p>",
Expand Down Expand Up @@ -101,7 +102,9 @@
"base": "<p>The time period that you want the usage and costs for. </p>",
"refs": {
"CoverageByTime$TimePeriod": "<p>The period over which this coverage was used.</p>",
"ForecastResult$TimePeriod": "<p>The period of time that the forecast covers.</p>",
"GetCostAndUsageRequest$TimePeriod": "<p>Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetCostForecastRequest$TimePeriod": "<p>The period of time that you want the forecast to cover.</p>",
"GetDimensionValuesRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetReservationCoverageRequest$TimePeriod": "<p>The start and end dates of the period for which you want to retrieve data about reservation coverage. 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 <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetReservationUtilizationRequest$TimePeriod": "<p>Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
Expand Down Expand Up @@ -187,6 +190,7 @@
"Expression$Not": "<p>Return results that don't match a <code>Dimension</code> object.</p>",
"Expressions$member": null,
"GetCostAndUsageRequest$Filter": "<p>Filters AWS costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p>",
"GetCostForecastRequest$Filter": "<p>The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.</p>",
"GetReservationCoverageRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> 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.</p> <p>If you don't provide a <code>SERVICE</code> filter, Cost Explorer defaults to EC2.</p>",
"GetReservationUtilizationRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> 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.</p>"
}
Expand All @@ -198,6 +202,18 @@
"Expression$And": "<p>Return results that match both <code>Dimension</code> objects.</p>"
}
},
"ForecastResult": {
"base": "<p>The forecast created for your query.</p>",
"refs": {
"ForecastResultsByTime$member": null
}
},
"ForecastResultsByTime": {
"base": null,
"refs": {
"GetCostForecastResponse$ForecastResultsByTime": "<p>The forecasts for your query, in order. For <code>DAILY</code> forecasts, this is a list of days. For <code>MONTHLY</code> forecasts, this is a list of months.</p>"
}
},
"GenericBoolean": {
"base": null,
"refs": {
Expand Down Expand Up @@ -229,6 +245,9 @@
"ElastiCacheInstanceDetails$NodeType": "<p>The type of node that AWS recommends.</p>",
"ElastiCacheInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"ElastiCacheInstanceDetails$ProductDescription": "<p>The description of the recommended reservation.</p>",
"ForecastResult$MeanValue": "<p>The mean value of the forecast.</p>",
"ForecastResult$PredictionIntervalLowerBound": "<p>The lower limit for the prediction interval. </p>",
"ForecastResult$PredictionIntervalUpperBound": "<p>The upper limit for the prediction interval. </p>",
"GetReservationPurchaseRecommendationRequest$AccountId": "<p>The account ID that is associated with the recommendation. </p>",
"GetReservationPurchaseRecommendationRequest$Service": "<p>The specific service that you want recommendations for.</p>",
"RDSInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
Expand Down Expand Up @@ -276,6 +295,16 @@
"refs": {
}
},
"GetCostForecastRequest": {
"base": null,
"refs": {
}
},
"GetCostForecastResponse": {
"base": null,
"refs": {
}
},
"GetDimensionValuesRequest": {
"base": null,
"refs": {
Expand Down Expand Up @@ -330,6 +359,7 @@
"base": null,
"refs": {
"GetCostAndUsageRequest$Granularity": "<p>Sets the AWS cost granularity to <code>MONTHLY</code> or <code>DAILY</code>. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. </p>",
"GetCostForecastRequest$Granularity": "<p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 12 months of <code>MONTHLY</code> forecasts.</p>",
"GetReservationCoverageRequest$Granularity": "<p>The granularity of the AWS cost data for the reservation. Valid values are <code>MONTHLY</code> and <code>DAILY</code>.</p> <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>.</p>",
"GetReservationUtilizationRequest$Granularity": "<p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. If both <code>GroupBy</code> and <code>Granularity</code> aren't set, <code>GetReservationUtilization</code> defaults to <code>DAILY</code>.</p>"
}
Expand Down Expand Up @@ -408,6 +438,12 @@
"ReservationPurchaseRecommendation$LookbackPeriodInDays": "<p>How many days of previous usage that AWS considers when making this recommendation.</p>"
}
},
"Metric": {
"base": null,
"refs": {
"GetCostForecastRequest$Metric": "<p>Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values for a <code>GetCostForecast</code> call are the following:</p> <ul> <li> <p>AmortizedCost</p> </li> <li> <p>BlendedCost</p> </li> <li> <p>NetAmortizedCost</p> </li> <li> <p>NetUnblendedCost</p> </li> <li> <p>UnblendedCost</p> </li> </ul>"
}
},
"MetricAmount": {
"base": null,
"refs": {
Expand Down Expand Up @@ -436,6 +472,7 @@
"MetricValue": {
"base": "<p>The aggregated value for a metric.</p>",
"refs": {
"GetCostForecastResponse$Total": "<p>How much you are forecasted to spend over the forecast period, in <code>USD</code>.</p>",
"Metrics$value": null
}
},
Expand Down Expand Up @@ -509,6 +546,12 @@
"ReservationPurchaseRecommendation$PaymentOption": "<p>The payment option for the reservation. For example, <code>AllUpfront</code> or <code>NoUpfront</code>.</p>"
}
},
"PredictionIntervalLevel": {
"base": null,
"refs": {
"GetCostForecastRequest$PredictionIntervalLevel": "<p>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.</p>"
}
},
"PurchasedHours": {
"base": null,
"refs": {
Expand Down

0 comments on commit a149fdf

Please sign in to comment.