Skip to content

Commit

Permalink
docs(client-cloudwatch): Doc-only update to incorporate several doc b…
Browse files Browse the repository at this point in the history 
…ug fixes
  • Loading branch information
awstools committed Aug 16, 2023
1 parent ad6d1ed commit 73b2240
Show file tree
Hide file tree
Showing 3 changed files with 6,831 additions and 6,800 deletions.
2 changes: 1 addition & 1 deletion clients/client-cloudwatch/src/endpoint/ruleset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ o={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[n,"supportsDualStack"]}]},
p=[j],
q=[k],
r=[{[v]:"Region"}];
const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]}]},{type:b,rules:[{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[m,o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://monitoring-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:f,[u]:[n,"name"]}]}],endpoint:{url:"https://monitoring.{Region}.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://monitoring-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://monitoring.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://monitoring.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]},{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[m,o],type:b,rules:[{endpoint:{url:"https://monitoring-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[m],type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:f,[u]:[n,"name"]}]}],endpoint:{url:"https://monitoring.{Region}.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://monitoring-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{endpoint:{url:"https://monitoring.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://monitoring.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]};
export const ruleSet: RuleSetObject = _data;
81 changes: 74 additions & 7 deletions clients/client-cloudwatch/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1394,8 +1394,13 @@ export interface DescribeAlarmsInput {

/**
* @public
* <p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter,
* only metric alarms are returned.</p>
* <p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you
* omit this parameter,
* only metric alarms are returned, even if composite alarms exist in the account.</p>
* <p>For example, if you omit this parameter or specify <code>MetricAlarms</code>, the operation returns only a list of metric
* alarms. It does not return any composite alarms, even if composite alarms exist in the account.</p>
* <p>If you specify <code>CompositeAlarms</code>, the operation returns only a list of composite
* alarms, and does not return any metric alarms.</p>
*/
AlarmTypes?: (AlarmType | string)[];

Expand Down Expand Up @@ -2164,7 +2169,7 @@ export interface GetInsightRuleReportInput {

/**
* @public
* <p>Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.</p>
* <p>Determines what statistic to use to rank the contributors. Valid values are <code>Sum</code> and <code>Maximum</code>.</p>
*/
OrderBy?: string;
}
Expand Down Expand Up @@ -4216,10 +4221,70 @@ export interface PutMetricAlarmInput {

/**
* @public
* <p>The percentile statistic for the metric specified in <code>MetricName</code>. Specify a value
* between p0.0 and p100. When you call <code>PutMetricAlarm</code> and specify
* <p>The extended statistic for the metric specified in <code>MetricName</code>. When you
* call <code>PutMetricAlarm</code> and specify
* a <code>MetricName</code>, you must
* specify either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>
* specify either <code>Statistic</code> or <code>ExtendedStatistic</code> but not both.</p>
* <p>If you specify <code>ExtendedStatistic</code>, the following are valid values:</p>
* <ul>
* <li>
* <p>
* <code>p90</code>
* </p>
* </li>
* <li>
* <p>
* <code>tm90</code>
* </p>
* </li>
* <li>
* <p>
* <code>tc90</code>
* </p>
* </li>
* <li>
* <p>
* <code>ts90</code>
* </p>
* </li>
* <li>
* <p>
* <code>wm90</code>
* </p>
* </li>
* <li>
* <p>
* <code>IQM</code>
* </p>
* </li>
* <li>
* <p>
* <code>PR(<i>n</i>:<i>m</i>)</code> where n and m are values
* of the metric</p>
* </li>
* <li>
* <p>
* <code>TC(<i>X</i>%:<i>X</i>%)</code> where X is between
* 10 and 90 inclusive.</p>
* </li>
* <li>
* <p>
* <code>TM(<i>X</i>%:<i>X</i>%)</code> where X is between
* 10 and 90 inclusive.</p>
* </li>
* <li>
* <p>
* <code>TS(<i>X</i>%:<i>X</i>%)</code> where X is between
* 10 and 90 inclusive.</p>
* </li>
* <li>
* <p>
* <code>WM(<i>X</i>%:<i>X</i>%)</code> where X is between
* 10 and 90 inclusive.</p>
* </li>
* </ul>
* <p>For more information about these extended statistics, see
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html">CloudWatch statistics definitions</a>.</p>
*/
ExtendedStatistic?: string;

Expand Down Expand Up @@ -4349,7 +4414,9 @@ export interface PutMetricAlarmInput {

/**
* @public
* <p>A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.</p>
* <p>A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
* To be able to associate tags with the alarm when you create the alarm, you must
* have the <code>cloudwatch:TagResource</code> permission.</p>
* <p>Tags can help you organize and categorize your resources. You can also use them to scope user
* permissions by granting a user
* permission to access or change only resources with certain tag values.</p>
Expand Down
Loading

0 comments on commit 73b2240

Please sign in to comment.