diff --git a/apis/comprehendmedical/2018-10-30/api-2.json b/apis/comprehendmedical/2018-10-30/api-2.json index 96769dbe584..bed14c9cf39 100644 --- a/apis/comprehendmedical/2018-10-30/api-2.json +++ b/apis/comprehendmedical/2018-10-30/api-2.json @@ -228,10 +228,12 @@ "Type":{"shape":"EntitySubType"}, "Score":{"shape":"Float"}, "RelationshipScore":{"shape":"Float"}, + "RelationshipType":{"shape":"RelationshipType"}, "Id":{"shape":"Integer"}, "BeginOffset":{"shape":"Integer"}, "EndOffset":{"shape":"Integer"}, "Text":{"shape":"String"}, + "Category":{"shape":"EntityType"}, "Traits":{"shape":"TraitList"} } }, @@ -424,7 +426,13 @@ "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", - "QUANTITY" + "QUANTITY", + "TIME_EXPRESSION", + "TIME_TO_MEDICATION_NAME", + "TIME_TO_DX_NAME", + "TIME_TO_TEST_NAME", + "TIME_TO_PROCEDURE_NAME", + "TIME_TO_TREATMENT_NAME" ] }, "EntityType":{ @@ -434,7 +442,8 @@ "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", - "ANATOMY" + "ANATOMY", + "TIME_EXPRESSION" ] }, "Float":{"type":"float"}, @@ -681,6 +690,28 @@ "S3Key":{"shape":"S3Key"} } }, + "RelationshipType":{ + "type":"string", + "enum":[ + "EVERY", + "WITH_DOSAGE", + "ADMINISTERED_VIA", + "FOR", + "NEGATIVE", + "OVERLAP", + "DOSAGE", + "ROUTE_OR_MODE", + "FORM", + "FREQUENCY", + "DURATION", + "STRENGTH", + "RATE", + "ACUITY", + "TEST_VALUE", + "TEST_UNITS", + "DIRECTION" + ] + }, "ResourceNotFoundException":{ "type":"structure", "members":{ diff --git a/apis/comprehendmedical/2018-10-30/docs-2.json b/apis/comprehendmedical/2018-10-30/docs-2.json index 133933ba44b..a62cfc5778f 100644 --- a/apis/comprehendmedical/2018-10-30/docs-2.json +++ b/apis/comprehendmedical/2018-10-30/docs-2.json @@ -5,10 +5,10 @@ "DescribeEntitiesDetectionV2Job": "

Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

", "DescribePHIDetectionJob": "

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

", "DetectEntities": "

The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .

", - "DetectEntitiesV2": "

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.

", - "DetectPHI": "

Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.

", - "InferICD10CM": "

InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control.

", - "InferRxNorm": "

InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine.

", + "DetectEntitiesV2": "

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.

", + "DetectPHI": "

Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.

", + "InferICD10CM": "

InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.

", + "InferRxNorm": "

InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.

", "ListEntitiesDetectionV2Jobs": "

Gets a list of medical entity detection jobs that you have submitted.

", "ListPHIDetectionJobs": "

Gets a list of protected health information (PHI) detection jobs that you have submitted.

", "StartEntitiesDetectionV2Job": "

Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.

", @@ -153,6 +153,7 @@ "EntityType": { "base": null, "refs": { + "Attribute$Category": "

The category of attribute.

", "Entity$Category": "

The category of the entity.

", "UnmappedAttribute$Type": "

The type of the attribute, could be one of the following values: \"MEDICATION\", \"MEDICAL_CONDITION\", \"ANATOMY\", \"TEST_AND_TREATMENT_PROCEDURE\" or \"PROTECTED_HEALTH_INFORMATION\".

" } @@ -278,7 +279,7 @@ } }, "InputDataConfig": { - "base": "

The input properties for an entities detection job

", + "base": "

The input properties for an entities detection job.

", "refs": { "ComprehendMedicalAsyncJobProperties$InputDataConfig": "

The input data configuration that you supplied when you created the detection job.

", "StartEntitiesDetectionV2JobRequest$InputDataConfig": "

Specifies the format and location of the input data for the job.

", @@ -425,6 +426,12 @@ "StartPHIDetectionJobRequest$OutputDataConfig": "

Specifies where to send the output files.

" } }, + "RelationshipType": { + "base": null, + "refs": { + "Attribute$RelationshipType": "

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

" + } + }, "ResourceNotFoundException": { "base": "

The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.

", "refs": { diff --git a/apis/monitoring/2010-08-01/api-2.json b/apis/monitoring/2010-08-01/api-2.json index 319a25f77bf..e4eb57d6493 100644 --- a/apis/monitoring/2010-08-01/api-2.json +++ b/apis/monitoring/2010-08-01/api-2.json @@ -343,6 +343,17 @@ {"shape":"MissingRequiredParameterException"} ] }, + "PutCompositeAlarm":{ + "name":"PutCompositeAlarm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutCompositeAlarmInput"}, + "errors":[ + {"shape":"LimitExceededFault"} + ] + }, "PutDashboard":{ "name":"PutDashboard", "http":{ @@ -471,6 +482,7 @@ "type":"structure", "members":{ "AlarmName":{"shape":"AlarmName"}, + "AlarmType":{"shape":"AlarmType"}, "Timestamp":{"shape":"Timestamp"}, "HistoryItemType":{"shape":"HistoryItemType"}, "HistorySummary":{"shape":"HistorySummary"}, @@ -496,6 +508,22 @@ "member":{"shape":"AlarmName"}, "max":100 }, + "AlarmRule":{ + "type":"string", + "max":10240, + "min":1 + }, + "AlarmType":{ + "type":"string", + "enum":[ + "CompositeAlarm", + "MetricAlarm" + ] + }, + "AlarmTypes":{ + "type":"list", + "member":{"shape":"AlarmType"} + }, "AmazonResourceName":{ "type":"string", "max":1024, @@ -553,6 +581,43 @@ "GreaterThanUpperThreshold" ] }, + "CompositeAlarm":{ + "type":"structure", + "members":{ + "ActionsEnabled":{"shape":"ActionsEnabled"}, + "AlarmActions":{"shape":"ResourceList"}, + "AlarmArn":{"shape":"AlarmArn"}, + "AlarmConfigurationUpdatedTimestamp":{"shape":"Timestamp"}, + "AlarmDescription":{"shape":"AlarmDescription"}, + "AlarmName":{"shape":"AlarmName"}, + "AlarmRule":{"shape":"AlarmRule"}, + "InsufficientDataActions":{"shape":"ResourceList"}, + "OKActions":{"shape":"ResourceList"}, + "StateReason":{"shape":"StateReason"}, + "StateReasonData":{"shape":"StateReasonData"}, + "StateUpdatedTimestamp":{"shape":"Timestamp"}, + "StateValue":{"shape":"StateValue"} + }, + "xmlOrder":[ + "ActionsEnabled", + "AlarmActions", + "AlarmArn", + "AlarmConfigurationUpdatedTimestamp", + "AlarmDescription", + "AlarmName", + "AlarmRule", + "InsufficientDataActions", + "OKActions", + "StateReason", + "StateReasonData", + "StateUpdatedTimestamp", + "StateValue" + ] + }, + "CompositeAlarms":{ + "type":"list", + "member":{"shape":"CompositeAlarm"} + }, "ConcurrentModificationException":{ "type":"structure", "members":{ @@ -723,11 +788,13 @@ "type":"structure", "members":{ "AlarmName":{"shape":"AlarmName"}, + "AlarmTypes":{"shape":"AlarmTypes"}, "HistoryItemType":{"shape":"HistoryItemType"}, "StartDate":{"shape":"Timestamp"}, "EndDate":{"shape":"Timestamp"}, "MaxRecords":{"shape":"MaxRecords"}, - "NextToken":{"shape":"NextToken"} + "NextToken":{"shape":"NextToken"}, + "ScanBy":{"shape":"ScanBy"} } }, "DescribeAlarmHistoryOutput":{ @@ -764,6 +831,9 @@ "members":{ "AlarmNames":{"shape":"AlarmNames"}, "AlarmNamePrefix":{"shape":"AlarmNamePrefix"}, + "AlarmTypes":{"shape":"AlarmTypes"}, + "ChildrenOfAlarmName":{"shape":"AlarmName"}, + "ParentsOfAlarmName":{"shape":"AlarmName"}, "StateValue":{"shape":"StateValue"}, "ActionPrefix":{"shape":"ActionPrefix"}, "MaxRecords":{"shape":"MaxRecords"}, @@ -773,6 +843,7 @@ "DescribeAlarmsOutput":{ "type":"structure", "members":{ + "CompositeAlarms":{"shape":"CompositeAlarms"}, "MetricAlarms":{"shape":"MetricAlarms"}, "NextToken":{"shape":"NextToken"} } @@ -1550,6 +1621,23 @@ "members":{ } }, + "PutCompositeAlarmInput":{ + "type":"structure", + "required":[ + "AlarmName", + "AlarmRule" + ], + "members":{ + "ActionsEnabled":{"shape":"ActionsEnabled"}, + "AlarmActions":{"shape":"ResourceList"}, + "AlarmDescription":{"shape":"AlarmDescription"}, + "AlarmName":{"shape":"AlarmName"}, + "AlarmRule":{"shape":"AlarmRule"}, + "InsufficientDataActions":{"shape":"ResourceList"}, + "OKActions":{"shape":"ResourceList"}, + "Tags":{"shape":"TagList"} + } + }, "PutDashboardInput":{ "type":"structure", "required":[ diff --git a/apis/monitoring/2010-08-01/docs-2.json b/apis/monitoring/2010-08-01/docs-2.json index 7a57deab8d7..ed7494f4058 100644 --- a/apis/monitoring/2010-08-01/docs-2.json +++ b/apis/monitoring/2010-08-01/docs-2.json @@ -2,12 +2,12 @@ "version": "2.0", "service": "

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

", "operations": { - "DeleteAlarms": "

Deletes the specified alarms. You can delete up to 50 alarms in one operation. In the event of an error, no alarms are deleted.

", + "DeleteAlarms": "

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

In the event of an error, no alarms are deleted.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

", "DeleteAnomalyDetector": "

Deletes the specified anomaly detection model from your account.

", "DeleteDashboards": "

Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

", "DeleteInsightRules": "

Permanently deletes the specified Contributor Insights rules.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created may or may not be available.

", - "DescribeAlarmHistory": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

", - "DescribeAlarms": "

Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

", + "DescribeAlarmHistory": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

", + "DescribeAlarms": "

Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.

", "DescribeAlarmsForMetric": "

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

", "DescribeAnomalyDetectors": "

Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.

", "DescribeInsightRules": "

Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation.

For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.

", @@ -17,18 +17,19 @@ "EnableInsightRules": "

Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.

", "GetDashboard": "

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

", "GetInsightRuleReport": "

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

", - "GetMetricData": "

You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 data points. 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 Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

Amazon CloudWatch retains metric data as follows:

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.

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

", + "GetMetricData": "

You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. 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 Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

Amazon CloudWatch retains metric data as follows:

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.

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

", "GetMetricStatistics": "

Gets statistics for the specified metric.

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.

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.

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:

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Amazon CloudWatch retains metric data as follows:

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.

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

", "GetMetricWidgetImage": "

You can use the GetMetricWidgetImage 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.

The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

", "ListDashboards": "

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

", - "ListMetrics": "

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.

", + "ListMetrics": "

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.

", "ListTagsForResource": "

Displays the tags associated with a CloudWatch resource. Alarms support tagging.

", "PutAnomalyDetector": "

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.

For more information, see CloudWatch Anomaly Detection.

", + "PutCompositeAlarm": "

Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

", "PutDashboard": "

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.

All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard 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 GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, 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 DashboardBody script or the CloudFormation template used to create the dashboard.

", "PutInsightRule": "

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created may or may not be available.

", "PutMetricAlarm": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Alarms based on anomaly detection models cannot have Auto Scaling actions.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.

If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.

The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.

", - "PutMetricData": "

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted.

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:

", - "SetAlarmState": "

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

", + "PutMetricData": "

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.

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:

", + "SetAlarmState": "

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.

Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It will return to its actual state only once any of its children alarms change state. It is also re-evaluated if you update its configuration.

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.

", "TagResource": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms.

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.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

", "UntagResource": "

Removes one or more tags from the specified resource.

" }, @@ -36,26 +37,31 @@ "ActionPrefix": { "base": null, "refs": { - "DescribeAlarmsInput$ActionPrefix": "

The action name prefix.

" + "DescribeAlarmsInput$ActionPrefix": "

Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.

" } }, "ActionsEnabled": { "base": null, "refs": { + "CompositeAlarm$ActionsEnabled": "

Indicates whether actions should be executed during any changes to the alarm state.

", "MetricAlarm$ActionsEnabled": "

Indicates whether actions should be executed during any changes to the alarm state.

", + "PutCompositeAlarmInput$ActionsEnabled": "

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.

", "PutMetricAlarmInput$ActionsEnabled": "

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

" } }, "AlarmArn": { "base": null, "refs": { + "CompositeAlarm$AlarmArn": "

The Amazon Resource Name (ARN) of the alarm.

", "MetricAlarm$AlarmArn": "

The Amazon Resource Name (ARN) of the alarm.

" } }, "AlarmDescription": { "base": null, "refs": { + "CompositeAlarm$AlarmDescription": "

The description of the alarm.

", "MetricAlarm$AlarmDescription": "

The description of the alarm.

", + "PutCompositeAlarmInput$AlarmDescription": "

The description for the composite alarm.

", "PutMetricAlarmInput$AlarmDescription": "

The description for the alarm.

" } }, @@ -76,8 +82,12 @@ "refs": { "AlarmHistoryItem$AlarmName": "

The descriptive name for the alarm.

", "AlarmNames$member": null, + "CompositeAlarm$AlarmName": "

The name of the alarm.

", "DescribeAlarmHistoryInput$AlarmName": "

The name of the alarm.

", + "DescribeAlarmsInput$ChildrenOfAlarmName": "

If you use this parameter and specify the name of a composite alarm, the operation returns information about the \"children\" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. Information about the composite alarm that you name in ChildrenOfAlarmName is not returned.

If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you will receive a validation error.

Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

", + "DescribeAlarmsInput$ParentsOfAlarmName": "

If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the \"parent\" alarms of the alarm you specify. These are the composite alarms that have AlarmRule parameters that reference the alarm named in ParentsOfAlarmName. Information about the alarm that you specify in ParentsOfAlarmName is not returned.

If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you will receive a validation error.

Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

", "MetricAlarm$AlarmName": "

The name of the alarm.

", + "PutCompositeAlarmInput$AlarmName": "

The name for the composite alarm. This name must be unique within your AWS account.

", "PutMetricAlarmInput$AlarmName": "

The name for the alarm. This name must be unique within your AWS account.

", "SetAlarmStateInput$AlarmName": "

The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.

" } @@ -85,18 +95,39 @@ "AlarmNamePrefix": { "base": null, "refs": { - "DescribeAlarmsInput$AlarmNamePrefix": "

The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

" + "DescribeAlarmsInput$AlarmNamePrefix": "

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.

If this parameter is specified, you cannot specify AlarmNames.

" } }, "AlarmNames": { "base": null, "refs": { "DeleteAlarmsInput$AlarmNames": "

The alarms to be deleted.

", - "DescribeAlarmsInput$AlarmNames": "

The names of the alarms.

", + "DescribeAlarmsInput$AlarmNames": "

The names of the alarms to retrieve information about.

", "DisableAlarmActionsInput$AlarmNames": "

The names of the alarms.

", "EnableAlarmActionsInput$AlarmNames": "

The names of the alarms.

" } }, + "AlarmRule": { + "base": null, + "refs": { + "CompositeAlarm$AlarmRule": "

The rule that this alarm uses to evaluate its alarm state.

", + "PutCompositeAlarmInput$AlarmRule": "

An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.

You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.

Functions can include the following:

TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.

Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.

The following are some examples of AlarmRule:

The AlarmRule can specify as many as 100 \"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.

" + } + }, + "AlarmType": { + "base": null, + "refs": { + "AlarmHistoryItem$AlarmType": "

The type of alarm, either metric alarm or composite alarm.

", + "AlarmTypes$member": null + } + }, + "AlarmTypes": { + "base": null, + "refs": { + "DescribeAlarmHistoryInput$AlarmTypes": "

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.

", + "DescribeAlarmsInput$AlarmTypes": "

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.

" + } + }, "AmazonResourceName": { "base": null, "refs": { @@ -165,6 +196,18 @@ "PutMetricAlarmInput$ComparisonOperator": "

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.

" } }, + "CompositeAlarm": { + "base": "

The details about a composite alarm.

", + "refs": { + "CompositeAlarms$member": null + } + }, + "CompositeAlarms": { + "base": null, + "refs": { + "DescribeAlarmsOutput$CompositeAlarms": "

The information about any composite alarms returned by the operation.

" + } + }, "ConcurrentModificationException": { "base": "

More than one process tried to modify a resource at the same time.

", "refs": { @@ -186,8 +229,8 @@ "DashboardBody": { "base": null, "refs": { - "GetDashboardOutput$DashboardBody": "

The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see CloudWatch-Dashboard-Body-Structure.

", - "PutDashboardInput$DashboardBody": "

The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

For more information about the syntax, see CloudWatch-Dashboard-Body-Structure.

" + "GetDashboardOutput$DashboardBody": "

The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see Dashboard Body Structure and Syntax.

", + "PutDashboardInput$DashboardBody": "

The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

For more information about the syntax, see Dashboard Body Structure and Syntax.

" } }, "DashboardEntries": { @@ -629,13 +672,13 @@ } }, "InsightRuleContributor": { - "base": "

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

If the rule contains a single key, then each unique contributor is each unique value for this key.

For more information, see GetInsightRuleReport.

", + "base": "

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

If the rule contains a single key, then each unique contributor is each unique value for this key.

For more information, see GetInsightRuleReport.

", "refs": { "InsightRuleContributors$member": null } }, "InsightRuleContributorDatapoint": { - "base": "

One data point related to one contributor.

For more information, see GetInsightRuleReport and InsightRuleContributor.

", + "base": "

One data point related to one contributor.

For more information, see GetInsightRuleReport and InsightRuleContributor.

", "refs": { "InsightRuleContributorDatapoints$member": null } @@ -690,7 +733,7 @@ } }, "InsightRuleMetricDatapoint": { - "base": "

One data point from the metric time series returned in a Contributor Insights rule report.

For more information, see GetInsightRuleReport.

", + "base": "

One data point from the metric time series returned in a Contributor Insights rule report.

For more information, see GetInsightRuleReport.

", "refs": { "InsightRuleMetricDatapoints$member": null } @@ -725,9 +768,9 @@ "InsightRuleNames": { "base": null, "refs": { - "DeleteInsightRulesInput$RuleNames": "

An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.

", - "DisableInsightRulesInput$RuleNames": "

An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.

", - "EnableInsightRulesInput$RuleNames": "

An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.

" + "DeleteInsightRulesInput$RuleNames": "

An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.

", + "DisableInsightRulesInput$RuleNames": "

An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.

", + "EnableInsightRulesInput$RuleNames": "

An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.

" } }, "InsightRuleOrderBy": { @@ -863,7 +906,7 @@ "MaxReturnedResultsCount": { "base": null, "refs": { - "DescribeAnomalyDetectorsInput$MaxResults": "

The maximum number of results to return in one operation. The maximum value you can specify is 10.

To retrieve the remaining results, make another call with the returned NextToken value.

" + "DescribeAnomalyDetectorsInput$MaxResults": "

The maximum number of results to return in one operation. The maximum value that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

" } }, "Message": { @@ -898,7 +941,7 @@ } }, "MetricAlarm": { - "base": "

Represents an alarm.

", + "base": "

The details about a metric alarm.

", "refs": { "MetricAlarms$member": null } @@ -907,7 +950,7 @@ "base": null, "refs": { "DescribeAlarmsForMetricOutput$MetricAlarms": "

The information for each alarm with the specified metric.

", - "DescribeAlarmsOutput$MetricAlarms": "

The information for the specified alarms.

" + "DescribeAlarmsOutput$MetricAlarms": "

The information about any metric alarms returned by the operation.

" } }, "MetricData": { @@ -919,13 +962,13 @@ "MetricDataQueries": { "base": null, "refs": { - "GetMetricDataInput$MetricDataQueries": "

The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

", + "GetMetricDataInput$MetricDataQueries": "

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

", "MetricAlarm$Metrics": "

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnValue set to true.

", - "PutMetricAlarmInput$Metrics": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

Each item in the Metrics array either retrieves a metric or performs a math expression.

One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnValue to true for this object in the array. For more information, see MetricDataQuery.

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

" + "PutMetricAlarmInput$Metrics": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

Each item in the Metrics array either retrieves a metric or performs a math expression.

One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnValue to true for this object in the array. For more information, see MetricDataQuery.

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

" } }, "MetricDataQuery": { - "base": "

This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single GetMetricData call can include up to 100 MetricDataQuery structures.

When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have True as the value for ReturnData. The result of this expression is the value the alarm watches.

Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

", + "base": "

This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single GetMetricData call can include up to 500 MetricDataQuery structures.

When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have True as the value for ReturnData. The result of this expression is the value the alarm watches.

Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

", "refs": { "MetricDataQueries$member": null } @@ -1003,7 +1046,7 @@ "MetricWidget": { "base": null, "refs": { - "GetMetricWidgetImageInput$MetricWidget": "

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 MetricWidget parameter in each GetMetricWidgetImage call.

For more information about the syntax of MetricWidget see CloudWatch-Metric-Widget-Structure.

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.

" + "GetMetricWidgetImageInput$MetricWidget": "

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 MetricWidget parameter in each GetMetricWidgetImage call.

For more information about the syntax of MetricWidget see GetMetricWidgetImage: Metric Widget Structure and Syntax.

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.

" } }, "MetricWidgetImage": { @@ -1077,7 +1120,7 @@ "GetInsightRuleReportInput$Period": "

The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

", "GetMetricStatisticsInput$Period": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

", "MetricAlarm$Period": "

The period, in seconds, over which the statistic is applied.

", - "MetricDataQuery$Period": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.

If you are performing a GetMetricData operation, use this field only if you are specifying an Expression. Do not use this field when you are specifying a MetricStat in a GetMetricData operation.

", + "MetricDataQuery$Period": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.

", "MetricStat$Period": "

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

", "PutMetricAlarmInput$Period": "

The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.

Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

" } @@ -1092,6 +1135,11 @@ "refs": { } }, + "PutCompositeAlarmInput": { + "base": null, + "refs": { + } + }, "PutDashboardInput": { "base": null, "refs": { @@ -1137,12 +1185,18 @@ "ResourceList": { "base": null, "refs": { + "CompositeAlarm$AlarmActions": "

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

", + "CompositeAlarm$InsufficientDataActions": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

", + "CompositeAlarm$OKActions": "

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

", "MetricAlarm$OKActions": "

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

", "MetricAlarm$AlarmActions": "

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

", "MetricAlarm$InsufficientDataActions": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

", - "PutMetricAlarmInput$OKActions": "

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

", - "PutMetricAlarmInput$AlarmActions": "

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

", - "PutMetricAlarmInput$InsufficientDataActions": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

" + "PutCompositeAlarmInput$AlarmActions": "

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:sns:region:account-id:sns-topic-name

", + "PutCompositeAlarmInput$InsufficientDataActions": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:sns:region:account-id:sns-topic-name

", + "PutCompositeAlarmInput$OKActions": "

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:sns:region:account-id:sns-topic-name

", + "PutMetricAlarmInput$OKActions": "

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

", + "PutMetricAlarmInput$AlarmActions": "

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

", + "PutMetricAlarmInput$InsufficientDataActions": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

" } }, "ResourceName": { @@ -1176,6 +1230,7 @@ "ScanBy": { "base": null, "refs": { + "DescribeAlarmHistoryInput$ScanBy": "

Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.

", "GetMetricDataInput$ScanBy": "

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

" } }, @@ -1214,6 +1269,7 @@ "StateReason": { "base": null, "refs": { + "CompositeAlarm$StateReason": "

An explanation for the alarm state, in text format.

", "MetricAlarm$StateReason": "

An explanation for the alarm state, in text format.

", "SetAlarmStateInput$StateReason": "

The reason that this alarm is set to this specific state, in text format.

" } @@ -1221,14 +1277,16 @@ "StateReasonData": { "base": null, "refs": { + "CompositeAlarm$StateReasonData": "

An explanation for the alarm state, in JSON format.

", "MetricAlarm$StateReasonData": "

An explanation for the alarm state, in JSON format.

", - "SetAlarmStateInput$StateReasonData": "

The reason that this alarm is set to this specific state, in JSON format.

" + "SetAlarmStateInput$StateReasonData": "

The reason that this alarm is set to this specific state, in JSON format.

For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

" } }, "StateValue": { "base": null, "refs": { - "DescribeAlarmsInput$StateValue": "

The state value to be used in matching alarms.

", + "CompositeAlarm$StateValue": "

The state value for the alarm.

", + "DescribeAlarmsInput$StateValue": "

Specify this parameter to receive information only about alarms that are currently in the state that you specify.

", "MetricAlarm$StateValue": "

The state value for the alarm.

", "SetAlarmStateInput$StateValue": "

The value of the state.

" } @@ -1289,6 +1347,7 @@ "base": null, "refs": { "ListTagsForResourceOutput$Tags": "

The list of tag keys and values associated with the resource you specified.

", + "PutCompositeAlarmInput$Tags": "

A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.

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.

", "PutMetricAlarmInput$Tags": "

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

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.

", "TagResourceInput$Tags": "

The list of key-value pairs to associate with the alarm.

" } @@ -1320,6 +1379,8 @@ "base": null, "refs": { "AlarmHistoryItem$Timestamp": "

The time stamp for the alarm history item.

", + "CompositeAlarm$AlarmConfigurationUpdatedTimestamp": "

The time stamp of the last update to the alarm configuration.

", + "CompositeAlarm$StateUpdatedTimestamp": "

The time stamp of the last update to the alarm state.

", "Datapoint$Timestamp": "

The time stamp used for the data point.

", "DescribeAlarmHistoryInput$StartDate": "

The starting date to retrieve alarm history.

", "DescribeAlarmHistoryInput$EndDate": "

The ending date to retrieve alarm history.

", diff --git a/apis/monitoring/2010-08-01/paginators-1.json b/apis/monitoring/2010-08-01/paginators-1.json index c6c3444620e..2e351eb7fd2 100644 --- a/apis/monitoring/2010-08-01/paginators-1.json +++ b/apis/monitoring/2010-08-01/paginators-1.json @@ -10,7 +10,10 @@ "input_token": "NextToken", "limit_key": "MaxRecords", "output_token": "NextToken", - "result_key": "MetricAlarms" + "result_key": [ + "MetricAlarms", + "CompositeAlarms" + ] }, "DescribeAlarmsForMetric": { "result_key": "MetricAlarms" diff --git a/apis/monitoring/2010-08-01/resources-1.json b/apis/monitoring/2010-08-01/resources-1.json index 3ebda67d72b..2b829caba98 100644 --- a/apis/monitoring/2010-08-01/resources-1.json +++ b/apis/monitoring/2010-08-01/resources-1.json @@ -12,6 +12,17 @@ ] } }, + "CompositeAlarm": { + "resource": { + "type": "CompositeAlarm", + "identifiers": [ + { + "target": "Name", + "source": "input" + } + ] + } + }, "Metric": { "resource": { "type": "Metric", @@ -43,6 +54,20 @@ "path": "MetricAlarms[]" } }, + "CompositeAlarms": { + "request": { "operation": "DescribeAlarms" }, + "resource": { + "type": "CompositeAlarm", + "identifiers": [ + { + "target": "Name", + "source": "response", + "path": "CompositeAlarms[].AlarmName" + } + ], + "path": "CompositeAlarms[]" + } + }, "Metrics": { "request": { "operation": "ListMetrics" }, "resource": { @@ -218,6 +243,140 @@ } } }, + "CompositeAlarm": { + "identifiers": [ + { + "name": "Name", + "memberName": "AlarmName" + } + ], + "shape": "CompositeAlarm", + "load": { + "request": { + "operation": "DescribeAlarms", + "params": [ + { + "target": "AlarmNames[0]", + "source": "identifier", + "name": "Name" + } + ] + }, + "path": "CompositeAlarms[0]" + }, + "actions": { + "Delete": { + "request": { + "operation": "DeleteAlarms", + "params": [ + { + "target": "AlarmNames[0]", + "source": "identifier", + "name": "Name" + } + ] + } + }, + "DescribeHistory": { + "request": { + "operation": "DescribeAlarmHistory", + "params": [ + { + "target": "AlarmName", + "source": "identifier", + "name": "Name" + } + ] + } + }, + "DisableActions": { + "request": { + "operation": "DisableAlarmActions", + "params": [ + { + "target": "AlarmNames[0]", + "source": "identifier", + "name": "Name" + } + ] + } + }, + "EnableActions": { + "request": { + "operation": "EnableAlarmActions", + "params": [ + { + "target": "AlarmNames[0]", + "source": "identifier", + "name": "Name" + } + ] + } + }, + "SetState": { + "request": { + "operation": "SetAlarmState", + "params": [ + { + "target": "AlarmName", + "source": "identifier", + "name": "Name" + } + ] + } + } + }, + "batchActions": { + "Delete": { + "request": { + "operation": "DeleteAlarms", + "params": [ + { + "target": "AlarmNames[]", + "source": "identifier", + "name": "Name" + } + ] + } + }, + "DisableActions": { + "request": { + "operation": "DisableAlarmActions", + "params": [ + { + "target": "AlarmNames[]", + "source": "identifier", + "name": "Name" + } + ] + } + }, + "EnableActions": { + "request": { + "operation": "EnableAlarmActions", + "params": [ + { + "target": "AlarmNames[]", + "source": "identifier", + "name": "Name" + } + ] + } + } + }, + "waiters": { + "Exists": { + "waiterName": "CompositeAlarmExists", + "params": [ + { + "target": "AlarmNames[]", + "source": "identifier", + "name": "Name" + } + ] + } + } + }, "Metric": { "identifiers": [ { diff --git a/apis/monitoring/2010-08-01/waiters-2.json b/apis/monitoring/2010-08-01/waiters-2.json index cb0cf0bfe75..32803bba55e 100644 --- a/apis/monitoring/2010-08-01/waiters-2.json +++ b/apis/monitoring/2010-08-01/waiters-2.json @@ -13,6 +13,19 @@ "state": "success" } ] + }, + "CompositeAlarmExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeAlarms", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(CompositeAlarms[]) > `0`", + "state": "success" + } + ] } } } diff --git a/gems/aws-partitions/CHANGELOG.md b/gems/aws-partitions/CHANGELOG.md index a8b712017ab..36e11164ec0 100644 --- a/gems/aws-partitions/CHANGELOG.md +++ b/gems/aws-partitions/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.279.0 (2020-03-02) +------------------ + +* Feature - Updated the partitions source data the determines the AWS service regions and endpoints. + 1.278.0 (2020-02-27) ------------------ diff --git a/gems/aws-partitions/VERSION b/gems/aws-partitions/VERSION index f8c2fbc11eb..41a2731d5ad 100644 --- a/gems/aws-partitions/VERSION +++ b/gems/aws-partitions/VERSION @@ -1 +1 @@ -1.278.0 +1.279.0 diff --git a/gems/aws-partitions/partitions.json b/gems/aws-partitions/partitions.json index 25154a10085..84fb241c812 100644 --- a/gems/aws-partitions/partitions.json +++ b/gems/aws-partitions/partitions.json @@ -5455,6 +5455,12 @@ "endpoints" : { "us-gov-west-1" : { } } + }, + "xray" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } } } }, { diff --git a/gems/aws-sdk-accessanalyzer/CHANGELOG.md b/gems/aws-sdk-accessanalyzer/CHANGELOG.md index 0848e5ce015..f265d634243 100644 --- a/gems/aws-sdk-accessanalyzer/CHANGELOG.md +++ b/gems/aws-sdk-accessanalyzer/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.2.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.2.0 (2020-02-28) diff --git a/gems/aws-sdk-accessanalyzer/VERSION b/gems/aws-sdk-accessanalyzer/VERSION index 26aaba0e866..6085e946503 100644 --- a/gems/aws-sdk-accessanalyzer/VERSION +++ b/gems/aws-sdk-accessanalyzer/VERSION @@ -1 +1 @@ -1.2.0 +1.2.1 diff --git a/gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer.rb b/gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer.rb index ba3f1e78d04..983cdf8240e 100644 --- a/gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer.rb +++ b/gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer.rb @@ -42,6 +42,6 @@ # @service module Aws::AccessAnalyzer - GEM_VERSION = '1.2.0' + GEM_VERSION = '1.2.1' end diff --git a/gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb b/gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb index a60467b3049..2ccb564d6c8 100644 --- a/gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb +++ b/gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/client.rb @@ -1019,7 +1019,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-accessanalyzer' - context[:gem_version] = '1.2.0' + context[:gem_version] = '1.2.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-appmesh/CHANGELOG.md b/gems/aws-sdk-appmesh/CHANGELOG.md index b31d6d02bf8..b7362d9af55 100644 --- a/gems/aws-sdk-appmesh/CHANGELOG.md +++ b/gems/aws-sdk-appmesh/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.19.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.19.0 (2020-02-28) diff --git a/gems/aws-sdk-appmesh/VERSION b/gems/aws-sdk-appmesh/VERSION index 815d5ca06d5..66e2ae6c25c 100644 --- a/gems/aws-sdk-appmesh/VERSION +++ b/gems/aws-sdk-appmesh/VERSION @@ -1 +1 @@ -1.19.0 +1.19.1 diff --git a/gems/aws-sdk-appmesh/lib/aws-sdk-appmesh.rb b/gems/aws-sdk-appmesh/lib/aws-sdk-appmesh.rb index e03c9400327..a2283c0df9a 100644 --- a/gems/aws-sdk-appmesh/lib/aws-sdk-appmesh.rb +++ b/gems/aws-sdk-appmesh/lib/aws-sdk-appmesh.rb @@ -42,6 +42,6 @@ # @service module Aws::AppMesh - GEM_VERSION = '1.19.0' + GEM_VERSION = '1.19.1' end diff --git a/gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb b/gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb index 41197ddc96a..6f8d28cc577 100644 --- a/gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb +++ b/gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/client.rb @@ -2651,7 +2651,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-appmesh' - context[:gem_version] = '1.19.0' + context[:gem_version] = '1.19.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-augmentedairuntime/CHANGELOG.md b/gems/aws-sdk-augmentedairuntime/CHANGELOG.md index 35585152166..cad5221b72c 100644 --- a/gems/aws-sdk-augmentedairuntime/CHANGELOG.md +++ b/gems/aws-sdk-augmentedairuntime/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.1.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.1.0 (2020-02-28) diff --git a/gems/aws-sdk-augmentedairuntime/VERSION b/gems/aws-sdk-augmentedairuntime/VERSION index 9084fa2f716..524cb55242b 100644 --- a/gems/aws-sdk-augmentedairuntime/VERSION +++ b/gems/aws-sdk-augmentedairuntime/VERSION @@ -1 +1 @@ -1.1.0 +1.1.1 diff --git a/gems/aws-sdk-augmentedairuntime/lib/aws-sdk-augmentedairuntime.rb b/gems/aws-sdk-augmentedairuntime/lib/aws-sdk-augmentedairuntime.rb index 0d6639f6ead..8b6ec9c8f92 100644 --- a/gems/aws-sdk-augmentedairuntime/lib/aws-sdk-augmentedairuntime.rb +++ b/gems/aws-sdk-augmentedairuntime/lib/aws-sdk-augmentedairuntime.rb @@ -42,6 +42,6 @@ # @service module Aws::AugmentedAIRuntime - GEM_VERSION = '1.1.0' + GEM_VERSION = '1.1.1' end diff --git a/gems/aws-sdk-augmentedairuntime/lib/aws-sdk-augmentedairuntime/client.rb b/gems/aws-sdk-augmentedairuntime/lib/aws-sdk-augmentedairuntime/client.rb index f947e799ff7..a3a9f66b088 100644 --- a/gems/aws-sdk-augmentedairuntime/lib/aws-sdk-augmentedairuntime/client.rb +++ b/gems/aws-sdk-augmentedairuntime/lib/aws-sdk-augmentedairuntime/client.rb @@ -460,7 +460,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-augmentedairuntime' - context[:gem_version] = '1.1.0' + context[:gem_version] = '1.1.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-cloudwatch/CHANGELOG.md b/gems/aws-sdk-cloudwatch/CHANGELOG.md index 693b59b758d..85cd531920b 100644 --- a/gems/aws-sdk-cloudwatch/CHANGELOG.md +++ b/gems/aws-sdk-cloudwatch/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.33.0 (2020-03-02) +------------------ + +* Feature - Introducing Amazon CloudWatch Composite Alarms + 1.32.0 (2020-01-20) ------------------ diff --git a/gems/aws-sdk-cloudwatch/VERSION b/gems/aws-sdk-cloudwatch/VERSION index 359c41089a4..7aa332e4163 100644 --- a/gems/aws-sdk-cloudwatch/VERSION +++ b/gems/aws-sdk-cloudwatch/VERSION @@ -1 +1 @@ -1.32.0 +1.33.0 diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch.rb index f67bf49cd1d..821b6a33498 100644 --- a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch.rb +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch.rb @@ -15,6 +15,7 @@ require_relative 'aws-sdk-cloudwatch/waiters' require_relative 'aws-sdk-cloudwatch/resource' require_relative 'aws-sdk-cloudwatch/alarm' +require_relative 'aws-sdk-cloudwatch/composite_alarm' require_relative 'aws-sdk-cloudwatch/metric' require_relative 'aws-sdk-cloudwatch/customizations' @@ -45,6 +46,6 @@ # @service module Aws::CloudWatch - GEM_VERSION = '1.32.0' + GEM_VERSION = '1.33.0' end diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/alarm.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/alarm.rb index eef0d64c039..8931220d3c1 100644 --- a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/alarm.rb +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/alarm.rb @@ -388,13 +388,19 @@ def delete(options = {}) # @example Request syntax with placeholder values # # alarm.describe_history({ + # alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm # history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action # start_date: Time.now, # end_date: Time.now, # max_records: 1, # next_token: "NextToken", + # scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending # }) # @param [Hash] options ({}) + # @option options [Array] :alarm_types + # 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. # @option options [String] :history_item_type # The type of alarm histories to retrieve. # @option options [Time,DateTime,Date,Integer,String] :start_date @@ -406,6 +412,11 @@ def delete(options = {}) # @option options [String] :next_token # The token returned by a previous call to indicate that there is more # data available. + # @option options [String] :scan_by + # Specified whether to return the newest or oldest alarm history first. + # Specify `TimestampDescending` to have the newest event history + # returned first, and specify `TimestampAscending` to have the oldest + # history returned first. # @return [Types::DescribeAlarmHistoryOutput] def describe_history(options = {}) options = options.merge(alarm_name: @name) @@ -451,6 +462,11 @@ def enable_actions(options = {}) # @option options [String] :state_reason_data # The reason that this alarm is set to this specific state, in JSON # format. + # + # For SNS or EC2 alarm actions, this is just informational. But for EC2 + # Auto Scaling or application Auto Scaling alarm actions, the Auto + # Scaling policy uses the information in this field to take the correct + # action. # @return [EmptyStructure] def set_state(options = {}) options = options.merge(alarm_name: @name) diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb index d1db2c04b43..542732ee1fb 100644 --- a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client.rb @@ -254,8 +254,31 @@ def initialize(*args) # @!group API Operations - # Deletes the specified alarms. You can delete up to 50 alarms in one - # operation. In the event of an error, no alarms are deleted. + # Deletes the specified alarms. You can delete up to 100 alarms in one + # operation. However, this total can include no more than one composite + # alarm. For example, you could delete 99 metric alarms and one + # composite alarms with one operation, but you can't delete two + # composite alarms with one operation. + # + # In the event of an error, no alarms are deleted. + # + # It is possible to create a loop or cycle of composite alarms, where + # composite alarm A depends on composite alarm B, and composite alarm B + # also depends on composite alarm A. In this scenario, you can't delete + # any composite alarm that is part of the cycle because there is always + # still a composite alarm that depends on that alarm that you want to + # delete. + # + # To get out of such a situation, you must break the cycle by changing + # the rule of one of the composite alarms in the cycle to remove a + # dependency that creates the cycle. The simplest change to make to + # break a cycle is to change the `AlarmRule` of one of the alarms to + # `False`. + # + # Additionally, the evaluation of composite alarms stops if CloudWatch + # detects a cycle in the evaluation path. + # + # # # @option params [required, Array] :alarm_names # The alarms to be deleted. @@ -349,7 +372,11 @@ def delete_dashboards(params = {}, options = {}) # # @option params [required, Array] :rule_names # An array of the rule names to delete. If you need to find out the - # names of your rules, use DescribeInsightRules. + # names of your rules, use [DescribeInsightRules][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html # # @return [Types::DeleteInsightRulesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -380,7 +407,8 @@ def delete_insight_rules(params = {}, options = {}) # Retrieves the history for the specified alarm. You can filter the # results by date range or item type. If an alarm name is not specified, - # the histories for all alarms are returned. + # the histories for either all metric alarms or all composite alarms are + # returned. # # CloudWatch retains the history of an alarm even if you delete the # alarm. @@ -388,6 +416,11 @@ def delete_insight_rules(params = {}, options = {}) # @option params [String] :alarm_name # The name of the alarm. # + # @option params [Array] :alarm_types + # 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. + # # @option params [String] :history_item_type # The type of alarm histories to retrieve. # @@ -404,6 +437,12 @@ def delete_insight_rules(params = {}, options = {}) # The token returned by a previous call to indicate that there is more # data available. # + # @option params [String] :scan_by + # Specified whether to return the newest or oldest alarm history first. + # Specify `TimestampDescending` to have the newest event history + # returned first, and specify `TimestampAscending` to have the oldest + # history returned first. + # # @return [Types::DescribeAlarmHistoryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeAlarmHistoryOutput#alarm_history_items #alarm_history_items} => Array<Types::AlarmHistoryItem> @@ -413,17 +452,20 @@ def delete_insight_rules(params = {}, options = {}) # # resp = client.describe_alarm_history({ # alarm_name: "AlarmName", + # alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm # history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action # start_date: Time.now, # end_date: Time.now, # max_records: 1, # next_token: "NextToken", + # scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending # }) # # @example Response structure # # resp.alarm_history_items #=> Array # resp.alarm_history_items[0].alarm_name #=> String + # resp.alarm_history_items[0].alarm_type #=> String, one of "CompositeAlarm", "MetricAlarm" # resp.alarm_history_items[0].timestamp #=> Time # resp.alarm_history_items[0].history_item_type #=> String, one of "ConfigurationUpdate", "StateUpdate", "Action" # resp.alarm_history_items[0].history_summary #=> String @@ -439,22 +481,74 @@ def describe_alarm_history(params = {}, options = {}) req.send_request(options) end - # Retrieves the specified alarms. If no alarms are specified, all alarms - # are returned. Alarms can be retrieved by using only a prefix for the - # alarm name, the alarm state, or a prefix for any action. + # Retrieves the specified alarms. You can filter the results by + # specifying a a prefix for the alarm name, the alarm state, or a prefix + # for any action. # # @option params [Array] :alarm_names - # The names of the alarms. + # The names of the alarms to retrieve information about. # # @option params [String] :alarm_name_prefix - # The alarm name prefix. If this parameter is specified, you cannot - # specify `AlarmNames`. + # An alarm name prefix. If you specify this parameter, you receive + # information about all alarms that have names that start with this + # prefix. + # + # If this parameter is specified, you cannot specify `AlarmNames`. + # + # @option params [Array] :alarm_types + # 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. + # + # @option params [String] :children_of_alarm_name + # If you use this parameter and specify the name of a composite alarm, + # the operation returns information about the "children" alarms of the + # alarm you specify. These are the metric alarms and composite alarms + # referenced in the `AlarmRule` field of the composite alarm that you + # specify in `ChildrenOfAlarmName`. Information about the composite + # alarm that you name in `ChildrenOfAlarmName` is not returned. + # + # If you specify `ChildrenOfAlarmName`, you cannot specify any other + # parameters in the request except for `MaxRecords` and `NextToken`. If + # you do so, you will receive a validation error. + # + # Only the `Alarm Name`, `ARN`, `StateValue` + # (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` information + # are returned by this operation when you use this parameter. To get + # complete information about these alarms, perform another + # `DescribeAlarms` operation and specify the parent alarm names in the + # `AlarmNames` parameter. + # + # + # + # @option params [String] :parents_of_alarm_name + # If you use this parameter and specify the name of a metric or + # composite alarm, the operation returns information about the + # "parent" alarms of the alarm you specify. These are the composite + # alarms that have `AlarmRule` parameters that reference the alarm named + # in `ParentsOfAlarmName`. Information about the alarm that you specify + # in `ParentsOfAlarmName` is not returned. + # + # If you specify `ParentsOfAlarmName`, you cannot specify any other + # parameters in the request except for `MaxRecords` and `NextToken`. If + # you do so, you will receive a validation error. + # + # Only the Alarm Name and ARN are returned by this operation when you + # use this parameter. To get complete information about these alarms, + # perform another `DescribeAlarms` operation and specify the parent + # alarm names in the `AlarmNames` parameter. + # + # # # @option params [String] :state_value - # The state value to be used in matching alarms. + # Specify this parameter to receive information only about alarms that + # are currently in the state that you specify. # # @option params [String] :action_prefix - # The action name prefix. + # Use this parameter to filter the results of the operation to only + # those alarms that use a certain alarm action. For example, you could + # specify the ARN of an SNS topic to find all alarms that send + # notifications to that topic. # # @option params [Integer] :max_records # The maximum number of alarm descriptions to retrieve. @@ -465,6 +559,7 @@ def describe_alarm_history(params = {}, options = {}) # # @return [Types::DescribeAlarmsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # + # * {Types::DescribeAlarmsOutput#composite_alarms #composite_alarms} => Array<Types::CompositeAlarm> # * {Types::DescribeAlarmsOutput#metric_alarms #metric_alarms} => Array<Types::MetricAlarm> # * {Types::DescribeAlarmsOutput#next_token #next_token} => String # @@ -473,6 +568,9 @@ def describe_alarm_history(params = {}, options = {}) # resp = client.describe_alarms({ # alarm_names: ["AlarmName"], # alarm_name_prefix: "AlarmNamePrefix", + # alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm + # children_of_alarm_name: "AlarmName", + # parents_of_alarm_name: "AlarmName", # state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA # action_prefix: "ActionPrefix", # max_records: 1, @@ -481,6 +579,23 @@ def describe_alarm_history(params = {}, options = {}) # # @example Response structure # + # resp.composite_alarms #=> Array + # resp.composite_alarms[0].actions_enabled #=> Boolean + # resp.composite_alarms[0].alarm_actions #=> Array + # resp.composite_alarms[0].alarm_actions[0] #=> String + # resp.composite_alarms[0].alarm_arn #=> String + # resp.composite_alarms[0].alarm_configuration_updated_timestamp #=> Time + # resp.composite_alarms[0].alarm_description #=> String + # resp.composite_alarms[0].alarm_name #=> String + # resp.composite_alarms[0].alarm_rule #=> String + # resp.composite_alarms[0].insufficient_data_actions #=> Array + # resp.composite_alarms[0].insufficient_data_actions[0] #=> String + # resp.composite_alarms[0].ok_actions #=> Array + # resp.composite_alarms[0].ok_actions[0] #=> String + # resp.composite_alarms[0].state_reason #=> String + # resp.composite_alarms[0].state_reason_data #=> String + # resp.composite_alarms[0].state_updated_timestamp #=> Time + # resp.composite_alarms[0].state_value #=> String, one of "OK", "ALARM", "INSUFFICIENT_DATA" # resp.metric_alarms #=> Array # resp.metric_alarms[0].alarm_name #=> String # resp.metric_alarms[0].alarm_arn #=> String @@ -656,7 +771,7 @@ def describe_alarms_for_metric(params = {}, options = {}) # # @option params [Integer] :max_results # The maximum number of results to return in one operation. The maximum - # value you can specify is 10. + # value that you can specify is 100. # # To retrieve the remaining results, make another call with the returned # `NextToken` value. @@ -798,7 +913,11 @@ def disable_alarm_actions(params = {}, options = {}) # # @option params [required, Array] :rule_names # An array of the rule names to disable. If you need to find out the - # names of your rules, use DescribeInsightRules. + # names of your rules, use [DescribeInsightRules][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html # # @return [Types::DisableInsightRulesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -854,7 +973,11 @@ def enable_alarm_actions(params = {}, options = {}) # # @option params [required, Array] :rule_names # An array of the rule names to enable. If you need to find out the - # names of your rules, use DescribeInsightRules. + # names of your rules, use [DescribeInsightRules][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html # # @return [Types::EnableInsightRulesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1063,7 +1186,7 @@ def get_insight_rule_report(params = {}, options = {}) req.send_request(options) end - # You can use the `GetMetricData` API to retrieve as many as 100 + # You can use the `GetMetricData` API to retrieve as many as 500 # different metrics in a single request, with a total of as many as # 100,800 data points. You can also optionally perform math expressions # on the values of the returned statistics, to create new time series @@ -1116,7 +1239,7 @@ def get_insight_rule_report(params = {}, options = {}) # # @option params [required, Array] :metric_data_queries # The metric queries to be returned. A single `GetMetricData` call can - # include as many as 100 `MetricDataQuery` structures. Each of these + # include as many as 500 `MetricDataQuery` structures. Each of these # structures can specify either a metric to retrieve, or a math # expression to perform on retrieved data. # @@ -1488,12 +1611,16 @@ def get_metric_statistics(params = {}, options = {}) # `MetricWidget` parameter in each `GetMetricWidgetImage` call. # # For more information about the syntax of `MetricWidget` see - # CloudWatch-Metric-Widget-Structure. + # [GetMetricWidgetImage: Metric Widget Structure and Syntax][1]. # # 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. # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html + # # @option params [String] :output_format # The format of the resulting image. Only PNG images are supported. # @@ -1601,14 +1728,20 @@ def list_dashboards(params = {}, options = {}) end # List the specified metrics. You can use the returned metrics with - # GetMetricData or GetMetricStatistics to obtain statistical data. + # [GetMetricData][1] or [GetMetricStatistics][2] to obtain statistical + # data. # # Up to 500 results are returned for any one call. To retrieve # additional results, use the returned token with subsequent calls. # # After you create a metric, allow up to fifteen minutes before the # metric appears. Statistics about the metric, however, are available - # sooner using GetMetricData or GetMetricStatistics. + # sooner using [GetMetricData][1] or [GetMetricStatistics][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html + # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html # # @option params [String] :namespace # The namespace to filter against. @@ -1764,6 +1897,179 @@ def put_anomaly_detector(params = {}, options = {}) req.send_request(options) end + # Creates or updates a *composite alarm*. When you create a composite + # alarm, you specify a rule expression for the alarm that takes into + # account the alarm states of other alarms that you have created. The + # composite alarm goes into ALARM state only if all conditions of the + # rule are met. + # + # The alarms specified in a composite alarm's rule expression can + # include metric alarms and other composite alarms. + # + # Using composite alarms can reduce alarm noise. You can create multiple + # metric alarms, and also create a composite alarm and set up alerts + # only for the composite alarm. For example, you could create a + # composite alarm that goes into ALARM state only when more than one of + # the underlying metric alarms are in ALARM state. + # + # Currently, the only alarm actions that can be taken by composite + # alarms are notifying SNS topics. + # + # It is possible to create a loop or cycle of composite alarms, where + # composite alarm A depends on composite alarm B, and composite alarm B + # also depends on composite alarm A. In this scenario, you can't delete + # any composite alarm that is part of the cycle because there is always + # still a composite alarm that depends on that alarm that you want to + # delete. + # + # To get out of such a situation, you must break the cycle by changing + # the rule of one of the composite alarms in the cycle to remove a + # dependency that creates the cycle. The simplest change to make to + # break a cycle is to change the `AlarmRule` of one of the alarms to + # `False`. + # + # Additionally, the evaluation of composite alarms stops if CloudWatch + # detects a cycle in the evaluation path. + # + # + # + # When this operation creates an alarm, the alarm state is immediately + # set to `INSUFFICIENT_DATA`. The alarm is then evaluated and its state + # is set appropriately. Any actions associated with the new state are + # then executed. For a composite alarm, this initial time after creation + # is the only time that the alarm can be in `INSUFFICIENT_DATA` state. + # + # When you update an existing alarm, its state is left unchanged, but + # the update completely overwrites the previous configuration of the + # alarm. + # + # @option params [Boolean] :actions_enabled + # Indicates whether actions should be executed during any changes to the + # alarm state of the composite alarm. The default is `TRUE`. + # + # @option params [Array] :alarm_actions + # The actions to execute when this alarm transitions to the `ALARM` + # state from any other state. Each action is specified as an Amazon + # Resource Name (ARN). + # + # Valid Values: `arn:aws:sns:region:account-id:sns-topic-name ` + # + # @option params [String] :alarm_description + # The description for the composite alarm. + # + # @option params [required, String] :alarm_name + # The name for the composite alarm. This name must be unique within your + # AWS account. + # + # @option params [required, String] :alarm_rule + # An expression that specifies which other alarms are to be evaluated to + # determine this composite alarm's state. For each alarm that you + # reference, you designate a function that specifies whether that alarm + # needs to be in ALARM state, OK state, or INSUFFICIENT\_DATA state. You + # can use operators (AND, OR and NOT) to combine multiple functions in a + # single expression. You can use parenthesis to logically group the + # functions in your expression. + # + # You can use either alarm names or ARNs to reference the other alarms + # that are to be evaluated. + # + # Functions can include the following: + # + # * `ALARM("alarm-name or alarm-ARN")` is TRUE if the named alarm is in + # ALARM state. + # + # * `OK("alarm-name or alarm-ARN")` is TRUE if the named alarm is in OK + # state. + # + # * `INSUFFICIENT_DATA("alarm-name or alarm-ARN")` is TRUE if the named + # alarm is in INSUFFICIENT\_DATA state. + # + # * `TRUE` always evaluates to TRUE. + # + # * `FALSE` always evaluates to FALSE. + # + # TRUE and FALSE are useful for testing a complex `AlarmRule` structure, + # and for testing your alarm actions. + # + # Alarm names specified in `AlarmRule` can be surrounded with + # double-quotes ("), but do not have to be. + # + # The following are some examples of `AlarmRule`\: + # + # * `ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)` + # specifies that the composite alarm goes into ALARM state only if + # both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in + # ALARM state. + # + # * `ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)` + # specifies that the alarm goes to ALARM state if + # CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is + # not in ALARM state. This example reduces alarm noise during a known + # deployment window. + # + # * `(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND + # OK(NetworkOutTooHigh)` goes into ALARM state if + # CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and + # if NetworkOutTooHigh is in OK state. This provides another example + # of using a composite alarm to prevent noise. This rule ensures that + # you are not notified with an alarm action on high CPU or disk usage + # if a known network problem is also occurring. + # + # The `AlarmRule` can specify as many as 100 "children" alarms. The + # `AlarmRule` expression can have as many as 500 elements. Elements are + # child alarms, TRUE or FALSE statements, and parentheses. + # + # @option params [Array] :insufficient_data_actions + # The actions to execute when this alarm transitions to the + # `INSUFFICIENT_DATA` state from any other state. Each action is + # specified as an Amazon Resource Name (ARN). + # + # Valid Values: `arn:aws:sns:region:account-id:sns-topic-name ` + # + # @option params [Array] :ok_actions + # The actions to execute when this alarm transitions to an `OK` state + # from any other state. Each action is specified as an Amazon Resource + # Name (ARN). + # + # Valid Values: `arn:aws:sns:region:account-id:sns-topic-name ` + # + # @option params [Array] :tags + # A list of key-value pairs to associate with the composite alarm. You + # can associate as many as 50 tags with an alarm. + # + # 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. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.put_composite_alarm({ + # actions_enabled: false, + # alarm_actions: ["ResourceName"], + # alarm_description: "AlarmDescription", + # alarm_name: "AlarmName", # required + # alarm_rule: "AlarmRule", # required + # insufficient_data_actions: ["ResourceName"], + # ok_actions: ["ResourceName"], + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarm AWS API Documentation + # + # @overload put_composite_alarm(params = {}) + # @param [Hash] params ({}) + def put_composite_alarm(params = {}, options = {}) + req = build_request(:put_composite_alarm, params) + req.send_request(options) + end + # 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. @@ -1797,8 +2103,12 @@ def put_anomaly_detector(params = {}, options = {}) # the widgets to include and their location on the dashboard. This # parameter is required. # - # For more information about the syntax, see - # CloudWatch-Dashboard-Body-Structure. + # For more information about the syntax, see [Dashboard Body Structure + # and Syntax][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html # # @return [Types::PutDashboardOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1946,7 +2256,7 @@ def put_insight_rule(params = {}, options = {}) # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -1966,7 +2276,7 @@ def put_insight_rule(params = {}, options = {}) # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -1986,7 +2296,7 @@ def put_insight_rule(params = {}, options = {}) # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -2148,7 +2458,7 @@ def put_insight_rule(params = {}, options = {}) # One item in the `Metrics` array is the expression that the alarm # watches. You designate this expression by setting `ReturnValue` to # true for this object in the array. For more information, see - # MetricDataQuery. + # [MetricDataQuery][1]. # # If you use the `Metrics` parameter, you cannot include the # `MetricName`, `Dimensions`, `Period`, `Namespace`, `Statistic`, or @@ -2156,6 +2466,10 @@ def put_insight_rule(params = {}, options = {}) # operation. Instead, you retrieve the metrics you are using in your # math expression as part of the `Metrics` array. # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html + # # @option params [Array] :tags # A list of key-value pairs to associate with the alarm. You can # associate as many as 50 tags with an alarm. @@ -2249,7 +2563,7 @@ def put_metric_alarm(params = {}, options = {}) # associates the data points with the specified metric. If the specified # metric does not exist, CloudWatch creates the metric. When CloudWatch # creates a metric, it can take up to fifteen minutes for the metric to - # appear in calls to ListMetrics. + # appear in calls to [ListMetrics][1]. # # You can publish either individual data points in the `Value` field, or # arrays of values and the number of times each value occurred during @@ -2271,11 +2585,14 @@ def put_metric_alarm(params = {}, options = {}) # You can use up to 10 dimensions per metric to further clarify what # data the metric collects. Each dimension consists of a Name and Value # pair. For more information about specifying dimensions, see - # [Publishing Metrics][1] in the *Amazon CloudWatch User Guide*. + # [Publishing Metrics][2] in the *Amazon CloudWatch User Guide*. # # Data points with time stamps from 24 hours ago or longer can take at - # least 48 hours to become available for GetMetricData or - # GetMetricStatistics from the time they are submitted. + # least 48 hours to become available for [GetMetricData][3] or + # [GetMetricStatistics][4] from the time they are submitted. Data points + # with time stamps between 3 and 24 hours ago can take as much as 2 + # hours to become available for for [GetMetricData][3] or + # [GetMetricStatistics][4]. # # CloudWatch needs raw data points to calculate percentile statistics. # If you publish data using a statistic set instead, you can only @@ -2290,7 +2607,10 @@ def put_metric_alarm(params = {}, options = {}) # # # - # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html + # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html + # [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html + # [4]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html # # @option params [required, String] :namespace # The namespace for the metric data. @@ -2347,10 +2667,25 @@ def put_metric_data(params = {}, options = {}) # for the appropriate state is invoked. For example, if your alarm is # configured to send an Amazon SNS message when an alarm is triggered, # temporarily changing the alarm state to `ALARM` sends an SNS message. - # The alarm returns to its actual state (often within seconds). Because - # the alarm state change happens quickly, it is typically only visible - # in the alarm's **History** tab in the Amazon CloudWatch console or - # through DescribeAlarmHistory. + # + # Metric alarms returns to their actual state quickly, often within + # seconds. Because the metric alarm state change happens quickly, it is + # typically only visible in the alarm's **History** tab in the Amazon + # CloudWatch console or through [DescribeAlarmHistory][1]. + # + # If you use `SetAlarmState` on a composite alarm, the composite alarm + # is not guaranteed to return to its actual state. It will return to its + # actual state only once any of its children alarms change state. It is + # also re-evaluated if you update its configuration. + # + # If an alarm triggers EC2 Auto Scaling policies or application Auto + # Scaling policies, you must include information in the + # `StateReasonData` parameter to enable the policy to take the correct + # action. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html # # @option params [required, String] :alarm_name # The name for the alarm. This name must be unique within the AWS @@ -2367,6 +2702,11 @@ def put_metric_data(params = {}, options = {}) # The reason that this alarm is set to this specific state, in JSON # format. # + # For SNS or EC2 alarm actions, this is just informational. But for EC2 + # Auto Scaling or application Auto Scaling alarm actions, the Auto + # Scaling policy uses the information in this field to take the correct + # action. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values @@ -2481,7 +2821,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-cloudwatch' - context[:gem_version] = '1.32.0' + context[:gem_version] = '1.33.0' Seahorse::Client::Request.new(handlers, context) end @@ -2547,9 +2887,10 @@ def build_request(operation_name, params = {}) # The following table lists the valid waiter names, the operations they call, # and the default `:delay` and `:max_attempts` values. # - # | waiter_name | params | :delay | :max_attempts | - # | ------------ | ------------------ | -------- | ------------- | - # | alarm_exists | {#describe_alarms} | 5 | 40 | + # | waiter_name | params | :delay | :max_attempts | + # | ---------------------- | ------------------ | -------- | ------------- | + # | alarm_exists | {#describe_alarms} | 5 | 40 | + # | composite_alarm_exists | {#describe_alarms} | 5 | 40 | # # @raise [Errors::FailureStateError] Raised when the waiter terminates # because the waiter has entered a state that it will not transition @@ -2600,7 +2941,8 @@ def waiter(waiter_name, options = {}) def waiters { - alarm_exists: Waiters::AlarmExists + alarm_exists: Waiters::AlarmExists, + composite_alarm_exists: Waiters::CompositeAlarmExists } end diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client_api.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client_api.rb index 55cf9d377dd..28e01853226 100644 --- a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client_api.rb +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/client_api.rb @@ -20,6 +20,9 @@ module ClientApi AlarmName = Shapes::StringShape.new(name: 'AlarmName') AlarmNamePrefix = Shapes::StringShape.new(name: 'AlarmNamePrefix') AlarmNames = Shapes::ListShape.new(name: 'AlarmNames') + AlarmRule = Shapes::StringShape.new(name: 'AlarmRule') + AlarmType = Shapes::StringShape.new(name: 'AlarmType') + AlarmTypes = Shapes::ListShape.new(name: 'AlarmTypes') AmazonResourceName = Shapes::StringShape.new(name: 'AmazonResourceName') AnomalyDetector = Shapes::StructureShape.new(name: 'AnomalyDetector') AnomalyDetectorConfiguration = Shapes::StructureShape.new(name: 'AnomalyDetectorConfiguration') @@ -30,6 +33,8 @@ module ClientApi AwsQueryErrorMessage = Shapes::StringShape.new(name: 'AwsQueryErrorMessage') BatchFailures = Shapes::ListShape.new(name: 'BatchFailures') ComparisonOperator = Shapes::StringShape.new(name: 'ComparisonOperator') + CompositeAlarm = Shapes::StructureShape.new(name: 'CompositeAlarm') + CompositeAlarms = Shapes::ListShape.new(name: 'CompositeAlarms') ConcurrentModificationException = Shapes::StructureShape.new(name: 'ConcurrentModificationException') Counts = Shapes::ListShape.new(name: 'Counts') DashboardArn = Shapes::StringShape.new(name: 'DashboardArn') @@ -175,6 +180,7 @@ module ClientApi Period = Shapes::IntegerShape.new(name: 'Period') PutAnomalyDetectorInput = Shapes::StructureShape.new(name: 'PutAnomalyDetectorInput') PutAnomalyDetectorOutput = Shapes::StructureShape.new(name: 'PutAnomalyDetectorOutput') + PutCompositeAlarmInput = Shapes::StructureShape.new(name: 'PutCompositeAlarmInput') PutDashboardInput = Shapes::StructureShape.new(name: 'PutDashboardInput') PutDashboardOutput = Shapes::StructureShape.new(name: 'PutDashboardOutput') PutInsightRuleInput = Shapes::StructureShape.new(name: 'PutInsightRuleInput') @@ -218,6 +224,7 @@ module ClientApi Values = Shapes::ListShape.new(name: 'Values') AlarmHistoryItem.add_member(:alarm_name, Shapes::ShapeRef.new(shape: AlarmName, location_name: "AlarmName")) + AlarmHistoryItem.add_member(:alarm_type, Shapes::ShapeRef.new(shape: AlarmType, location_name: "AlarmType")) AlarmHistoryItem.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp")) AlarmHistoryItem.add_member(:history_item_type, Shapes::ShapeRef.new(shape: HistoryItemType, location_name: "HistoryItemType")) AlarmHistoryItem.add_member(:history_summary, Shapes::ShapeRef.new(shape: HistorySummary, location_name: "HistorySummary")) @@ -228,6 +235,8 @@ module ClientApi AlarmNames.member = Shapes::ShapeRef.new(shape: AlarmName) + AlarmTypes.member = Shapes::ShapeRef.new(shape: AlarmType) + AnomalyDetector.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, location_name: "Namespace")) AnomalyDetector.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, location_name: "MetricName")) AnomalyDetector.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions")) @@ -246,6 +255,23 @@ module ClientApi BatchFailures.member = Shapes::ShapeRef.new(shape: PartialFailure) + CompositeAlarm.add_member(:actions_enabled, Shapes::ShapeRef.new(shape: ActionsEnabled, location_name: "ActionsEnabled")) + CompositeAlarm.add_member(:alarm_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "AlarmActions")) + CompositeAlarm.add_member(:alarm_arn, Shapes::ShapeRef.new(shape: AlarmArn, location_name: "AlarmArn")) + CompositeAlarm.add_member(:alarm_configuration_updated_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "AlarmConfigurationUpdatedTimestamp")) + CompositeAlarm.add_member(:alarm_description, Shapes::ShapeRef.new(shape: AlarmDescription, location_name: "AlarmDescription")) + CompositeAlarm.add_member(:alarm_name, Shapes::ShapeRef.new(shape: AlarmName, location_name: "AlarmName")) + CompositeAlarm.add_member(:alarm_rule, Shapes::ShapeRef.new(shape: AlarmRule, location_name: "AlarmRule")) + CompositeAlarm.add_member(:insufficient_data_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "InsufficientDataActions")) + CompositeAlarm.add_member(:ok_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "OKActions")) + CompositeAlarm.add_member(:state_reason, Shapes::ShapeRef.new(shape: StateReason, location_name: "StateReason")) + CompositeAlarm.add_member(:state_reason_data, Shapes::ShapeRef.new(shape: StateReasonData, location_name: "StateReasonData")) + CompositeAlarm.add_member(:state_updated_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateUpdatedTimestamp")) + CompositeAlarm.add_member(:state_value, Shapes::ShapeRef.new(shape: StateValue, location_name: "StateValue")) + CompositeAlarm.struct_class = Types::CompositeAlarm + + CompositeAlarms.member = Shapes::ShapeRef.new(shape: CompositeAlarm) + ConcurrentModificationException.struct_class = Types::ConcurrentModificationException Counts.member = Shapes::ShapeRef.new(shape: DatapointValue) @@ -313,11 +339,13 @@ module ClientApi DeleteInsightRulesOutput.struct_class = Types::DeleteInsightRulesOutput DescribeAlarmHistoryInput.add_member(:alarm_name, Shapes::ShapeRef.new(shape: AlarmName, location_name: "AlarmName")) + DescribeAlarmHistoryInput.add_member(:alarm_types, Shapes::ShapeRef.new(shape: AlarmTypes, location_name: "AlarmTypes")) DescribeAlarmHistoryInput.add_member(:history_item_type, Shapes::ShapeRef.new(shape: HistoryItemType, location_name: "HistoryItemType")) DescribeAlarmHistoryInput.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StartDate")) DescribeAlarmHistoryInput.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndDate")) DescribeAlarmHistoryInput.add_member(:max_records, Shapes::ShapeRef.new(shape: MaxRecords, location_name: "MaxRecords")) DescribeAlarmHistoryInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken")) + DescribeAlarmHistoryInput.add_member(:scan_by, Shapes::ShapeRef.new(shape: ScanBy, location_name: "ScanBy")) DescribeAlarmHistoryInput.struct_class = Types::DescribeAlarmHistoryInput DescribeAlarmHistoryOutput.add_member(:alarm_history_items, Shapes::ShapeRef.new(shape: AlarmHistoryItems, location_name: "AlarmHistoryItems")) @@ -338,12 +366,16 @@ module ClientApi DescribeAlarmsInput.add_member(:alarm_names, Shapes::ShapeRef.new(shape: AlarmNames, location_name: "AlarmNames")) DescribeAlarmsInput.add_member(:alarm_name_prefix, Shapes::ShapeRef.new(shape: AlarmNamePrefix, location_name: "AlarmNamePrefix")) + DescribeAlarmsInput.add_member(:alarm_types, Shapes::ShapeRef.new(shape: AlarmTypes, location_name: "AlarmTypes")) + DescribeAlarmsInput.add_member(:children_of_alarm_name, Shapes::ShapeRef.new(shape: AlarmName, location_name: "ChildrenOfAlarmName")) + DescribeAlarmsInput.add_member(:parents_of_alarm_name, Shapes::ShapeRef.new(shape: AlarmName, location_name: "ParentsOfAlarmName")) DescribeAlarmsInput.add_member(:state_value, Shapes::ShapeRef.new(shape: StateValue, location_name: "StateValue")) DescribeAlarmsInput.add_member(:action_prefix, Shapes::ShapeRef.new(shape: ActionPrefix, location_name: "ActionPrefix")) DescribeAlarmsInput.add_member(:max_records, Shapes::ShapeRef.new(shape: MaxRecords, location_name: "MaxRecords")) DescribeAlarmsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken")) DescribeAlarmsInput.struct_class = Types::DescribeAlarmsInput + DescribeAlarmsOutput.add_member(:composite_alarms, Shapes::ShapeRef.new(shape: CompositeAlarms, location_name: "CompositeAlarms")) DescribeAlarmsOutput.add_member(:metric_alarms, Shapes::ShapeRef.new(shape: MetricAlarms, location_name: "MetricAlarms")) DescribeAlarmsOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken")) DescribeAlarmsOutput.struct_class = Types::DescribeAlarmsOutput @@ -645,6 +677,16 @@ module ClientApi PutAnomalyDetectorOutput.struct_class = Types::PutAnomalyDetectorOutput + PutCompositeAlarmInput.add_member(:actions_enabled, Shapes::ShapeRef.new(shape: ActionsEnabled, location_name: "ActionsEnabled")) + PutCompositeAlarmInput.add_member(:alarm_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "AlarmActions")) + PutCompositeAlarmInput.add_member(:alarm_description, Shapes::ShapeRef.new(shape: AlarmDescription, location_name: "AlarmDescription")) + PutCompositeAlarmInput.add_member(:alarm_name, Shapes::ShapeRef.new(shape: AlarmName, required: true, location_name: "AlarmName")) + PutCompositeAlarmInput.add_member(:alarm_rule, Shapes::ShapeRef.new(shape: AlarmRule, required: true, location_name: "AlarmRule")) + PutCompositeAlarmInput.add_member(:insufficient_data_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "InsufficientDataActions")) + PutCompositeAlarmInput.add_member(:ok_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "OKActions")) + PutCompositeAlarmInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags")) + PutCompositeAlarmInput.struct_class = Types::PutCompositeAlarmInput + PutDashboardInput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, required: true, location_name: "DashboardName")) PutDashboardInput.add_member(:dashboard_body, Shapes::ShapeRef.new(shape: DashboardBody, required: true, location_name: "DashboardBody")) PutDashboardInput.struct_class = Types::PutDashboardInput @@ -1009,6 +1051,15 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: MissingRequiredParameterException) end) + api.add_operation(:put_composite_alarm, Seahorse::Model::Operation.new.tap do |o| + o.name = "PutCompositeAlarm" + o.http_method = "POST" + o.http_request_uri = "/" + o.input = Shapes::ShapeRef.new(shape: PutCompositeAlarmInput) + o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure)) + o.errors << Shapes::ShapeRef.new(shape: LimitExceededFault) + end) + api.add_operation(:put_dashboard, Seahorse::Model::Operation.new.tap do |o| o.name = "PutDashboard" o.http_method = "POST" diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/composite_alarm.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/composite_alarm.rb new file mode 100644 index 00000000000..5c0e286f760 --- /dev/null +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/composite_alarm.rb @@ -0,0 +1,472 @@ +# WARNING ABOUT GENERATED CODE +# +# This file is generated. See the contributing guide for more information: +# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md +# +# WARNING ABOUT GENERATED CODE + +module Aws::CloudWatch + class CompositeAlarm + + extend Aws::Deprecations + + # @overload def initialize(name, options = {}) + # @param [String] name + # @option options [Client] :client + # @overload def initialize(options = {}) + # @option options [required, String] :name + # @option options [Client] :client + def initialize(*args) + options = Hash === args.last ? args.pop.dup : {} + @name = extract_name(args, options) + @data = options.delete(:data) + @client = options.delete(:client) || Client.new(options) + @waiter_block_warned = false + end + + # @!group Read-Only Attributes + + # @return [String] + def name + @name + end + alias :alarm_name :name + + # Indicates whether actions should be executed during any changes to the + # alarm state. + # @return [Boolean] + def actions_enabled + data[:actions_enabled] + end + + # The actions to execute when this alarm transitions to the ALARM state + # from any other state. Each action is specified as an Amazon Resource + # Name (ARN). + # @return [Array] + def alarm_actions + data[:alarm_actions] + end + + # The Amazon Resource Name (ARN) of the alarm. + # @return [String] + def alarm_arn + data[:alarm_arn] + end + + # The time stamp of the last update to the alarm configuration. + # @return [Time] + def alarm_configuration_updated_timestamp + data[:alarm_configuration_updated_timestamp] + end + + # The description of the alarm. + # @return [String] + def alarm_description + data[:alarm_description] + end + + # The rule that this alarm uses to evaluate its alarm state. + # @return [String] + def alarm_rule + data[:alarm_rule] + end + + # The actions to execute when this alarm transitions to the + # INSUFFICIENT\_DATA state from any other state. Each action is + # specified as an Amazon Resource Name (ARN). + # @return [Array] + def insufficient_data_actions + data[:insufficient_data_actions] + end + + # The actions to execute when this alarm transitions to the OK state + # from any other state. Each action is specified as an Amazon Resource + # Name (ARN). + # @return [Array] + def ok_actions + data[:ok_actions] + end + + # An explanation for the alarm state, in text format. + # @return [String] + def state_reason + data[:state_reason] + end + + # An explanation for the alarm state, in JSON format. + # @return [String] + def state_reason_data + data[:state_reason_data] + end + + # The time stamp of the last update to the alarm state. + # @return [Time] + def state_updated_timestamp + data[:state_updated_timestamp] + end + + # The state value for the alarm. + # @return [String] + def state_value + data[:state_value] + end + + # @!endgroup + + # @return [Client] + def client + @client + end + + # Loads, or reloads {#data} for the current {CompositeAlarm}. + # Returns `self` making it possible to chain methods. + # + # composite_alarm.reload.data + # + # @return [self] + def load + resp = @client.describe_alarms(alarm_names: [@name]) + @data = resp.composite_alarms[0] + self + end + alias :reload :load + + # @return [Types::CompositeAlarm] + # Returns the data for this {CompositeAlarm}. Calls + # {Client#describe_alarms} if {#data_loaded?} is `false`. + def data + load unless @data + @data + end + + # @return [Boolean] + # Returns `true` if this resource is loaded. Accessing attributes or + # {#data} on an unloaded resource will trigger a call to {#load}. + def data_loaded? + !!@data + end + + # @param [Hash] options ({}) + # @return [Boolean] + # Returns `true` if the CompositeAlarm exists. + def exists?(options = {}) + begin + wait_until_exists(options.merge(max_attempts: 1)) + true + rescue Aws::Waiters::Errors::UnexpectedError => e + raise e.error + rescue Aws::Waiters::Errors::WaiterFailed + false + end + end + + # @param [Hash] options ({}) + # @option options [Integer] :max_attempts (40) + # @option options [Float] :delay (5) + # @option options [Proc] :before_attempt + # @option options [Proc] :before_wait + # @return [CompositeAlarm] + def wait_until_exists(options = {}, &block) + options, params = separate_params_and_options(options) + waiter = Waiters::CompositeAlarmExists.new(options) + yield_waiter_and_warn(waiter, &block) if block_given? + waiter.wait(params.merge(alarm_names: [@name])) + CompositeAlarm.new({ + name: @name, + client: @client + }) + end + + # @deprecated Use [Aws::CloudWatch::Client] #wait_until instead + # + # Waiter polls an API operation until a resource enters a desired + # state. + # + # @note The waiting operation is performed on a copy. The original resource remains unchanged + # + # ## Basic Usage + # + # Waiter will polls until it is successful, it fails by + # entering a terminal state, or until a maximum number of attempts + # are made. + # + # # polls in a loop until condition is true + # resource.wait_until(options) {|resource| condition} + # + # ## Example + # + # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' } + # + # ## Configuration + # + # You can configure the maximum number of polling attempts, and the + # delay (in seconds) between each polling attempt. The waiting condition is set + # by passing a block to {#wait_until}: + # + # # poll for ~25 seconds + # resource.wait_until(max_attempts:5,delay:5) {|resource|...} + # + # ## Callbacks + # + # You can be notified before each polling attempt and before each + # delay. If you throw `:success` or `:failure` from these callbacks, + # it will terminate the waiter. + # + # started_at = Time.now + # # poll for 1 hour, instead of a number of attempts + # proc = Proc.new do |attempts, response| + # throw :failure if Time.now - started_at > 3600 + # end + # + # # disable max attempts + # instance.wait_until(before_wait:proc, max_attempts:nil) {...} + # + # ## Handling Errors + # + # When a waiter is successful, it returns the Resource. When a waiter + # fails, it raises an error. + # + # begin + # resource.wait_until(...) + # rescue Aws::Waiters::Errors::WaiterFailed + # # resource did not enter the desired state in time + # end + # + # + # @yield param [Resource] resource to be used in the waiting condition + # + # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates + # because the waiter has entered a state that it will not transition + # out of, preventing success. + # + # yet successful. + # + # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered + # while polling for a resource that is not expected. + # + # @raise [NotImplementedError] Raised when the resource does not + # + # @option options [Integer] :max_attempts (10) Maximum number of + # attempts + # @option options [Integer] :delay (10) Delay between each + # attempt in seconds + # @option options [Proc] :before_attempt (nil) Callback + # invoked before each attempt + # @option options [Proc] :before_wait (nil) Callback + # invoked before each wait + # @return [Resource] if the waiter was successful + def wait_until(options = {}, &block) + self_copy = self.dup + attempts = 0 + options[:max_attempts] = 10 unless options.key?(:max_attempts) + options[:delay] ||= 10 + options[:poller] = Proc.new do + attempts += 1 + if block.call(self_copy) + [:success, self_copy] + else + self_copy.reload unless attempts == options[:max_attempts] + :retry + end + end + Aws::Waiters::Waiter.new(options).wait({}) + end + + # @!group Actions + + # @example Request syntax with placeholder values + # + # composite_alarm.delete() + # @param [Hash] options ({}) + # @return [EmptyStructure] + def delete(options = {}) + options = Aws::Util.deep_merge(options, alarm_names: [@name]) + resp = @client.delete_alarms(options) + resp.data + end + + # @example Request syntax with placeholder values + # + # composite_alarm.describe_history({ + # alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm + # history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action + # start_date: Time.now, + # end_date: Time.now, + # max_records: 1, + # next_token: "NextToken", + # scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending + # }) + # @param [Hash] options ({}) + # @option options [Array] :alarm_types + # 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. + # @option options [String] :history_item_type + # The type of alarm histories to retrieve. + # @option options [Time,DateTime,Date,Integer,String] :start_date + # The starting date to retrieve alarm history. + # @option options [Time,DateTime,Date,Integer,String] :end_date + # The ending date to retrieve alarm history. + # @option options [Integer] :max_records + # The maximum number of alarm history records to retrieve. + # @option options [String] :next_token + # The token returned by a previous call to indicate that there is more + # data available. + # @option options [String] :scan_by + # Specified whether to return the newest or oldest alarm history first. + # Specify `TimestampDescending` to have the newest event history + # returned first, and specify `TimestampAscending` to have the oldest + # history returned first. + # @return [Types::DescribeAlarmHistoryOutput] + def describe_history(options = {}) + options = options.merge(alarm_name: @name) + resp = @client.describe_alarm_history(options) + resp.data + end + + # @example Request syntax with placeholder values + # + # composite_alarm.disable_actions() + # @param [Hash] options ({}) + # @return [EmptyStructure] + def disable_actions(options = {}) + options = Aws::Util.deep_merge(options, alarm_names: [@name]) + resp = @client.disable_alarm_actions(options) + resp.data + end + + # @example Request syntax with placeholder values + # + # composite_alarm.enable_actions() + # @param [Hash] options ({}) + # @return [EmptyStructure] + def enable_actions(options = {}) + options = Aws::Util.deep_merge(options, alarm_names: [@name]) + resp = @client.enable_alarm_actions(options) + resp.data + end + + # @example Request syntax with placeholder values + # + # composite_alarm.set_state({ + # state_value: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA + # state_reason: "StateReason", # required + # state_reason_data: "StateReasonData", + # }) + # @param [Hash] options ({}) + # @option options [required, String] :state_value + # The value of the state. + # @option options [required, String] :state_reason + # The reason that this alarm is set to this specific state, in text + # format. + # @option options [String] :state_reason_data + # The reason that this alarm is set to this specific state, in JSON + # format. + # + # For SNS or EC2 alarm actions, this is just informational. But for EC2 + # Auto Scaling or application Auto Scaling alarm actions, the Auto + # Scaling policy uses the information in this field to take the correct + # action. + # @return [EmptyStructure] + def set_state(options = {}) + options = options.merge(alarm_name: @name) + resp = @client.set_alarm_state(options) + resp.data + end + + # @deprecated + # @api private + def identifiers + { name: @name } + end + deprecated(:identifiers) + + private + + def extract_name(args, options) + value = args[0] || options.delete(:name) + case value + when String then value + when nil then raise ArgumentError, "missing required option :name" + else + msg = "expected :name to be a String, got #{value.class}" + raise ArgumentError, msg + end + end + + def yield_waiter_and_warn(waiter, &block) + if !@waiter_block_warned + msg = "pass options to configure the waiter; " + msg << "yielding the waiter is deprecated" + warn(msg) + @waiter_block_warned = true + end + yield(waiter.waiter) + end + + def separate_params_and_options(options) + opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait]) + waiter_opts = {} + waiter_params = {} + options.each_pair do |key, value| + if opts.include?(key) + waiter_opts[key] = value + else + waiter_params[key] = value + end + end + waiter_opts[:client] ||= @client + [waiter_opts, waiter_params] + end + + class Collection < Aws::Resources::Collection + + # @!group Batch Actions + + # @param options ({}) + # @return [void] + def batch_delete!(options = {}) + batch_enum.each do |batch| + params = Aws::Util.copy_hash(options) + params[:alarm_names] ||= [] + batch.each do |item| + params[:alarm_names] << item.name + end + batch[0].client.delete_alarms(params) + end + nil + end + + # @param options ({}) + # @return [void] + def batch_disable_actions(options = {}) + batch_enum.each do |batch| + params = Aws::Util.copy_hash(options) + params[:alarm_names] ||= [] + batch.each do |item| + params[:alarm_names] << item.name + end + batch[0].client.disable_alarm_actions(params) + end + nil + end + + # @param options ({}) + # @return [void] + def batch_enable_actions(options = {}) + batch_enum.each do |batch| + params = Aws::Util.copy_hash(options) + params[:alarm_names] ||= [] + batch.each do |item| + params[:alarm_names] << item.name + end + batch[0].client.enable_alarm_actions(params) + end + nil + end + + # @!endgroup + + end + end +end diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb index 706f3061b7e..3fe98ba5882 100644 --- a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/metric.rb @@ -375,7 +375,7 @@ def get_statistics(options = {}) # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -394,7 +394,7 @@ def get_statistics(options = {}) # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -413,7 +413,7 @@ def get_statistics(options = {}) # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -550,13 +550,17 @@ def get_statistics(options = {}) # One item in the `Metrics` array is the expression that the alarm # watches. You designate this expression by setting `ReturnValue` to # true for this object in the array. For more information, see - # MetricDataQuery. + # [MetricDataQuery][1]. # # If you use the `Metrics` parameter, you cannot include the # `MetricName`, `Dimensions`, `Period`, `Namespace`, `Statistic`, or # `ExtendedStatistic` parameters of `PutMetricAlarm` in the same # operation. Instead, you retrieve the metrics you are using in your # math expression as part of the `Metrics` array. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html # @option options [Array] :tags # A list of key-value pairs to associate with the alarm. You can # associate as many as 50 tags with an alarm. diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/resource.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/resource.rb index aa74550c0ab..e61486fe650 100644 --- a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/resource.rb +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/resource.rb @@ -35,19 +35,71 @@ def alarm(name) # alarms = cloud_watch.alarms({ # alarm_names: ["AlarmName"], # alarm_name_prefix: "AlarmNamePrefix", + # alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm + # children_of_alarm_name: "AlarmName", + # parents_of_alarm_name: "AlarmName", # state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA # action_prefix: "ActionPrefix", # }) # @param [Hash] options ({}) # @option options [Array] :alarm_names - # The names of the alarms. + # The names of the alarms to retrieve information about. # @option options [String] :alarm_name_prefix - # The alarm name prefix. If this parameter is specified, you cannot - # specify `AlarmNames`. + # An alarm name prefix. If you specify this parameter, you receive + # information about all alarms that have names that start with this + # prefix. + # + # If this parameter is specified, you cannot specify `AlarmNames`. + # @option options [Array] :alarm_types + # 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. + # @option options [String] :children_of_alarm_name + # If you use this parameter and specify the name of a composite alarm, + # the operation returns information about the "children" alarms of the + # alarm you specify. These are the metric alarms and composite alarms + # referenced in the `AlarmRule` field of the composite alarm that you + # specify in `ChildrenOfAlarmName`. Information about the composite + # alarm that you name in `ChildrenOfAlarmName` is not returned. + # + # If you specify `ChildrenOfAlarmName`, you cannot specify any other + # parameters in the request except for `MaxRecords` and `NextToken`. If + # you do so, you will receive a validation error. + # + # Only the `Alarm Name`, `ARN`, `StateValue` + # (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` information + # are returned by this operation when you use this parameter. To get + # complete information about these alarms, perform another + # `DescribeAlarms` operation and specify the parent alarm names in the + # `AlarmNames` parameter. + # + # + # @option options [String] :parents_of_alarm_name + # If you use this parameter and specify the name of a metric or + # composite alarm, the operation returns information about the + # "parent" alarms of the alarm you specify. These are the composite + # alarms that have `AlarmRule` parameters that reference the alarm named + # in `ParentsOfAlarmName`. Information about the alarm that you specify + # in `ParentsOfAlarmName` is not returned. + # + # If you specify `ParentsOfAlarmName`, you cannot specify any other + # parameters in the request except for `MaxRecords` and `NextToken`. If + # you do so, you will receive a validation error. + # + # Only the Alarm Name and ARN are returned by this operation when you + # use this parameter. To get complete information about these alarms, + # perform another `DescribeAlarms` operation and specify the parent + # alarm names in the `AlarmNames` parameter. + # + # # @option options [String] :state_value - # The state value to be used in matching alarms. + # Specify this parameter to receive information only about alarms that + # are currently in the state that you specify. # @option options [String] :action_prefix - # The action name prefix. + # Use this parameter to filter the results of the operation to only + # those alarms that use a certain alarm action. For example, you could + # specify the ARN of an SNS topic to find all alarms that send + # notifications to that topic. # @return [Alarm::Collection] def alarms(options = {}) batches = Enumerator.new do |y| @@ -67,6 +119,104 @@ def alarms(options = {}) Alarm::Collection.new(batches) end + # @param [String] name + # @return [CompositeAlarm] + def composite_alarm(name) + CompositeAlarm.new( + name: name, + client: @client + ) + end + + # @example Request syntax with placeholder values + # + # composite_alarms = cloud_watch.composite_alarms({ + # alarm_names: ["AlarmName"], + # alarm_name_prefix: "AlarmNamePrefix", + # alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm + # children_of_alarm_name: "AlarmName", + # parents_of_alarm_name: "AlarmName", + # state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA + # action_prefix: "ActionPrefix", + # }) + # @param [Hash] options ({}) + # @option options [Array] :alarm_names + # The names of the alarms to retrieve information about. + # @option options [String] :alarm_name_prefix + # An alarm name prefix. If you specify this parameter, you receive + # information about all alarms that have names that start with this + # prefix. + # + # If this parameter is specified, you cannot specify `AlarmNames`. + # @option options [Array] :alarm_types + # 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. + # @option options [String] :children_of_alarm_name + # If you use this parameter and specify the name of a composite alarm, + # the operation returns information about the "children" alarms of the + # alarm you specify. These are the metric alarms and composite alarms + # referenced in the `AlarmRule` field of the composite alarm that you + # specify in `ChildrenOfAlarmName`. Information about the composite + # alarm that you name in `ChildrenOfAlarmName` is not returned. + # + # If you specify `ChildrenOfAlarmName`, you cannot specify any other + # parameters in the request except for `MaxRecords` and `NextToken`. If + # you do so, you will receive a validation error. + # + # Only the `Alarm Name`, `ARN`, `StateValue` + # (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` information + # are returned by this operation when you use this parameter. To get + # complete information about these alarms, perform another + # `DescribeAlarms` operation and specify the parent alarm names in the + # `AlarmNames` parameter. + # + # + # @option options [String] :parents_of_alarm_name + # If you use this parameter and specify the name of a metric or + # composite alarm, the operation returns information about the + # "parent" alarms of the alarm you specify. These are the composite + # alarms that have `AlarmRule` parameters that reference the alarm named + # in `ParentsOfAlarmName`. Information about the alarm that you specify + # in `ParentsOfAlarmName` is not returned. + # + # If you specify `ParentsOfAlarmName`, you cannot specify any other + # parameters in the request except for `MaxRecords` and `NextToken`. If + # you do so, you will receive a validation error. + # + # Only the Alarm Name and ARN are returned by this operation when you + # use this parameter. To get complete information about these alarms, + # perform another `DescribeAlarms` operation and specify the parent + # alarm names in the `AlarmNames` parameter. + # + # + # @option options [String] :state_value + # Specify this parameter to receive information only about alarms that + # are currently in the state that you specify. + # @option options [String] :action_prefix + # Use this parameter to filter the results of the operation to only + # those alarms that use a certain alarm action. For example, you could + # specify the ARN of an SNS topic to find all alarms that send + # notifications to that topic. + # @return [CompositeAlarm::Collection] + def composite_alarms(options = {}) + batches = Enumerator.new do |y| + resp = @client.describe_alarms(options) + resp.each_page do |page| + batch = [] + page.data.composite_alarms.each do |c| + batch << CompositeAlarm.new( + name: c.alarm_name, + data: c, + client: @client + ) + end + y.yield(batch) + end + end + CompositeAlarm::Collection.new(batches) + end + # @param [String] namespace # @param [String] name # @return [Metric] diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb index 2f4fc1233d7..7a575bbf4a1 100644 --- a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb @@ -14,6 +14,10 @@ module Types # The descriptive name for the alarm. # @return [String] # + # @!attribute [rw] alarm_type + # The type of alarm, either metric alarm or composite alarm. + # @return [String] + # # @!attribute [rw] timestamp # The time stamp for the alarm history item. # @return [Time] @@ -34,6 +38,7 @@ module Types # class AlarmHistoryItem < Struct.new( :alarm_name, + :alarm_type, :timestamp, :history_item_type, :history_summary, @@ -131,6 +136,86 @@ class AnomalyDetectorConfiguration < Struct.new( include Aws::Structure end + # The details about a composite alarm. + # + # @!attribute [rw] actions_enabled + # Indicates whether actions should be executed during any changes to + # the alarm state. + # @return [Boolean] + # + # @!attribute [rw] alarm_actions + # The actions to execute when this alarm transitions to the ALARM + # state from any other state. Each action is specified as an Amazon + # Resource Name (ARN). + # @return [Array] + # + # @!attribute [rw] alarm_arn + # The Amazon Resource Name (ARN) of the alarm. + # @return [String] + # + # @!attribute [rw] alarm_configuration_updated_timestamp + # The time stamp of the last update to the alarm configuration. + # @return [Time] + # + # @!attribute [rw] alarm_description + # The description of the alarm. + # @return [String] + # + # @!attribute [rw] alarm_name + # The name of the alarm. + # @return [String] + # + # @!attribute [rw] alarm_rule + # The rule that this alarm uses to evaluate its alarm state. + # @return [String] + # + # @!attribute [rw] insufficient_data_actions + # The actions to execute when this alarm transitions to the + # INSUFFICIENT\_DATA state from any other state. Each action is + # specified as an Amazon Resource Name (ARN). + # @return [Array] + # + # @!attribute [rw] ok_actions + # The actions to execute when this alarm transitions to the OK state + # from any other state. Each action is specified as an Amazon Resource + # Name (ARN). + # @return [Array] + # + # @!attribute [rw] state_reason + # An explanation for the alarm state, in text format. + # @return [String] + # + # @!attribute [rw] state_reason_data + # An explanation for the alarm state, in JSON format. + # @return [String] + # + # @!attribute [rw] state_updated_timestamp + # The time stamp of the last update to the alarm state. + # @return [Time] + # + # @!attribute [rw] state_value + # The state value for the alarm. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/CompositeAlarm AWS API Documentation + # + class CompositeAlarm < Struct.new( + :actions_enabled, + :alarm_actions, + :alarm_arn, + :alarm_configuration_updated_timestamp, + :alarm_description, + :alarm_name, + :alarm_rule, + :insufficient_data_actions, + :ok_actions, + :state_reason, + :state_reason_data, + :state_updated_timestamp, + :state_value) + include Aws::Structure + end + # More than one process tried to modify a resource at the same time. # # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ConcurrentModificationException AWS API Documentation @@ -359,7 +444,11 @@ class DeleteDashboardsOutput < Aws::EmptyStructure; end # # @!attribute [rw] rule_names # An array of the rule names to delete. If you need to find out the - # names of your rules, use DescribeInsightRules. + # names of your rules, use [DescribeInsightRules][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteInsightRulesInput AWS API Documentation @@ -386,17 +475,25 @@ class DeleteInsightRulesOutput < Struct.new( # # { # alarm_name: "AlarmName", + # alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm # history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action # start_date: Time.now, # end_date: Time.now, # max_records: 1, # next_token: "NextToken", + # scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending # } # # @!attribute [rw] alarm_name # The name of the alarm. # @return [String] # + # @!attribute [rw] alarm_types + # 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. + # @return [Array] + # # @!attribute [rw] history_item_type # The type of alarm histories to retrieve. # @return [String] @@ -418,15 +515,24 @@ class DeleteInsightRulesOutput < Struct.new( # data available. # @return [String] # + # @!attribute [rw] scan_by + # Specified whether to return the newest or oldest alarm history + # first. Specify `TimestampDescending` to have the newest event + # history returned first, and specify `TimestampAscending` to have the + # oldest history returned first. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistoryInput AWS API Documentation # class DescribeAlarmHistoryInput < Struct.new( :alarm_name, + :alarm_types, :history_item_type, :start_date, :end_date, :max_records, - :next_token) + :next_token, + :scan_by) include Aws::Structure end @@ -527,6 +633,9 @@ class DescribeAlarmsForMetricOutput < Struct.new( # { # alarm_names: ["AlarmName"], # alarm_name_prefix: "AlarmNamePrefix", + # alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm + # children_of_alarm_name: "AlarmName", + # parents_of_alarm_name: "AlarmName", # state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA # action_prefix: "ActionPrefix", # max_records: 1, @@ -534,20 +643,76 @@ class DescribeAlarmsForMetricOutput < Struct.new( # } # # @!attribute [rw] alarm_names - # The names of the alarms. + # The names of the alarms to retrieve information about. # @return [Array] # # @!attribute [rw] alarm_name_prefix - # The alarm name prefix. If this parameter is specified, you cannot - # specify `AlarmNames`. + # An alarm name prefix. If you specify this parameter, you receive + # information about all alarms that have names that start with this + # prefix. + # + # If this parameter is specified, you cannot specify `AlarmNames`. + # @return [String] + # + # @!attribute [rw] alarm_types + # 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. + # @return [Array] + # + # @!attribute [rw] children_of_alarm_name + # If you use this parameter and specify the name of a composite alarm, + # the operation returns information about the "children" alarms of + # the alarm you specify. These are the metric alarms and composite + # alarms referenced in the `AlarmRule` field of the composite alarm + # that you specify in `ChildrenOfAlarmName`. Information about the + # composite alarm that you name in `ChildrenOfAlarmName` is not + # returned. + # + # If you specify `ChildrenOfAlarmName`, you cannot specify any other + # parameters in the request except for `MaxRecords` and `NextToken`. + # If you do so, you will receive a validation error. + # + # Only the `Alarm Name`, `ARN`, `StateValue` + # (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` + # information are returned by this operation when you use this + # parameter. To get complete information about these alarms, perform + # another `DescribeAlarms` operation and specify the parent alarm + # names in the `AlarmNames` parameter. + # + # + # @return [String] + # + # @!attribute [rw] parents_of_alarm_name + # If you use this parameter and specify the name of a metric or + # composite alarm, the operation returns information about the + # "parent" alarms of the alarm you specify. These are the composite + # alarms that have `AlarmRule` parameters that reference the alarm + # named in `ParentsOfAlarmName`. Information about the alarm that you + # specify in `ParentsOfAlarmName` is not returned. + # + # If you specify `ParentsOfAlarmName`, you cannot specify any other + # parameters in the request except for `MaxRecords` and `NextToken`. + # If you do so, you will receive a validation error. + # + # Only the Alarm Name and ARN are returned by this operation when you + # use this parameter. To get complete information about these alarms, + # perform another `DescribeAlarms` operation and specify the parent + # alarm names in the `AlarmNames` parameter. + # + # # @return [String] # # @!attribute [rw] state_value - # The state value to be used in matching alarms. + # Specify this parameter to receive information only about alarms that + # are currently in the state that you specify. # @return [String] # # @!attribute [rw] action_prefix - # The action name prefix. + # Use this parameter to filter the results of the operation to only + # those alarms that use a certain alarm action. For example, you could + # specify the ARN of an SNS topic to find all alarms that send + # notifications to that topic. # @return [String] # # @!attribute [rw] max_records @@ -564,6 +729,9 @@ class DescribeAlarmsForMetricOutput < Struct.new( class DescribeAlarmsInput < Struct.new( :alarm_names, :alarm_name_prefix, + :alarm_types, + :children_of_alarm_name, + :parents_of_alarm_name, :state_value, :action_prefix, :max_records, @@ -571,8 +739,13 @@ class DescribeAlarmsInput < Struct.new( include Aws::Structure end + # @!attribute [rw] composite_alarms + # The information about any composite alarms returned by the + # operation. + # @return [Array] + # # @!attribute [rw] metric_alarms - # The information for the specified alarms. + # The information about any metric alarms returned by the operation. # @return [Array] # # @!attribute [rw] next_token @@ -583,6 +756,7 @@ class DescribeAlarmsInput < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsOutput AWS API Documentation # class DescribeAlarmsOutput < Struct.new( + :composite_alarms, :metric_alarms, :next_token) include Aws::Structure @@ -611,7 +785,7 @@ class DescribeAlarmsOutput < Struct.new( # # @!attribute [rw] max_results # The maximum number of results to return in one operation. The - # maximum value you can specify is 10. + # maximum value that you can specify is 100. # # To retrieve the remaining results, make another call with the # returned `NextToken` value. @@ -784,7 +958,11 @@ class DisableAlarmActionsInput < Struct.new( # # @!attribute [rw] rule_names # An array of the rule names to disable. If you need to find out the - # names of your rules, use DescribeInsightRules. + # names of your rules, use [DescribeInsightRules][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableInsightRulesInput AWS API Documentation @@ -833,7 +1011,11 @@ class EnableAlarmActionsInput < Struct.new( # # @!attribute [rw] rule_names # An array of the rule names to enable. If you need to find out the - # names of your rules, use DescribeInsightRules. + # names of your rules, use [DescribeInsightRules][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableInsightRulesInput AWS API Documentation @@ -880,8 +1062,12 @@ class GetDashboardInput < Struct.new( # @!attribute [rw] dashboard_body # The detailed information about the dashboard, including what widgets # are included and their location on the dashboard. For more - # information about the `DashboardBody` syntax, see - # CloudWatch-Dashboard-Body-Structure. + # information about the `DashboardBody` syntax, see [Dashboard Body + # Structure and Syntax][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html # @return [String] # # @!attribute [rw] dashboard_name @@ -1069,7 +1255,7 @@ class GetInsightRuleReportOutput < Struct.new( # # @!attribute [rw] metric_data_queries # The metric queries to be returned. A single `GetMetricData` call can - # include as many as 100 `MetricDataQuery` structures. Each of these + # include as many as 500 `MetricDataQuery` structures. Each of these # structures can specify either a metric to retrieve, or a math # expression to perform on retrieved data. # @return [Array] @@ -1365,11 +1551,15 @@ class GetMetricStatisticsOutput < Struct.new( # `MetricWidget` parameter in each `GetMetricWidgetImage` call. # # For more information about the syntax of `MetricWidget` see - # CloudWatch-Metric-Widget-Structure. + # [GetMetricWidgetImage: Metric Widget Structure and Syntax][1]. # # 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. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html # @return [String] # # @!attribute [rw] output_format @@ -1471,7 +1661,11 @@ class InsightRule < Struct.new( # If the rule contains a single key, then each unique contributor is # each unique value for this key. # - # For more information, see GetInsightRuleReport. + # For more information, see [GetInsightRuleReport][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html # # @!attribute [rw] keys # One of the log entry field keywords that is used to define @@ -1500,8 +1694,13 @@ class InsightRuleContributor < Struct.new( # One data point related to one contributor. # - # For more information, see GetInsightRuleReport and - # InsightRuleContributor. + # For more information, see [GetInsightRuleReport][1] and + # [InsightRuleContributor][2]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html + # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html # # @!attribute [rw] timestamp # The timestamp of the data point. @@ -1523,7 +1722,11 @@ class InsightRuleContributorDatapoint < Struct.new( # One data point from the metric time series returned in a Contributor # Insights rule report. # - # For more information, see GetInsightRuleReport. + # For more information, see [GetInsightRuleReport][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html # # @!attribute [rw] timestamp # The timestamp of the data point. @@ -1875,7 +2078,7 @@ class Metric < Struct.new( include Aws::Structure end - # Represents an alarm. + # The details about a metric alarm. # # @!attribute [rw] alarm_name # The name of the alarm. @@ -2050,7 +2253,7 @@ class MetricAlarm < Struct.new( # When used in `GetMetricData`, it indicates the metric data to return, # and whether this call is just retrieving a batch set of data for one # metric, or is performing a math expression on metric data. A single - # `GetMetricData` call can include up to 100 `MetricDataQuery` + # `GetMetricData` call can include up to 500 `MetricDataQuery` # structures. # # When used in `PutMetricAlarm`, it enables you to create an alarm based @@ -2168,11 +2371,6 @@ class MetricAlarm < Struct.new( # 60. High-resolution metrics are those metrics stored by a # `PutMetricData` operation that includes a `StorageResolution of 1 # second`. - # - # If you are performing a `GetMetricData` operation, use this field - # only if you are specifying an `Expression`. Do not use this field - # when you are specifying a `MetricStat` in a `GetMetricData` - # operation. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataQuery AWS API Documentation @@ -2547,6 +2745,146 @@ class PutAnomalyDetectorInput < Struct.new( # class PutAnomalyDetectorOutput < Aws::EmptyStructure; end + # @note When making an API call, you may pass PutCompositeAlarmInput + # data as a hash: + # + # { + # actions_enabled: false, + # alarm_actions: ["ResourceName"], + # alarm_description: "AlarmDescription", + # alarm_name: "AlarmName", # required + # alarm_rule: "AlarmRule", # required + # insufficient_data_actions: ["ResourceName"], + # ok_actions: ["ResourceName"], + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", # required + # }, + # ], + # } + # + # @!attribute [rw] actions_enabled + # Indicates whether actions should be executed during any changes to + # the alarm state of the composite alarm. The default is `TRUE`. + # @return [Boolean] + # + # @!attribute [rw] alarm_actions + # The actions to execute when this alarm transitions to the `ALARM` + # state from any other state. Each action is specified as an Amazon + # Resource Name (ARN). + # + # Valid Values: `arn:aws:sns:region:account-id:sns-topic-name ` + # @return [Array] + # + # @!attribute [rw] alarm_description + # The description for the composite alarm. + # @return [String] + # + # @!attribute [rw] alarm_name + # The name for the composite alarm. This name must be unique within + # your AWS account. + # @return [String] + # + # @!attribute [rw] alarm_rule + # An expression that specifies which other alarms are to be evaluated + # to determine this composite alarm's state. For each alarm that you + # reference, you designate a function that specifies whether that + # alarm needs to be in ALARM state, OK state, or INSUFFICIENT\_DATA + # state. You can use operators (AND, OR and NOT) to combine multiple + # functions in a single expression. You can use parenthesis to + # logically group the functions in your expression. + # + # You can use either alarm names or ARNs to reference the other alarms + # that are to be evaluated. + # + # Functions can include the following: + # + # * `ALARM("alarm-name or alarm-ARN")` is TRUE if the named alarm is + # in ALARM state. + # + # * `OK("alarm-name or alarm-ARN")` is TRUE if the named alarm is in + # OK state. + # + # * `INSUFFICIENT_DATA("alarm-name or alarm-ARN")` is TRUE if the + # named alarm is in INSUFFICIENT\_DATA state. + # + # * `TRUE` always evaluates to TRUE. + # + # * `FALSE` always evaluates to FALSE. + # + # TRUE and FALSE are useful for testing a complex `AlarmRule` + # structure, and for testing your alarm actions. + # + # Alarm names specified in `AlarmRule` can be surrounded with + # double-quotes ("), but do not have to be. + # + # The following are some examples of `AlarmRule`\: + # + # * `ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)` + # specifies that the composite alarm goes into ALARM state only if + # both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in + # ALARM state. + # + # * `ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)` + # specifies that the alarm goes to ALARM state if + # CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress + # is not in ALARM state. This example reduces alarm noise during a + # known deployment window. + # + # * `(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND + # OK(NetworkOutTooHigh)` goes into ALARM state if + # CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and + # if NetworkOutTooHigh is in OK state. This provides another example + # of using a composite alarm to prevent noise. This rule ensures + # that you are not notified with an alarm action on high CPU or disk + # usage if a known network problem is also occurring. + # + # The `AlarmRule` can specify as many as 100 "children" alarms. The + # `AlarmRule` expression can have as many as 500 elements. Elements + # are child alarms, TRUE or FALSE statements, and parentheses. + # @return [String] + # + # @!attribute [rw] insufficient_data_actions + # The actions to execute when this alarm transitions to the + # `INSUFFICIENT_DATA` state from any other state. Each action is + # specified as an Amazon Resource Name (ARN). + # + # Valid Values: `arn:aws:sns:region:account-id:sns-topic-name ` + # @return [Array] + # + # @!attribute [rw] ok_actions + # The actions to execute when this alarm transitions to an `OK` state + # from any other state. Each action is specified as an Amazon Resource + # Name (ARN). + # + # Valid Values: `arn:aws:sns:region:account-id:sns-topic-name ` + # @return [Array] + # + # @!attribute [rw] tags + # A list of key-value pairs to associate with the composite alarm. You + # can associate as many as 50 tags with an alarm. + # + # 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. + # @return [Array] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarmInput AWS API Documentation + # + class PutCompositeAlarmInput < Struct.new( + :actions_enabled, + :alarm_actions, + :alarm_description, + :alarm_name, + :alarm_rule, + :insufficient_data_actions, + :ok_actions, + :tags) + include Aws::Structure + end + # @note When making an API call, you may pass PutDashboardInput # data as a hash: # @@ -2568,8 +2906,12 @@ class PutAnomalyDetectorOutput < Aws::EmptyStructure; end # including the widgets to include and their location on the # dashboard. This parameter is required. # - # For more information about the syntax, see - # CloudWatch-Dashboard-Body-Structure. + # For more information about the syntax, see [Dashboard Body Structure + # and Syntax][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboardInput AWS API Documentation @@ -2723,7 +3065,7 @@ class PutInsightRuleOutput < Aws::EmptyStructure; end # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -2744,7 +3086,7 @@ class PutInsightRuleOutput < Aws::EmptyStructure; end # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -2765,7 +3107,7 @@ class PutInsightRuleOutput < Aws::EmptyStructure; end # `arn:aws:automate:region:ec2:recover` \| # `arn:aws:automate:region:ec2:reboot` \| # `arn:aws:sns:region:account-id:sns-topic-name ` \| - # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name + # `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name # ` # # Valid Values (for use with IAM roles): @@ -2944,13 +3286,17 @@ class PutInsightRuleOutput < Aws::EmptyStructure; end # One item in the `Metrics` array is the expression that the alarm # watches. You designate this expression by setting `ReturnValue` to # true for this object in the array. For more information, see - # MetricDataQuery. + # [MetricDataQuery][1]. # # If you use the `Metrics` parameter, you cannot include the # `MetricName`, `Dimensions`, `Period`, `Namespace`, `Statistic`, or # `ExtendedStatistic` parameters of `PutMetricAlarm` in the same # operation. Instead, you retrieve the metrics you are using in your # math expression as part of the `Metrics` array. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html # @return [Array] # # @!attribute [rw] tags @@ -3136,6 +3482,11 @@ class ResourceNotFoundException < Struct.new( # @!attribute [rw] state_reason_data # The reason that this alarm is set to this specific state, in JSON # format. + # + # For SNS or EC2 alarm actions, this is just informational. But for + # EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto + # Scaling policy uses the information in this field to take the + # correct action. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmStateInput AWS API Documentation diff --git a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/waiters.rb b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/waiters.rb index f6de2509c28..d16b093f008 100644 --- a/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/waiters.rb +++ b/gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/waiters.rb @@ -45,5 +45,41 @@ def wait(params = {}) attr_reader :waiter end + + class CompositeAlarmExists + + # @param [Hash] options + # @option options [required, Client] :client + # @option options [Integer] :max_attempts (40) + # @option options [Integer] :delay (5) + # @option options [Proc] :before_attempt + # @option options [Proc] :before_wait + def initialize(options) + @client = options.fetch(:client) + @waiter = Aws::Waiters::Waiter.new({ + max_attempts: 40, + delay: 5, + poller: Aws::Waiters::Poller.new( + operation_name: :describe_alarms, + acceptors: [{ + "matcher" => "path", + "expected" => true, + "argument" => "length(composite_alarms[]) > `0`", + "state" => "success" + }] + ) + }.merge(options)) + end + + # @option (see Client#describe_alarms) + # @return (see Client#describe_alarms) + def wait(params = {}) + @waiter.wait(client: @client, params: params) + end + + # @api private + attr_reader :waiter + + end end end diff --git a/gems/aws-sdk-codeguruprofiler/CHANGELOG.md b/gems/aws-sdk-codeguruprofiler/CHANGELOG.md index 27ec9c29cab..ad2dbe80cbd 100644 --- a/gems/aws-sdk-codeguruprofiler/CHANGELOG.md +++ b/gems/aws-sdk-codeguruprofiler/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.1.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.1.0 (2020-02-28) diff --git a/gems/aws-sdk-codeguruprofiler/VERSION b/gems/aws-sdk-codeguruprofiler/VERSION index 9084fa2f716..524cb55242b 100644 --- a/gems/aws-sdk-codeguruprofiler/VERSION +++ b/gems/aws-sdk-codeguruprofiler/VERSION @@ -1 +1 @@ -1.1.0 +1.1.1 diff --git a/gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler.rb b/gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler.rb index 7bcd547cd7c..26aba032379 100644 --- a/gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler.rb +++ b/gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler.rb @@ -42,6 +42,6 @@ # @service module Aws::CodeGuruProfiler - GEM_VERSION = '1.1.0' + GEM_VERSION = '1.1.1' end diff --git a/gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/client.rb b/gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/client.rb index 1d058d7cc67..824f72166d2 100644 --- a/gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/client.rb +++ b/gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/client.rb @@ -688,7 +688,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-codeguruprofiler' - context[:gem_version] = '1.1.0' + context[:gem_version] = '1.1.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-comprehendmedical/CHANGELOG.md b/gems/aws-sdk-comprehendmedical/CHANGELOG.md index d2fd4446a78..842c6ebd2fb 100644 --- a/gems/aws-sdk-comprehendmedical/CHANGELOG.md +++ b/gems/aws-sdk-comprehendmedical/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.13.0 (2020-03-02) +------------------ + +* Feature - New Time Expression feature, part of DetectEntitiesV2 API will provide temporal relations to existing NERe entities such as Medication, Test, Treatment, Procedure and Medical conditions. + 1.12.0 (2019-12-16) ------------------ diff --git a/gems/aws-sdk-comprehendmedical/VERSION b/gems/aws-sdk-comprehendmedical/VERSION index 0eed1a29efd..feaae22bac7 100644 --- a/gems/aws-sdk-comprehendmedical/VERSION +++ b/gems/aws-sdk-comprehendmedical/VERSION @@ -1 +1 @@ -1.12.0 +1.13.0 diff --git a/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical.rb b/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical.rb index 6f7ce7f153a..b82e186e1cd 100644 --- a/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical.rb +++ b/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical.rb @@ -42,6 +42,6 @@ # @service module Aws::ComprehendMedical - GEM_VERSION = '1.12.0' + GEM_VERSION = '1.13.0' end diff --git a/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb b/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb index 8c8f9a5cc44..f3ce02dbc4f 100644 --- a/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb +++ b/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb @@ -390,31 +390,35 @@ def describe_phi_detection_job(params = {}, options = {}) # resp.entities[0].end_offset #=> Integer # resp.entities[0].score #=> Float # resp.entities[0].text #=> String - # resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY" - # resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY" + # resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" + # resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME" # resp.entities[0].traits #=> Array # resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION" # resp.entities[0].traits[0].score #=> Float # resp.entities[0].attributes #=> Array - # resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY" + # resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME" # resp.entities[0].attributes[0].score #=> Float # resp.entities[0].attributes[0].relationship_score #=> Float + # resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION" # resp.entities[0].attributes[0].id #=> Integer # resp.entities[0].attributes[0].begin_offset #=> Integer # resp.entities[0].attributes[0].end_offset #=> Integer # resp.entities[0].attributes[0].text #=> String + # resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" # resp.entities[0].attributes[0].traits #=> Array # resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION" # resp.entities[0].attributes[0].traits[0].score #=> Float # resp.unmapped_attributes #=> Array - # resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY" - # resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY" + # resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" + # resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME" # resp.unmapped_attributes[0].attribute.score #=> Float # resp.unmapped_attributes[0].attribute.relationship_score #=> Float + # resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION" # resp.unmapped_attributes[0].attribute.id #=> Integer # resp.unmapped_attributes[0].attribute.begin_offset #=> Integer # resp.unmapped_attributes[0].attribute.end_offset #=> Integer # resp.unmapped_attributes[0].attribute.text #=> String + # resp.unmapped_attributes[0].attribute.category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" # resp.unmapped_attributes[0].attribute.traits #=> Array # resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION" # resp.unmapped_attributes[0].attribute.traits[0].score #=> Float @@ -432,7 +436,8 @@ def detect_entities(params = {}, options = {}) # Inspects the clinical text for a variety of medical entities and # returns specific information about them such as entity category, - # location, and confidence score on that information. + # location, and confidence score on that information. Amazon Comprehend + # Medical only detects medical entities in English language texts. # # The `DetectEntitiesV2` operation replaces the DetectEntities # operation. This new action uses a different model for determining the @@ -469,31 +474,35 @@ def detect_entities(params = {}, options = {}) # resp.entities[0].end_offset #=> Integer # resp.entities[0].score #=> Float # resp.entities[0].text #=> String - # resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY" - # resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY" + # resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" + # resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME" # resp.entities[0].traits #=> Array # resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION" # resp.entities[0].traits[0].score #=> Float # resp.entities[0].attributes #=> Array - # resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY" + # resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME" # resp.entities[0].attributes[0].score #=> Float # resp.entities[0].attributes[0].relationship_score #=> Float + # resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION" # resp.entities[0].attributes[0].id #=> Integer # resp.entities[0].attributes[0].begin_offset #=> Integer # resp.entities[0].attributes[0].end_offset #=> Integer # resp.entities[0].attributes[0].text #=> String + # resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" # resp.entities[0].attributes[0].traits #=> Array # resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION" # resp.entities[0].attributes[0].traits[0].score #=> Float # resp.unmapped_attributes #=> Array - # resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY" - # resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY" + # resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" + # resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME" # resp.unmapped_attributes[0].attribute.score #=> Float # resp.unmapped_attributes[0].attribute.relationship_score #=> Float + # resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION" # resp.unmapped_attributes[0].attribute.id #=> Integer # resp.unmapped_attributes[0].attribute.begin_offset #=> Integer # resp.unmapped_attributes[0].attribute.end_offset #=> Integer # resp.unmapped_attributes[0].attribute.text #=> String + # resp.unmapped_attributes[0].attribute.category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" # resp.unmapped_attributes[0].attribute.traits #=> Array # resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION" # resp.unmapped_attributes[0].attribute.traits[0].score #=> Float @@ -510,8 +519,9 @@ def detect_entities_v2(params = {}, options = {}) end # Inspects the clinical text for protected health information (PHI) - # entities and entity category, location, and confidence score on that - # information. + # entities and returns the entity category, location, and confidence + # score for each entity. Amazon Comprehend Medical only detects entities + # in English language texts. # # @option params [required, String] :text # A UTF-8 text string containing the clinical content being examined for @@ -538,19 +548,21 @@ def detect_entities_v2(params = {}, options = {}) # resp.entities[0].end_offset #=> Integer # resp.entities[0].score #=> Float # resp.entities[0].text #=> String - # resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY" - # resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY" + # resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" + # resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME" # resp.entities[0].traits #=> Array # resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION" # resp.entities[0].traits[0].score #=> Float # resp.entities[0].attributes #=> Array - # resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY" + # resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME" # resp.entities[0].attributes[0].score #=> Float # resp.entities[0].attributes[0].relationship_score #=> Float + # resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION" # resp.entities[0].attributes[0].id #=> Integer # resp.entities[0].attributes[0].begin_offset #=> Integer # resp.entities[0].attributes[0].end_offset #=> Integer # resp.entities[0].attributes[0].text #=> String + # resp.entities[0].attributes[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION" # resp.entities[0].attributes[0].traits #=> Array # resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION" # resp.entities[0].attributes[0].traits[0].score #=> Float @@ -569,7 +581,8 @@ def detect_phi(params = {}, options = {}) # InferICD10CM detects medical conditions as entities listed in a # patient record and links those entities to normalized concept # identifiers in the ICD-10-CM knowledge base from the Centers for - # Disease Control. + # Disease Control. Amazon Comprehend Medical only detects medical + # entities in English language texts. # # @option params [required, String] :text # The input text used for analysis. The input for InferICD10CM is a @@ -629,7 +642,8 @@ def infer_icd10cm(params = {}, options = {}) # InferRxNorm detects medications as entities listed in a patient record # and links to the normalized concept identifiers in the RxNorm database - # from the National Library of Medicine. + # from the National Library of Medicine. Amazon Comprehend Medical only + # detects medical entities in English language texts. # # @option params [required, String] :text # The input text used for analysis. The input for InferRxNorm is a @@ -1027,7 +1041,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-comprehendmedical' - context[:gem_version] = '1.12.0' + context[:gem_version] = '1.13.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client_api.rb b/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client_api.rb index ae138c2877e..892d476334a 100644 --- a/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client_api.rb +++ b/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client_api.rb @@ -71,6 +71,7 @@ module ClientApi ModelVersion = Shapes::StringShape.new(name: 'ModelVersion') OntologyLinkingBoundedLengthString = Shapes::StringShape.new(name: 'OntologyLinkingBoundedLengthString') OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig') + RelationshipType = Shapes::StringShape.new(name: 'RelationshipType') ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException') RxNormAttribute = Shapes::StructureShape.new(name: 'RxNormAttribute') RxNormAttributeList = Shapes::ListShape.new(name: 'RxNormAttributeList') @@ -108,10 +109,12 @@ module ClientApi Attribute.add_member(:type, Shapes::ShapeRef.new(shape: EntitySubType, location_name: "Type")) Attribute.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score")) Attribute.add_member(:relationship_score, Shapes::ShapeRef.new(shape: Float, location_name: "RelationshipScore")) + Attribute.add_member(:relationship_type, Shapes::ShapeRef.new(shape: RelationshipType, location_name: "RelationshipType")) Attribute.add_member(:id, Shapes::ShapeRef.new(shape: Integer, location_name: "Id")) Attribute.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset")) Attribute.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset")) Attribute.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text")) + Attribute.add_member(:category, Shapes::ShapeRef.new(shape: EntityType, location_name: "Category")) Attribute.add_member(:traits, Shapes::ShapeRef.new(shape: TraitList, location_name: "Traits")) Attribute.struct_class = Types::Attribute diff --git a/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb b/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb index faf237f1e2a..080d0ea4031 100644 --- a/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb +++ b/gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb @@ -28,6 +28,12 @@ module Types # attribute is correctly related to this entity. # @return [Float] # + # @!attribute [rw] relationship_type + # The type of relationship between the entity and attribute. Type for + # the relationship is `OVERLAP`, indicating that the entity occurred + # at the same time as the `Date_Expression`. + # @return [String] + # # @!attribute [rw] id # The numeric identifier for this attribute. This is a monotonically # increasing id unique within this response rather than a global @@ -50,6 +56,10 @@ module Types # The segment of input text extracted as this attribute. # @return [String] # + # @!attribute [rw] category + # The category of attribute. + # @return [String] + # # @!attribute [rw] traits # Contextual information for this attribute. # @return [Array] @@ -60,10 +70,12 @@ class Attribute < Struct.new( :type, :score, :relationship_score, + :relationship_type, :id, :begin_offset, :end_offset, :text, + :category, :traits) include Aws::Structure end @@ -759,7 +771,7 @@ class InferRxNormResponse < Struct.new( include Aws::Structure end - # The input properties for an entities detection job + # The input properties for an entities detection job. # # @note When making an API call, you may pass InputDataConfig # data as a hash: diff --git a/gems/aws-sdk-configservice/CHANGELOG.md b/gems/aws-sdk-configservice/CHANGELOG.md index 6a8a175ae1f..3984bfa7b89 100644 --- a/gems/aws-sdk-configservice/CHANGELOG.md +++ b/gems/aws-sdk-configservice/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.42.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked versions. 1.42.0 (2020-02-29) diff --git a/gems/aws-sdk-configservice/VERSION b/gems/aws-sdk-configservice/VERSION index a50908ca3da..e640847f99c 100644 --- a/gems/aws-sdk-configservice/VERSION +++ b/gems/aws-sdk-configservice/VERSION @@ -1 +1 @@ -1.42.0 +1.42.1 diff --git a/gems/aws-sdk-configservice/lib/aws-sdk-configservice.rb b/gems/aws-sdk-configservice/lib/aws-sdk-configservice.rb index 52a09ed0cd8..f361cdcf830 100644 --- a/gems/aws-sdk-configservice/lib/aws-sdk-configservice.rb +++ b/gems/aws-sdk-configservice/lib/aws-sdk-configservice.rb @@ -42,6 +42,6 @@ # @service module Aws::ConfigService - GEM_VERSION = '1.42.0' + GEM_VERSION = '1.42.1' end diff --git a/gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb b/gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb index 6842f2f0805..8dffbec9b84 100644 --- a/gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb +++ b/gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb @@ -4538,7 +4538,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-configservice' - context[:gem_version] = '1.42.0' + context[:gem_version] = '1.42.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-dynamodb/CHANGELOG.md b/gems/aws-sdk-dynamodb/CHANGELOG.md index 1d76dbb6ecd..9bc6853555f 100644 --- a/gems/aws-sdk-dynamodb/CHANGELOG.md +++ b/gems/aws-sdk-dynamodb/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.44.0 (2020-03-02) +------------------ + +* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details. + 1.43.0 (2020-02-17) ------------------ diff --git a/gems/aws-sdk-dynamodb/VERSION b/gems/aws-sdk-dynamodb/VERSION index b978278f05f..372cf402c73 100644 --- a/gems/aws-sdk-dynamodb/VERSION +++ b/gems/aws-sdk-dynamodb/VERSION @@ -1 +1 @@ -1.43.0 +1.44.0 diff --git a/gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb.rb b/gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb.rb index 14ce8026062..583f95eae97 100644 --- a/gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb.rb +++ b/gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb.rb @@ -44,6 +44,6 @@ # @service module Aws::DynamoDB - GEM_VERSION = '1.43.0' + GEM_VERSION = '1.44.0' end diff --git a/gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb b/gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb index a24469b8c38..9a52e12fd7d 100644 --- a/gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb +++ b/gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/client.rb @@ -190,7 +190,7 @@ class Client < Seahorse::Client::Base # # @see https://www.awsarchitectureblog.com/2015/03/backoff.html # - # @option options [Integer] :retry_limit (3) + # @option options [Integer] :retry_limit (10) # The maximum number of times to retry failed requests. Only # ~ 500 level server errors and certain ~ 400 level client errors # are retried. Generally, these are throttling errors, data @@ -6561,7 +6561,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-dynamodb' - context[:gem_version] = '1.43.0' + context[:gem_version] = '1.44.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-elasticloadbalancingv2/CHANGELOG.md b/gems/aws-sdk-elasticloadbalancingv2/CHANGELOG.md index 896bab36fab..6a9a37b98c0 100644 --- a/gems/aws-sdk-elasticloadbalancingv2/CHANGELOG.md +++ b/gems/aws-sdk-elasticloadbalancingv2/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.40.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.40.0 (2020-02-28) diff --git a/gems/aws-sdk-elasticloadbalancingv2/VERSION b/gems/aws-sdk-elasticloadbalancingv2/VERSION index 32b7211cb61..53a714f1ddf 100644 --- a/gems/aws-sdk-elasticloadbalancingv2/VERSION +++ b/gems/aws-sdk-elasticloadbalancingv2/VERSION @@ -1 +1 @@ -1.40.0 +1.40.1 diff --git a/gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2.rb b/gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2.rb index 6055ea41c41..1678755dbce 100644 --- a/gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2.rb +++ b/gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2.rb @@ -43,6 +43,6 @@ # @service module Aws::ElasticLoadBalancingV2 - GEM_VERSION = '1.40.0' + GEM_VERSION = '1.40.1' end diff --git a/gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb b/gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb index d71927a2719..d35d00a16b6 100644 --- a/gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb +++ b/gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/client.rb @@ -4142,7 +4142,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-elasticloadbalancingv2' - context[:gem_version] = '1.40.0' + context[:gem_version] = '1.40.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-globalaccelerator/CHANGELOG.md b/gems/aws-sdk-globalaccelerator/CHANGELOG.md index 60e72a50a8d..78b92c37a65 100644 --- a/gems/aws-sdk-globalaccelerator/CHANGELOG.md +++ b/gems/aws-sdk-globalaccelerator/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.14.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.14.0 (2020-02-27) diff --git a/gems/aws-sdk-globalaccelerator/VERSION b/gems/aws-sdk-globalaccelerator/VERSION index 850e742404b..63e799cf451 100644 --- a/gems/aws-sdk-globalaccelerator/VERSION +++ b/gems/aws-sdk-globalaccelerator/VERSION @@ -1 +1 @@ -1.14.0 +1.14.1 diff --git a/gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator.rb b/gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator.rb index 927ace9d1f4..3951cca8d04 100644 --- a/gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator.rb +++ b/gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator.rb @@ -42,6 +42,6 @@ # @service module Aws::GlobalAccelerator - GEM_VERSION = '1.14.0' + GEM_VERSION = '1.14.1' end diff --git a/gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb b/gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb index c4bf132fb9a..dc131c47529 100644 --- a/gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb +++ b/gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb @@ -1615,7 +1615,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-globalaccelerator' - context[:gem_version] = '1.14.0' + context[:gem_version] = '1.14.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-glue/CHANGELOG.md b/gems/aws-sdk-glue/CHANGELOG.md index b58ab4baf56..dca917a4109 100644 --- a/gems/aws-sdk-glue/CHANGELOG.md +++ b/gems/aws-sdk-glue/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.49.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.49.0 (2020-02-28) diff --git a/gems/aws-sdk-glue/VERSION b/gems/aws-sdk-glue/VERSION index 7f3a46a841e..29306a90b94 100644 --- a/gems/aws-sdk-glue/VERSION +++ b/gems/aws-sdk-glue/VERSION @@ -1 +1 @@ -1.49.0 +1.49.1 diff --git a/gems/aws-sdk-glue/lib/aws-sdk-glue.rb b/gems/aws-sdk-glue/lib/aws-sdk-glue.rb index afa859c291a..897455cff14 100644 --- a/gems/aws-sdk-glue/lib/aws-sdk-glue.rb +++ b/gems/aws-sdk-glue/lib/aws-sdk-glue.rb @@ -42,6 +42,6 @@ # @service module Aws::Glue - GEM_VERSION = '1.49.0' + GEM_VERSION = '1.49.1' end diff --git a/gems/aws-sdk-glue/lib/aws-sdk-glue/client.rb b/gems/aws-sdk-glue/lib/aws-sdk-glue/client.rb index 035402afb2b..289360d5b41 100644 --- a/gems/aws-sdk-glue/lib/aws-sdk-glue/client.rb +++ b/gems/aws-sdk-glue/lib/aws-sdk-glue/client.rb @@ -8025,7 +8025,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-glue' - context[:gem_version] = '1.49.0' + context[:gem_version] = '1.49.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-lightsail/CHANGELOG.md b/gems/aws-sdk-lightsail/CHANGELOG.md index 3b6eaa2c4aa..aaa6c5af5b9 100644 --- a/gems/aws-sdk-lightsail/CHANGELOG.md +++ b/gems/aws-sdk-lightsail/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.28.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.28.0 (2020-02-27) diff --git a/gems/aws-sdk-lightsail/VERSION b/gems/aws-sdk-lightsail/VERSION index cfc730712d5..450a687b2da 100644 --- a/gems/aws-sdk-lightsail/VERSION +++ b/gems/aws-sdk-lightsail/VERSION @@ -1 +1 @@ -1.28.0 +1.28.1 diff --git a/gems/aws-sdk-lightsail/lib/aws-sdk-lightsail.rb b/gems/aws-sdk-lightsail/lib/aws-sdk-lightsail.rb index 371485dee90..5afb48d6fb7 100644 --- a/gems/aws-sdk-lightsail/lib/aws-sdk-lightsail.rb +++ b/gems/aws-sdk-lightsail/lib/aws-sdk-lightsail.rb @@ -42,6 +42,6 @@ # @service module Aws::Lightsail - GEM_VERSION = '1.28.0' + GEM_VERSION = '1.28.1' end diff --git a/gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb b/gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb index a016c86ad83..335587162d6 100644 --- a/gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb +++ b/gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/client.rb @@ -7937,7 +7937,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-lightsail' - context[:gem_version] = '1.28.0' + context[:gem_version] = '1.28.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-quicksight/CHANGELOG.md b/gems/aws-sdk-quicksight/CHANGELOG.md index fa50bf9a618..692a2d9d18f 100644 --- a/gems/aws-sdk-quicksight/CHANGELOG.md +++ b/gems/aws-sdk-quicksight/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.17.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.17.0 (2020-02-28) diff --git a/gems/aws-sdk-quicksight/VERSION b/gems/aws-sdk-quicksight/VERSION index 092afa15df4..511a76e6faf 100644 --- a/gems/aws-sdk-quicksight/VERSION +++ b/gems/aws-sdk-quicksight/VERSION @@ -1 +1 @@ -1.17.0 +1.17.1 diff --git a/gems/aws-sdk-quicksight/lib/aws-sdk-quicksight.rb b/gems/aws-sdk-quicksight/lib/aws-sdk-quicksight.rb index f40f16d8a87..9397fd78146 100644 --- a/gems/aws-sdk-quicksight/lib/aws-sdk-quicksight.rb +++ b/gems/aws-sdk-quicksight/lib/aws-sdk-quicksight.rb @@ -42,6 +42,6 @@ # @service module Aws::QuickSight - GEM_VERSION = '1.17.0' + GEM_VERSION = '1.17.1' end diff --git a/gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb b/gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb index 5b7d56cfa0c..7bf05cdb029 100644 --- a/gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb +++ b/gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb @@ -4651,7 +4651,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-quicksight' - context[:gem_version] = '1.17.0' + context[:gem_version] = '1.17.1' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-workdocs/CHANGELOG.md b/gems/aws-sdk-workdocs/CHANGELOG.md index 4db97e11888..0b3cf109842 100644 --- a/gems/aws-sdk-workdocs/CHANGELOG.md +++ b/gems/aws-sdk-workdocs/CHANGELOG.md @@ -1,6 +1,9 @@ Unreleased Changes ------------------ +1.20.1 (2020-03-02) +------------------ + * Issue - Republish the previously yanked version. 1.20.0 (2020-02-28) diff --git a/gems/aws-sdk-workdocs/VERSION b/gems/aws-sdk-workdocs/VERSION index 39893559155..0044d6cb969 100644 --- a/gems/aws-sdk-workdocs/VERSION +++ b/gems/aws-sdk-workdocs/VERSION @@ -1 +1 @@ -1.20.0 +1.20.1 diff --git a/gems/aws-sdk-workdocs/lib/aws-sdk-workdocs.rb b/gems/aws-sdk-workdocs/lib/aws-sdk-workdocs.rb index 24ef7ea6be0..c0f28121dc7 100644 --- a/gems/aws-sdk-workdocs/lib/aws-sdk-workdocs.rb +++ b/gems/aws-sdk-workdocs/lib/aws-sdk-workdocs.rb @@ -42,6 +42,6 @@ # @service module Aws::WorkDocs - GEM_VERSION = '1.20.0' + GEM_VERSION = '1.20.1' end diff --git a/gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb b/gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb index 245412f7d32..c723adc0362 100644 --- a/gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb +++ b/gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb @@ -2497,7 +2497,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-workdocs' - context[:gem_version] = '1.20.0' + context[:gem_version] = '1.20.1' Seahorse::Client::Request.new(handlers, context) end