Skip to content

Commit

Permalink
Updated API models and rebuilt service gems.
Browse files Browse the repository at this point in the history
  • Loading branch information
AWS SDK for Ruby authored and Nobody committed Sep 19, 2018
1 parent e091a9d commit 03f8030
Show file tree
Hide file tree
Showing 24 changed files with 939 additions and 288 deletions.
29 changes: 29 additions & 0 deletions apis/monitoring/2010-08-01/api-2.json
Expand Up @@ -148,6 +148,18 @@
{"shape":"InternalServiceFault"}
]
},
"GetMetricWidgetImage":{
"name":"GetMetricWidgetImage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetMetricWidgetImageInput"},
"output":{
"shape":"GetMetricWidgetImageOutput",
"resultWrapper":"GetMetricWidgetImageResult"
}
},
"ListDashboards":{
"name":"ListDashboards",
"http":{
Expand Down Expand Up @@ -620,6 +632,20 @@
"Datapoints":{"shape":"Datapoints"}
}
},
"GetMetricWidgetImageInput":{
"type":"structure",
"required":["MetricWidget"],
"members":{
"MetricWidget":{"shape":"MetricWidget"},
"OutputFormat":{"shape":"OutputFormat"}
}
},
"GetMetricWidgetImageOutput":{
"type":"structure",
"members":{
"MetricWidgetImage":{"shape":"MetricWidgetImage"}
}
},
"HistoryData":{
"type":"string",
"max":4095,
Expand Down Expand Up @@ -919,6 +945,8 @@
"Unit":{"shape":"StandardUnit"}
}
},
"MetricWidget":{"type":"string"},
"MetricWidgetImage":{"type":"blob"},
"Metrics":{
"type":"list",
"member":{"shape":"Metric"}
Expand Down Expand Up @@ -947,6 +975,7 @@
"max":1024,
"min":0
},
"OutputFormat":{"type":"string"},
"Period":{
"type":"integer",
"min":1
Expand Down
29 changes: 29 additions & 0 deletions apis/monitoring/2010-08-01/docs-2.json
Expand Up @@ -12,6 +12,7 @@
"GetDashboard": "<p>Displays the details of the dashboard that you specify.</p> <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code> to create the copy.</p>",
"GetMetricData": "<p>You can use the <code>GetMetricData</code> API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than calls to <code>GetMetricStatistics</code>. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p>",
"GetMetricStatistics": "<p>Gets statistics for the specified metric.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.</p> <p>CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The SampleCount value of the statistic set is 1.</p> </li> <li> <p>The Min and the Max values of the statistic set are equal.</p> </li> </ul> <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p> <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p> <p>For information about metrics and dimensions supported by AWS services, see the <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User Guide</i>.</p>",
"GetMetricWidgetImage": "<p>You can use the <code>GetMetricWidgetImage</code> API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.</p> <p>The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.</p> <p>There is a limit of 20 transactions per second for this API. Each <code>GetMetricWidgetImage</code> action has the following limits:</p> <ul> <li> <p>As many as 100 metrics in the graph.</p> </li> <li> <p>Up to 100 KB uncompressed payload.</p> </li> </ul>",
"ListDashboards": "<p>Returns a list of the dashboards for your account. If you include <code>DashboardNamePrefix</code>, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. </p> <p> <code>ListDashboards</code> returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call <code>ListDashboards</code> again and include the value you received for <code>NextToken</code> in the first call, to receive the next 1000 results.</p>",
"ListMetrics": "<p>List the specified metrics. You can use the returned metrics with <a>GetMetricData</a> or <a>GetMetricStatistics</a> to obtain statistical data.</p> <p>Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.</p> <p>After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using <a>GetMetricData</a> or <a>GetMetricStatistics</a>.</p>",
"PutDashboard": "<p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.</p> <p>There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific.</p> <p>A simple way to create a dashboard using <code>PutDashboard</code> is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use <code>GetDashboard</code>, and then use the data returned within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code>.</p> <p>When you create a dashboard with <code>PutDashboard</code>, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the <code>DashboardBody</code> script or the CloudFormation template used to create the dashboard.</p>",
Expand Down Expand Up @@ -418,6 +419,16 @@
"refs": {
}
},
"GetMetricWidgetImageInput": {
"base": null,
"refs": {
}
},
"GetMetricWidgetImageOutput": {
"base": null,
"refs": {
}
},
"HistoryData": {
"base": null,
"refs": {
Expand Down Expand Up @@ -625,6 +636,18 @@
"MetricDataQuery$MetricStat": "<p>The metric to be returned, along with statistics, period, and units. Use this parameter only if this structure is performing a data retrieval and not performing a math expression on the returned data.</p> <p>Within one MetricDataQuery structure, you must specify either <code>Expression</code> or <code>MetricStat</code> but not both.</p>"
}
},
"MetricWidget": {
"base": null,
"refs": {
"GetMetricWidgetImageInput$MetricWidget": "<p>A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one <code>MetricWidget</code> parameter in each <code>GetMetricWidgetImage</code> call.</p> <p>For more information about the syntax of <code>MetricWidget</code> see <a>CloudWatch-Metric-Widget-Structure</a>.</p> <p>If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.</p>"
}
},
"MetricWidgetImage": {
"base": null,
"refs": {
"GetMetricWidgetImageOutput$MetricWidgetImage": "<p>The image of the graph, in the output format specified.</p>"
}
},
"Metrics": {
"base": null,
"refs": {
Expand Down Expand Up @@ -663,6 +686,12 @@
"ListMetricsOutput$NextToken": "<p>The token that marks the start of the next batch of returned results.</p>"
}
},
"OutputFormat": {
"base": null,
"refs": {
"GetMetricWidgetImageInput$OutputFormat": "<p>The format of the resulting image. Only PNG images are supported.</p> <p>The default is <code>png</code>. If you specify <code>png</code>, the API returns an HTTP response with the content-type set to <code>text/xml</code>. The image data is in a <code>MetricWidgetImage</code> field. For example:</p> <p> <code> &lt;GetMetricWidgetImageResponse xmlns=\"http://monitoring.amazonaws.com/doc/2010-08-01/\"&gt;</code> </p> <p> <code> &lt;GetMetricWidgetImageResult&gt;</code> </p> <p> <code> &lt;MetricWidgetImage&gt;</code> </p> <p> <code> iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...</code> </p> <p> <code> &lt;/MetricWidgetImage&gt;</code> </p> <p> <code> &lt;/GetMetricWidgetImageResult&gt;</code> </p> <p> <code> &lt;ResponseMetadata&gt;</code> </p> <p> <code> &lt;RequestId&gt;6f0d4192-4d42-11e8-82c1-f539a07e0e3b&lt;/RequestId&gt;</code> </p> <p> <code> &lt;/ResponseMetadata&gt;</code> </p> <p> <code>&lt;/GetMetricWidgetImageResponse&gt;</code> </p> <p>The <code>image/png</code> setting is intended only for custom HTTP requests. For most use cases, and all actions using an AWS SDK, you should use <code>png</code>. If you specify <code>image/png</code>, the HTTP response has a content-type set to <code>image/png</code>, and the body of the response is a PNG image. </p>"
}
},
"Period": {
"base": null,
"refs": {
Expand Down
14 changes: 12 additions & 2 deletions apis/organizations/2016-11-28/api-2.json
Expand Up @@ -10,7 +10,6 @@
"serviceId":"Organizations",
"signatureVersion":"v4",
"targetPrefix":"AWSOrganizationsV20161128",
"timestampFormat":"unixTimestamp",
"uid":"organizations-2016-11-28"
},
"operations":{
Expand Down Expand Up @@ -450,6 +449,7 @@
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"AWSOrganizationsNotInUseException"},
{"shape":"AccountOwnerNotVerifiedException"},
{"shape":"ConcurrentModificationException"},
{"shape":"HandshakeConstraintViolationException"},
{"shape":"DuplicateHandshakeException"},
Expand Down Expand Up @@ -844,6 +844,7 @@
"type":"string",
"max":50,
"min":1,
"pattern":"[\\u0020-\\u007E]+",
"sensitive":true
},
"AccountNotFoundException":{
Expand All @@ -853,6 +854,13 @@
},
"exception":true
},
"AccountOwnerNotVerifiedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"exception":true
},
"AccountStatus":{
"type":"string",
"enum":[
Expand Down Expand Up @@ -967,7 +975,9 @@
"ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED",
"MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE",
"MASTER_ACCOUNT_MISSING_CONTACT_INFO",
"ORGANIZATION_NOT_IN_ALL_FEATURES_MODE"
"ORGANIZATION_NOT_IN_ALL_FEATURES_MODE",
"EMAIL_VERIFICATION_CODE_EXPIRED",
"WAIT_PERIOD_ACTIVE"
]
},
"CreateAccountFailureReason":{
Expand Down

0 comments on commit 03f8030

Please sign in to comment.