aws-sdk 1.8.5 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +1 -0
- data/README.rdoc +8 -0
- data/lib/aws-sdk.rb +39 -35
- data/lib/aws/api_config/CloudFront-2012-07-01.yml +2398 -0
- data/lib/aws/api_config/DirectConnect-2012-10-25.yml +475 -0
- data/lib/aws/api_config/DynamoDB-2011-12-05.yml +8 -0
- data/lib/aws/api_config/DynamoDB-2012-08-10.yml +1516 -0
- data/lib/aws/api_config/OpsWorks-2013-02-18.yml +2 -2
- data/lib/aws/auto_scaling.rb +44 -44
- data/lib/aws/auto_scaling/activity.rb +1 -1
- data/lib/aws/auto_scaling/activity_collection.rb +14 -15
- data/lib/aws/auto_scaling/client.rb +277 -277
- data/lib/aws/auto_scaling/config.rb +1 -1
- data/lib/aws/auto_scaling/group.rb +35 -36
- data/lib/aws/auto_scaling/group_collection.rb +10 -10
- data/lib/aws/auto_scaling/group_options.rb +19 -19
- data/lib/aws/auto_scaling/instance.rb +27 -27
- data/lib/aws/auto_scaling/instance_collection.rb +10 -10
- data/lib/aws/auto_scaling/launch_configuration.rb +3 -3
- data/lib/aws/auto_scaling/launch_configuration_collection.rb +1 -1
- data/lib/aws/auto_scaling/notification_configuration.rb +2 -2
- data/lib/aws/auto_scaling/notification_configuration_collection.rb +37 -38
- data/lib/aws/auto_scaling/scaling_policy.rb +3 -3
- data/lib/aws/auto_scaling/scaling_policy_collection.rb +6 -6
- data/lib/aws/auto_scaling/scaling_policy_options.rb +8 -7
- data/lib/aws/auto_scaling/scheduled_action.rb +3 -3
- data/lib/aws/auto_scaling/scheduled_action_collection.rb +28 -28
- data/lib/aws/auto_scaling/tag_collection.rb +30 -28
- data/lib/aws/cloud_formation.rb +95 -94
- data/lib/aws/cloud_formation/client.rb +136 -133
- data/lib/aws/cloud_formation/config.rb +1 -1
- data/lib/aws/cloud_formation/stack.rb +37 -37
- data/lib/aws/cloud_formation/stack_collection.rb +28 -27
- data/lib/aws/cloud_formation/stack_event.rb +9 -11
- data/lib/aws/cloud_formation/stack_output.rb +1 -1
- data/lib/aws/cloud_formation/stack_resource.rb +6 -6
- data/lib/aws/cloud_formation/stack_resource_collection.rb +11 -12
- data/lib/aws/cloud_formation/stack_resource_summary_collection.rb +11 -11
- data/lib/aws/cloud_formation/stack_summary_collection.rb +39 -39
- data/lib/aws/cloud_front.rb +21 -21
- data/lib/aws/cloud_front/client.rb +853 -652
- data/lib/aws/cloud_front/request.rb +3 -0
- data/lib/aws/cloud_search.rb +22 -22
- data/lib/aws/cloud_search/client.rb +322 -315
- data/lib/aws/cloud_search/config.rb +1 -1
- data/lib/aws/cloud_watch.rb +39 -39
- data/lib/aws/cloud_watch/alarm.rb +55 -37
- data/lib/aws/cloud_watch/alarm_collection.rb +18 -18
- data/lib/aws/cloud_watch/alarm_history_item_collection.rb +2 -2
- data/lib/aws/cloud_watch/client.rb +360 -146
- data/lib/aws/cloud_watch/config.rb +1 -1
- data/lib/aws/cloud_watch/metric.rb +15 -15
- data/lib/aws/cloud_watch/metric_alarm_collection.rb +17 -17
- data/lib/aws/cloud_watch/metric_collection.rb +16 -16
- data/lib/aws/cloud_watch/metric_statistics.rb +11 -11
- data/lib/aws/core.rb +243 -225
- data/lib/aws/core/async_handle.rb +13 -13
- data/lib/aws/core/cacheable.rb +14 -15
- data/lib/aws/core/client.rb +40 -15
- data/lib/aws/core/collection.rb +42 -46
- data/lib/aws/core/collection/with_limit_and_next_token.rb +1 -1
- data/lib/aws/core/collection/with_next_token.rb +1 -1
- data/lib/aws/core/configuration.rb +97 -133
- data/lib/aws/core/credential_providers.rb +16 -16
- data/lib/aws/core/data.rb +23 -23
- data/lib/aws/core/http/connection_pool.rb +348 -0
- data/lib/aws/core/http/net_http_handler.rb +17 -26
- data/lib/aws/core/http/patch.rb +102 -0
- data/lib/aws/core/http/request.rb +13 -19
- data/lib/aws/core/http/response.rb +2 -2
- data/lib/aws/core/lazy_error_classes.rb +17 -17
- data/lib/aws/core/log_formatter.rb +70 -104
- data/lib/aws/core/options/json_serializer.rb +1 -1
- data/lib/aws/core/options/validator.rb +4 -4
- data/lib/aws/core/page_result.rb +8 -8
- data/lib/aws/core/policy.rb +49 -49
- data/lib/aws/core/region.rb +72 -0
- data/lib/aws/core/region_collection.rb +106 -0
- data/lib/aws/core/resource.rb +5 -5
- data/lib/aws/core/response.rb +20 -17
- data/lib/aws/core/rest_request_builder.rb +4 -4
- data/lib/aws/core/service_interface.rb +24 -2
- data/lib/aws/core/signature/version_3.rb +2 -2
- data/lib/aws/core/uri_escape.rb +1 -1
- data/lib/aws/core/xml/frame_stack.rb +1 -1
- data/lib/aws/core/xml/grammar.rb +3 -4
- data/lib/aws/core/xml/sax_handlers/libxml.rb +2 -2
- data/lib/aws/core/xml/sax_handlers/nokogiri.rb +3 -3
- data/lib/aws/core/xml/sax_handlers/rexml.rb +5 -5
- data/lib/aws/core/xml/stub.rb +9 -9
- data/lib/aws/data_pipeline.rb +21 -21
- data/lib/aws/data_pipeline/client.rb +189 -133
- data/lib/aws/data_pipeline/config.rb +1 -1
- data/lib/aws/direct_connect.rb +74 -0
- data/lib/aws/direct_connect/client.rb +253 -0
- data/lib/aws/direct_connect/config.rb +18 -0
- data/lib/aws/direct_connect/errors.rb +22 -0
- data/lib/aws/direct_connect/request.rb +27 -0
- data/lib/aws/dynamo_db.rb +71 -69
- data/lib/aws/dynamo_db/attribute_collection.rb +53 -58
- data/lib/aws/dynamo_db/batch_get.rb +23 -23
- data/lib/aws/dynamo_db/batch_write.rb +43 -43
- data/lib/aws/dynamo_db/binary.rb +9 -9
- data/lib/aws/dynamo_db/client.rb +494 -509
- data/lib/aws/dynamo_db/client_base.rb +91 -0
- data/lib/aws/dynamo_db/client_v2.rb +825 -0
- data/lib/aws/dynamo_db/config.rb +1 -1
- data/lib/aws/dynamo_db/item.rb +10 -10
- data/lib/aws/dynamo_db/item_collection.rb +75 -75
- data/lib/aws/dynamo_db/table.rb +85 -85
- data/lib/aws/dynamo_db/table_collection.rb +13 -13
- data/lib/aws/ec2.rb +132 -142
- data/lib/aws/ec2/attachment.rb +31 -36
- data/lib/aws/ec2/attachment_collection.rb +1 -1
- data/lib/aws/ec2/availability_zone.rb +4 -4
- data/lib/aws/ec2/client.rb +2272 -2125
- data/lib/aws/ec2/config.rb +1 -1
- data/lib/aws/ec2/customer_gateway.rb +6 -6
- data/lib/aws/ec2/customer_gateway_collection.rb +6 -6
- data/lib/aws/ec2/dhcp_options.rb +3 -3
- data/lib/aws/ec2/dhcp_options_collection.rb +10 -10
- data/lib/aws/ec2/elastic_ip.rb +15 -15
- data/lib/aws/ec2/elastic_ip_collection.rb +11 -15
- data/lib/aws/ec2/export_task.rb +4 -4
- data/lib/aws/ec2/export_task_collection.rb +11 -11
- data/lib/aws/ec2/filtered_collection.rb +6 -8
- data/lib/aws/ec2/image.rb +46 -40
- data/lib/aws/ec2/image_collection.rb +44 -52
- data/lib/aws/ec2/instance.rb +64 -62
- data/lib/aws/ec2/instance_collection.rb +47 -50
- data/lib/aws/ec2/internet_gateway.rb +6 -6
- data/lib/aws/ec2/internet_gateway/attachment.rb +13 -13
- data/lib/aws/ec2/internet_gateway_collection.rb +3 -3
- data/lib/aws/ec2/key_pair.rb +3 -3
- data/lib/aws/ec2/key_pair_collection.rb +12 -12
- data/lib/aws/ec2/network_acl.rb +39 -39
- data/lib/aws/ec2/network_acl/association.rb +2 -2
- data/lib/aws/ec2/network_acl/entry.rb +22 -22
- data/lib/aws/ec2/network_acl_collection.rb +2 -2
- data/lib/aws/ec2/network_interface.rb +13 -4
- data/lib/aws/ec2/network_interface/attachment.rb +3 -3
- data/lib/aws/ec2/network_interface_collection.rb +5 -5
- data/lib/aws/ec2/permission_collection.rb +1 -1
- data/lib/aws/ec2/region.rb +6 -6
- data/lib/aws/ec2/region_collection.rb +1 -1
- data/lib/aws/ec2/reserved_instances_collection.rb +2 -2
- data/lib/aws/ec2/reserved_instances_offering_collection.rb +2 -2
- data/lib/aws/ec2/resource_tag_collection.rb +5 -5
- data/lib/aws/ec2/route_table.rb +14 -14
- data/lib/aws/ec2/route_table/association.rb +22 -22
- data/lib/aws/ec2/route_table/route.rb +8 -8
- data/lib/aws/ec2/route_table_collection.rb +3 -3
- data/lib/aws/ec2/security_group.rb +39 -41
- data/lib/aws/ec2/security_group_collection.rb +19 -21
- data/lib/aws/ec2/snapshot.rb +3 -3
- data/lib/aws/ec2/snapshot_collection.rb +11 -12
- data/lib/aws/ec2/subnet.rb +2 -2
- data/lib/aws/ec2/subnet_collection.rb +17 -17
- data/lib/aws/ec2/tag_collection.rb +1 -1
- data/lib/aws/ec2/tagged_collection.rb +7 -7
- data/lib/aws/ec2/tagged_item.rb +10 -10
- data/lib/aws/ec2/volume.rb +16 -16
- data/lib/aws/ec2/volume_collection.rb +9 -12
- data/lib/aws/ec2/vpc.rb +6 -6
- data/lib/aws/ec2/vpc_collection.rb +10 -10
- data/lib/aws/ec2/vpn_connection.rb +4 -4
- data/lib/aws/ec2/vpn_connection/telemetry.rb +1 -1
- data/lib/aws/ec2/vpn_connection_collection.rb +6 -6
- data/lib/aws/ec2/vpn_gateway.rb +2 -2
- data/lib/aws/ec2/vpn_gateway_collection.rb +5 -5
- data/lib/aws/elastic_beanstalk.rb +12 -12
- data/lib/aws/elastic_beanstalk/client.rb +376 -368
- data/lib/aws/elastic_beanstalk/config.rb +1 -1
- data/lib/aws/elastic_transcoder.rb +5 -5
- data/lib/aws/elastic_transcoder/client.rb +283 -283
- data/lib/aws/elastic_transcoder/config.rb +1 -1
- data/lib/aws/elasticache.rb +12 -12
- data/lib/aws/elasticache/client.rb +484 -479
- data/lib/aws/elasticache/config.rb +1 -1
- data/lib/aws/elb.rb +23 -23
- data/lib/aws/elb/availability_zone_collection.rb +34 -34
- data/lib/aws/elb/backend_server_policy_collection.rb +24 -24
- data/lib/aws/elb/client.rb +153 -153
- data/lib/aws/elb/config.rb +1 -1
- data/lib/aws/elb/errors.rb +1 -1
- data/lib/aws/elb/instance_collection.rb +20 -25
- data/lib/aws/elb/listener.rb +3 -3
- data/lib/aws/elb/listener_collection.rb +8 -8
- data/lib/aws/elb/load_balancer.rb +15 -16
- data/lib/aws/elb/load_balancer_collection.rb +36 -24
- data/lib/aws/elb/load_balancer_policy.rb +1 -1
- data/lib/aws/elb/load_balancer_policy_collection.rb +5 -5
- data/lib/aws/emr.rb +28 -26
- data/lib/aws/emr/client.rb +165 -149
- data/lib/aws/emr/config.rb +1 -1
- data/lib/aws/emr/instance_group.rb +1 -1
- data/lib/aws/emr/instance_group_collection.rb +1 -1
- data/lib/aws/emr/job_flow.rb +27 -26
- data/lib/aws/emr/job_flow_collection.rb +34 -34
- data/lib/aws/errors.rb +7 -7
- data/lib/aws/glacier.rb +21 -21
- data/lib/aws/glacier/archive_collection.rb +2 -2
- data/lib/aws/glacier/client.rb +139 -140
- data/lib/aws/glacier/config.rb +1 -1
- data/lib/aws/glacier/vault.rb +2 -2
- data/lib/aws/glacier/vault_collection.rb +1 -1
- data/lib/aws/iam.rb +133 -144
- data/lib/aws/iam/access_key.rb +17 -17
- data/lib/aws/iam/access_key_collection.rb +22 -22
- data/lib/aws/iam/account_alias_collection.rb +2 -2
- data/lib/aws/iam/client.rb +429 -420
- data/lib/aws/iam/collection.rb +1 -1
- data/lib/aws/iam/config.rb +2 -2
- data/lib/aws/iam/group.rb +8 -8
- data/lib/aws/iam/group_collection.rb +16 -16
- data/lib/aws/iam/group_policy_collection.rb +6 -6
- data/lib/aws/iam/group_user_collection.rb +3 -3
- data/lib/aws/iam/mfa_device.rb +1 -1
- data/lib/aws/iam/mfa_device_collection.rb +9 -9
- data/lib/aws/iam/policy_collection.rb +4 -4
- data/lib/aws/iam/resource.rb +2 -2
- data/lib/aws/iam/server_certificate.rb +1 -1
- data/lib/aws/iam/server_certificate_collection.rb +15 -15
- data/lib/aws/iam/signing_certificate.rb +29 -29
- data/lib/aws/iam/signing_certificate_collection.rb +23 -23
- data/lib/aws/iam/user.rb +33 -38
- data/lib/aws/iam/user_collection.rb +27 -27
- data/lib/aws/iam/user_group_collection.rb +3 -3
- data/lib/aws/iam/user_policy_collection.rb +6 -6
- data/lib/aws/iam/virtual_mfa_device.rb +12 -12
- data/lib/aws/iam/virtual_mfa_device_collection.rb +4 -4
- data/lib/aws/import_export.rb +22 -21
- data/lib/aws/import_export/client.rb +47 -43
- data/lib/aws/ops_works.rb +5 -5
- data/lib/aws/ops_works/client.rb +484 -438
- data/lib/aws/ops_works/config.rb +1 -1
- data/lib/aws/rails.rb +34 -34
- data/lib/aws/rds.rb +18 -18
- data/lib/aws/rds/client.rb +1286 -1277
- data/lib/aws/rds/config.rb +1 -1
- data/lib/aws/rds/db_instance.rb +15 -4
- data/lib/aws/rds/db_snapshot.rb +1 -1
- data/lib/aws/record.rb +50 -24
- data/lib/aws/record/abstract_base.rb +52 -60
- data/lib/aws/record/attributes.rb +79 -79
- data/lib/aws/record/conversion.rb +1 -1
- data/lib/aws/record/dirty_tracking.rb +69 -67
- data/lib/aws/record/errors.rb +21 -21
- data/lib/aws/record/exceptions.rb +2 -2
- data/lib/aws/record/hash_model.rb +20 -21
- data/lib/aws/record/hash_model/attributes.rb +13 -15
- data/lib/aws/record/hash_model/finder_methods.rb +46 -46
- data/lib/aws/record/hash_model/scope.rb +31 -31
- data/lib/aws/record/model.rb +136 -136
- data/lib/aws/record/model/attributes.rb +57 -59
- data/lib/aws/record/model/finder_methods.rb +67 -67
- data/lib/aws/record/model/scope.rb +48 -49
- data/lib/aws/record/naming.rb +1 -1
- data/lib/aws/record/scope.rb +23 -19
- data/lib/aws/record/validations.rb +253 -271
- data/lib/aws/record/validator.rb +3 -3
- data/lib/aws/record/validators/acceptance.rb +1 -3
- data/lib/aws/record/validators/block.rb +1 -3
- data/lib/aws/record/validators/confirmation.rb +1 -3
- data/lib/aws/record/validators/count.rb +2 -4
- data/lib/aws/record/validators/exclusion.rb +2 -4
- data/lib/aws/record/validators/format.rb +2 -4
- data/lib/aws/record/validators/inclusion.rb +1 -3
- data/lib/aws/record/validators/length.rb +5 -7
- data/lib/aws/record/validators/method.rb +1 -3
- data/lib/aws/record/validators/numericality.rb +6 -8
- data/lib/aws/record/validators/presence.rb +1 -3
- data/lib/aws/redshift.rb +14 -14
- data/lib/aws/redshift/client.rb +596 -592
- data/lib/aws/redshift/config.rb +1 -1
- data/lib/aws/route_53.rb +30 -30
- data/lib/aws/route_53/change_batch.rb +7 -7
- data/lib/aws/route_53/client.rb +188 -152
- data/lib/aws/route_53/hosted_zone.rb +4 -4
- data/lib/aws/route_53/hosted_zone_collection.rb +7 -7
- data/lib/aws/route_53/resource_record_set.rb +10 -10
- data/lib/aws/route_53/resource_record_set_collection.rb +6 -6
- data/lib/aws/s3.rb +79 -79
- data/lib/aws/s3/access_control_list.rb +44 -36
- data/lib/aws/s3/acl_options.rb +51 -51
- data/lib/aws/s3/bucket.rb +146 -146
- data/lib/aws/s3/bucket_collection.rb +21 -21
- data/lib/aws/s3/bucket_lifecycle_configuration.rb +81 -82
- data/lib/aws/s3/bucket_tag_collection.rb +4 -2
- data/lib/aws/s3/cipher_io.rb +5 -4
- data/lib/aws/s3/client.rb +89 -84
- data/lib/aws/s3/client/xml.rb +1 -1
- data/lib/aws/s3/config.rb +7 -1
- data/lib/aws/s3/cors_rule.rb +2 -0
- data/lib/aws/s3/cors_rule_collection.rb +42 -40
- data/lib/aws/s3/data_options.rb +16 -11
- data/lib/aws/s3/encryption_utils.rb +2 -2
- data/lib/aws/s3/errors.rb +7 -7
- data/lib/aws/s3/multipart_upload.rb +30 -33
- data/lib/aws/s3/multipart_upload_collection.rb +8 -6
- data/lib/aws/s3/object_collection.rb +35 -35
- data/lib/aws/s3/object_metadata.rb +6 -6
- data/lib/aws/s3/object_version.rb +4 -4
- data/lib/aws/s3/object_version_collection.rb +15 -15
- data/lib/aws/s3/policy.rb +2 -2
- data/lib/aws/s3/prefixed_collection.rb +9 -5
- data/lib/aws/s3/presigned_post.rb +39 -37
- data/lib/aws/s3/request.rb +11 -11
- data/lib/aws/s3/s3_object.rb +210 -200
- data/lib/aws/s3/tree.rb +25 -27
- data/lib/aws/s3/tree/child_collection.rb +3 -3
- data/lib/aws/s3/tree/leaf_node.rb +2 -2
- data/lib/aws/s3/tree/parent.rb +1 -1
- data/lib/aws/s3/website_configuration.rb +13 -13
- data/lib/aws/simple_db.rb +83 -83
- data/lib/aws/simple_db/attribute.rb +9 -7
- data/lib/aws/simple_db/attribute_collection.rb +22 -13
- data/lib/aws/simple_db/client.rb +107 -107
- data/lib/aws/simple_db/config.rb +7 -1
- data/lib/aws/simple_db/consistent_read_option.rb +5 -5
- data/lib/aws/simple_db/domain.rb +4 -2
- data/lib/aws/simple_db/domain_collection.rb +4 -4
- data/lib/aws/simple_db/domain_metadata.rb +5 -5
- data/lib/aws/simple_db/errors.rb +9 -9
- data/lib/aws/simple_db/item.rb +5 -5
- data/lib/aws/simple_db/item_collection.rb +83 -81
- data/lib/aws/simple_db/item_data.rb +4 -4
- data/lib/aws/simple_db/put_attributes.rb +3 -3
- data/lib/aws/simple_email_service.rb +140 -140
- data/lib/aws/simple_email_service/client.rb +82 -76
- data/lib/aws/simple_email_service/config.rb +1 -2
- data/lib/aws/simple_email_service/email_address_collection.rb +3 -3
- data/lib/aws/simple_email_service/identity.rb +8 -8
- data/lib/aws/simple_email_service/quotas.rb +8 -6
- data/lib/aws/simple_workflow.rb +106 -106
- data/lib/aws/simple_workflow/activity_task.rb +15 -22
- data/lib/aws/simple_workflow/activity_task_collection.rb +15 -15
- data/lib/aws/simple_workflow/activity_type.rb +23 -23
- data/lib/aws/simple_workflow/activity_type_collection.rb +23 -23
- data/lib/aws/simple_workflow/client.rb +1004 -956
- data/lib/aws/simple_workflow/config.rb +1 -1
- data/lib/aws/simple_workflow/count.rb +5 -5
- data/lib/aws/simple_workflow/decision_task.rb +129 -129
- data/lib/aws/simple_workflow/decision_task_collection.rb +59 -59
- data/lib/aws/simple_workflow/domain.rb +11 -11
- data/lib/aws/simple_workflow/domain_collection.rb +26 -26
- data/lib/aws/simple_workflow/history_event.rb +32 -32
- data/lib/aws/simple_workflow/history_event_collection.rb +3 -3
- data/lib/aws/simple_workflow/option_formatters.rb +5 -5
- data/lib/aws/simple_workflow/request.rb +1 -1
- data/lib/aws/simple_workflow/resource.rb +1 -1
- data/lib/aws/simple_workflow/type.rb +8 -8
- data/lib/aws/simple_workflow/type_collection.rb +15 -15
- data/lib/aws/simple_workflow/workflow_execution.rb +70 -72
- data/lib/aws/simple_workflow/workflow_execution_collection.rb +130 -130
- data/lib/aws/simple_workflow/workflow_type.rb +27 -25
- data/lib/aws/simple_workflow/workflow_type_collection.rb +20 -20
- data/lib/aws/sns.rb +25 -25
- data/lib/aws/sns/client.rb +55 -55
- data/lib/aws/sns/config.rb +1 -1
- data/lib/aws/sns/policy.rb +1 -1
- data/lib/aws/sns/subscription.rb +7 -7
- data/lib/aws/sns/subscription_collection.rb +5 -5
- data/lib/aws/sns/topic.rb +49 -49
- data/lib/aws/sns/topic_collection.rb +2 -2
- data/lib/aws/sns/topic_subscription_collection.rb +5 -5
- data/lib/aws/sqs.rb +20 -20
- data/lib/aws/sqs/client.rb +78 -78
- data/lib/aws/sqs/config.rb +1 -1
- data/lib/aws/sqs/errors.rb +12 -12
- data/lib/aws/sqs/queue.rb +66 -67
- data/lib/aws/sqs/queue_collection.rb +16 -8
- data/lib/aws/sqs/received_message.rb +7 -6
- data/lib/aws/storage_gateway.rb +21 -21
- data/lib/aws/storage_gateway/client.rb +269 -202
- data/lib/aws/storage_gateway/config.rb +1 -1
- data/lib/aws/sts.rb +10 -8
- data/lib/aws/sts/client.rb +35 -35
- data/lib/aws/sts/session.rb +3 -3
- data/lib/aws/version.rb +1 -2
- metadata +23 -21
- data/lib/aws/core/autoloader.rb +0 -64
- data/lib/net/http/connection_pool.rb +0 -226
- data/lib/net/http/connection_pool/connection.rb +0 -189
- data/lib/net/http/connection_pool/session.rb +0 -126
data/lib/aws/cloud_watch.rb
CHANGED
|
@@ -19,41 +19,41 @@ module AWS
|
|
|
19
19
|
# This class is the starting point for working with Amazon CloudWatch.
|
|
20
20
|
#
|
|
21
21
|
# To use Amazon CloudWatch you must first
|
|
22
|
-
#
|
|
22
|
+
# [sign up here](http://aws.amazon.com/cloudwatch/).
|
|
23
23
|
#
|
|
24
24
|
# For more information about Amazon CloudWatch:
|
|
25
25
|
#
|
|
26
|
-
# *
|
|
27
|
-
# *
|
|
26
|
+
# * [Amazon CloudWatch](http://aws.amazon.com/cloudwatch/)
|
|
27
|
+
# * [Amazon CloudWatch Documentation](http://aws.amazon.com/documentation/cloudwatch/)
|
|
28
28
|
#
|
|
29
|
-
#
|
|
29
|
+
# # Credentials
|
|
30
30
|
#
|
|
31
31
|
# You can setup default credentials for all AWS services via
|
|
32
32
|
# AWS.config:
|
|
33
33
|
#
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
#
|
|
34
|
+
# AWS.config(
|
|
35
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
|
36
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
|
37
37
|
#
|
|
38
38
|
# Or you can set them directly on the AWS::Route53 interface:
|
|
39
39
|
#
|
|
40
|
-
#
|
|
41
|
-
#
|
|
42
|
-
#
|
|
40
|
+
# cw = AWS::CloudWatch.new(
|
|
41
|
+
# :access_key_id => 'YOUR_ACCESS_KEY_ID',
|
|
42
|
+
# :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
|
|
43
43
|
#
|
|
44
|
-
#
|
|
44
|
+
# # Using the Client
|
|
45
45
|
#
|
|
46
46
|
# AWS::CloudWatch does not provide higher level abstractions for CloudWatch at
|
|
47
47
|
# this time. You can still access all of the API methods using
|
|
48
48
|
# {AWS::CloudWatch::Client}. Here is how you access the client and make
|
|
49
49
|
# a simple request:
|
|
50
50
|
#
|
|
51
|
-
#
|
|
51
|
+
# cw = AWS::CloudWatch.new
|
|
52
52
|
#
|
|
53
|
-
#
|
|
54
|
-
#
|
|
55
|
-
#
|
|
56
|
-
#
|
|
53
|
+
# resp = cw.client.describe_alarms
|
|
54
|
+
# resp[:metric_alarms].each do |alarm|
|
|
55
|
+
# puts alarm[:alarm_name]
|
|
56
|
+
# end
|
|
57
57
|
#
|
|
58
58
|
# See {Client} for documentation on all of the supported operations.
|
|
59
59
|
#
|
|
@@ -61,35 +61,35 @@ module AWS
|
|
|
61
61
|
# @return [Client] the low-level CloudWatch client object
|
|
62
62
|
class CloudWatch
|
|
63
63
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
autoload :Request, 'request'
|
|
76
|
-
end
|
|
64
|
+
autoload :Alarm, 'aws/cloud_watch/alarm'
|
|
65
|
+
autoload :AlarmCollection, 'aws/cloud_watch/alarm_collection'
|
|
66
|
+
autoload :AlarmHistoryItem, 'aws/cloud_watch/alarm_history_item'
|
|
67
|
+
autoload :AlarmHistoryItemCollection, 'aws/cloud_watch/alarm_history_item_collection'
|
|
68
|
+
autoload :Client, 'aws/cloud_watch/client'
|
|
69
|
+
autoload :Errors, 'aws/cloud_watch/errors'
|
|
70
|
+
autoload :Metric, 'aws/cloud_watch/metric'
|
|
71
|
+
autoload :MetricCollection, 'aws/cloud_watch/metric_collection'
|
|
72
|
+
autoload :MetricAlarmCollection, 'aws/cloud_watch/metric_alarm_collection'
|
|
73
|
+
autoload :MetricStatistics, 'aws/cloud_watch/metric_statistics'
|
|
74
|
+
autoload :Request, 'aws/cloud_watch/request'
|
|
77
75
|
|
|
78
76
|
include Core::ServiceInterface
|
|
79
77
|
|
|
78
|
+
endpoint_prefix 'monitoring'
|
|
79
|
+
|
|
80
80
|
# Puts data for a metric. The metric is created if it does not already
|
|
81
81
|
# exist.
|
|
82
82
|
#
|
|
83
|
-
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
#
|
|
87
|
-
#
|
|
88
|
-
#
|
|
89
|
-
#
|
|
90
|
-
#
|
|
91
|
-
#
|
|
92
|
-
#
|
|
83
|
+
# cw.put_metric_data(
|
|
84
|
+
# :namespace => 'test/cli',
|
|
85
|
+
# :metric_data => [
|
|
86
|
+
# { :metric_name => 'sample', :value => 1 },
|
|
87
|
+
# { :metric_name => 'sample', :value => 2 },
|
|
88
|
+
# { :metric_name => 'sample', :value => 3 },
|
|
89
|
+
# { :metric_name => 'sample', :value => 4 },
|
|
90
|
+
# { :metric_name => 'sample', :value => 5 },
|
|
91
|
+
# ]
|
|
92
|
+
# )
|
|
93
93
|
#
|
|
94
94
|
# @param [Hash] options
|
|
95
95
|
# @see Client#put_metric_data
|
|
@@ -20,11 +20,11 @@ module AWS
|
|
|
20
20
|
#
|
|
21
21
|
# @attr_reader [Array<Hash>] dimensions
|
|
22
22
|
#
|
|
23
|
-
# @attr_reader [Boolean] enabled Indicates whether actions
|
|
23
|
+
# @attr_reader [Boolean] enabled Indicates whether actions
|
|
24
24
|
# should be executed during any changes to the alarm's state.
|
|
25
25
|
#
|
|
26
|
-
# @attr_reader [Array<String>] alarm_actions The list of actions to execute
|
|
27
|
-
# when this alarm transitions into an ALARM state from any other
|
|
26
|
+
# @attr_reader [Array<String>] alarm_actions The list of actions to execute
|
|
27
|
+
# when this alarm transitions into an ALARM state from any other
|
|
28
28
|
# state.
|
|
29
29
|
#
|
|
30
30
|
# @attr_reader [String] arn The Amazon Resource Name (ARN) of the alarm.
|
|
@@ -34,11 +34,11 @@ module AWS
|
|
|
34
34
|
#
|
|
35
35
|
# @attr_reader [String] description The description for the alarm.
|
|
36
36
|
#
|
|
37
|
-
# @attr_reader [String] comparison_operator The arithmetic operation to
|
|
38
|
-
# use when comparing the specified Statistic and Threshold. The
|
|
37
|
+
# @attr_reader [String] comparison_operator The arithmetic operation to
|
|
38
|
+
# use when comparing the specified Statistic and Threshold. The
|
|
39
39
|
# specified Statistic value is used as the first operand.
|
|
40
40
|
#
|
|
41
|
-
# @attr_reader [Integer] evaluation_periods The number of periods over
|
|
41
|
+
# @attr_reader [Integer] evaluation_periods The number of periods over
|
|
42
42
|
# which data is compared to the specified threshold.
|
|
43
43
|
#
|
|
44
44
|
# @attr_reader [Array<Hash>] insufficient_data_actions The list of
|
|
@@ -48,7 +48,7 @@ module AWS
|
|
|
48
48
|
# @attr_reader [Array<Hash>] ok_actions The list of actions to execute
|
|
49
49
|
# when this alarm transitions into an OK state.
|
|
50
50
|
#
|
|
51
|
-
# @attr_reader [Integer] period The period in seconds over which the
|
|
51
|
+
# @attr_reader [Integer] period The period in seconds over which the
|
|
52
52
|
# statistic is applied.
|
|
53
53
|
#
|
|
54
54
|
# @attr_reader [String] state_reason A human-readable explanation for
|
|
@@ -102,7 +102,7 @@ module AWS
|
|
|
102
102
|
|
|
103
103
|
attribute :alarm_configuration_updated_timestamp
|
|
104
104
|
|
|
105
|
-
alias_method :configuration_updated_timestamp,
|
|
105
|
+
alias_method :configuration_updated_timestamp,
|
|
106
106
|
:alarm_configuration_updated_timestamp
|
|
107
107
|
|
|
108
108
|
attribute :alarm_description
|
|
@@ -152,50 +152,63 @@ module AWS
|
|
|
152
152
|
# Updates the metric alarm.
|
|
153
153
|
#
|
|
154
154
|
# @option options [String,required] :comparison_operator The arithmetic
|
|
155
|
-
# operation to use when comparing the specified Statistic and
|
|
156
|
-
# Threshold. The specified Statistic value is used as the first
|
|
155
|
+
# operation to use when comparing the specified Statistic and
|
|
156
|
+
# Threshold. The specified Statistic value is used as the first
|
|
157
157
|
# operand. Valid values include:
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
#
|
|
161
|
-
#
|
|
162
|
-
#
|
|
158
|
+
#
|
|
159
|
+
# * 'GreaterThanOrEqualToThreshold'
|
|
160
|
+
# * 'GreaterThanThreshold'
|
|
161
|
+
# * 'LessThanThreshold'
|
|
162
|
+
# * 'LessThanOrEqualToThreshold'
|
|
163
|
+
#
|
|
164
|
+
# @option options [Integer,required] :evaluation_periods The number
|
|
163
165
|
# of periods over which data is compared to the specified threshold.
|
|
164
|
-
#
|
|
166
|
+
#
|
|
167
|
+
# @option options [Integer,required] :period The period in seconds
|
|
165
168
|
# over which the specified statistic is applied.
|
|
166
|
-
#
|
|
169
|
+
#
|
|
170
|
+
# @option options [String,required] :statistic The statistic to apply
|
|
167
171
|
# to the alarm's associated metric. Valid values include:
|
|
168
|
-
#
|
|
169
|
-
#
|
|
170
|
-
#
|
|
171
|
-
#
|
|
172
|
-
#
|
|
172
|
+
#
|
|
173
|
+
# * 'SampleCount'
|
|
174
|
+
# * 'Average'
|
|
175
|
+
# * 'Sum'
|
|
176
|
+
# * 'Minimum'
|
|
177
|
+
# * 'Maximum'
|
|
178
|
+
#
|
|
173
179
|
# @option options [Number,required] :threshold The value against which
|
|
174
180
|
# the specified statistic is compared.
|
|
181
|
+
#
|
|
175
182
|
# @option options [Array<String>] :insufficient_data_actions
|
|
176
|
-
# The list of actions to execute when this alarm transitions into an
|
|
177
|
-
# INSUFFICIENT_DATA state from any other state. Each action is
|
|
178
|
-
# specified as an Amazon Resource Number (ARN). Currently the only
|
|
179
|
-
# action supported is publishing to an Amazon SNS topic or an
|
|
183
|
+
# The list of actions to execute when this alarm transitions into an
|
|
184
|
+
# INSUFFICIENT_DATA state from any other state. Each action is
|
|
185
|
+
# specified as an Amazon Resource Number (ARN). Currently the only
|
|
186
|
+
# action supported is publishing to an Amazon SNS topic or an
|
|
180
187
|
# Amazon Auto Scaling policy.
|
|
188
|
+
#
|
|
181
189
|
# @option options [Array<String>] :ok_actions The list of actions to
|
|
182
190
|
# execute when this alarm transitions into an OK state from any
|
|
183
191
|
# other state. Each action is specified as an Amazon Resource
|
|
184
192
|
# Number (ARN). Currently the only action supported is publishing to
|
|
185
193
|
# an Amazon SNS topic or an Amazon Auto Scaling policy.
|
|
186
|
-
#
|
|
187
|
-
#
|
|
194
|
+
#
|
|
195
|
+
# @option options [Boolean] :actions_enabled Indicates whether or not
|
|
196
|
+
# actions should be executed during any changes to the alarm's
|
|
188
197
|
# state.
|
|
189
|
-
#
|
|
190
|
-
#
|
|
191
|
-
#
|
|
192
|
-
#
|
|
198
|
+
#
|
|
199
|
+
# @option options [Array<String>] :alarm_actions The list of actions
|
|
200
|
+
# to execute when this alarm transitions into an ALARM state from
|
|
201
|
+
# any other state. Each action is specified as an Amazon Resource
|
|
202
|
+
# Number (ARN). Currently the only action supported is publishing
|
|
193
203
|
# to an Amazon SNS topic or an Amazon Auto Scaling policy.
|
|
194
204
|
# Maximum of 5 alarm actions.
|
|
195
|
-
#
|
|
205
|
+
#
|
|
206
|
+
# @option options [String] :alarm_description The description for
|
|
196
207
|
# the alarm.
|
|
197
|
-
#
|
|
208
|
+
#
|
|
209
|
+
# @option options [String] :unit The unit for the alarm's associated
|
|
198
210
|
# metric.
|
|
211
|
+
#
|
|
199
212
|
# @return [nil]
|
|
200
213
|
def update options = {}
|
|
201
214
|
options[:alarm_name] = alarm_name
|
|
@@ -238,16 +251,21 @@ module AWS
|
|
|
238
251
|
alias_method :histories, :history_items
|
|
239
252
|
|
|
240
253
|
# Temporarily sets the state of current alarm.
|
|
241
|
-
# @param [String] reason The reason that this alarm is set to this
|
|
254
|
+
# @param [String] reason The reason that this alarm is set to this
|
|
242
255
|
# specific state (in human-readable text format).
|
|
256
|
+
#
|
|
243
257
|
# @param [String] value Valid values include:
|
|
258
|
+
#
|
|
244
259
|
# * 'OK'
|
|
245
260
|
# * 'ALARM'
|
|
246
261
|
# * 'INSUFFICIENT_DATA'
|
|
262
|
+
#
|
|
247
263
|
# @param [Hash] options
|
|
248
|
-
# @option options [String] :state_reason_data The reason that this
|
|
249
|
-
#
|
|
264
|
+
# @option options [String] :state_reason_data The reason that this
|
|
265
|
+
#
|
|
266
|
+
# alarm is set to this specific state (in machine-readable JSON
|
|
250
267
|
# format)
|
|
268
|
+
#
|
|
251
269
|
# @return [nil]
|
|
252
270
|
def set_state reason, value, options = {}
|
|
253
271
|
options[:alarm_name] = alarm_name
|
|
@@ -14,33 +14,33 @@
|
|
|
14
14
|
module AWS
|
|
15
15
|
class CloudWatch
|
|
16
16
|
|
|
17
|
-
#
|
|
18
|
-
#
|
|
17
|
+
# # AlarmCollection
|
|
18
|
+
#
|
|
19
19
|
# Represents alarms for an AWS account.
|
|
20
20
|
#
|
|
21
|
-
#
|
|
21
|
+
# ## Getting an alarm by name
|
|
22
22
|
#
|
|
23
23
|
# If you know the name of the alarm, you can get a reference using
|
|
24
24
|
# the {#[]} method.
|
|
25
25
|
#
|
|
26
|
-
#
|
|
27
|
-
#
|
|
26
|
+
# cw = AWS::CloudWatch.new
|
|
27
|
+
# alarm = cw.alarms['alarm-name']
|
|
28
28
|
#
|
|
29
|
-
#
|
|
29
|
+
# ## Enumerating Alarms
|
|
30
30
|
#
|
|
31
31
|
# You can enumerate all alarms using each (or any of the
|
|
32
32
|
# methods defined in {Core::Collection}).
|
|
33
33
|
#
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
#
|
|
34
|
+
# cw.alarms.each do |alarm|
|
|
35
|
+
# puts alarm.name
|
|
36
|
+
# end
|
|
37
37
|
#
|
|
38
|
-
#
|
|
38
|
+
# ## Filtering Alarms
|
|
39
39
|
#
|
|
40
40
|
# Use one of the filtering methods to reduce the number of alarms
|
|
41
41
|
# returned.
|
|
42
42
|
#
|
|
43
|
-
#
|
|
43
|
+
# cw.alarms.with_name_prefix('some-prefix-').each {|alarm| ... }
|
|
44
44
|
#
|
|
45
45
|
class AlarmCollection
|
|
46
46
|
|
|
@@ -59,16 +59,16 @@ module AWS
|
|
|
59
59
|
|
|
60
60
|
# Creates an alarm and associates it with the specified metric.
|
|
61
61
|
#
|
|
62
|
-
# @param [String] alarm_name The descriptive name for the alarm.
|
|
62
|
+
# @param [String] alarm_name The descriptive name for the alarm.
|
|
63
63
|
# This name must be unique within the user's AWS account.
|
|
64
64
|
# @param [Hash] options
|
|
65
|
-
# @option options [String,required] :namespace The namespace for the
|
|
65
|
+
# @option options [String,required] :namespace The namespace for the
|
|
66
66
|
# alarm's associated metric.
|
|
67
|
-
# @option options [String,required] :metric_name The name for the
|
|
67
|
+
# @option options [String,required] :metric_name The name for the
|
|
68
68
|
# alarm's associated metric.
|
|
69
|
-
# @option options [Array<Hash>] :dimensions The dimensions for the
|
|
69
|
+
# @option options [Array<Hash>] :dimensions The dimensions for the
|
|
70
70
|
# alarm's associated metric. Each dimension must specify a
|
|
71
|
-
#
|
|
71
|
+
# `:name` and a `:value`.
|
|
72
72
|
# @option (see Alarm#update)
|
|
73
73
|
# @return [Alarm]
|
|
74
74
|
def create alarm_name, options = {}
|
|
@@ -79,7 +79,7 @@ module AWS
|
|
|
79
79
|
|
|
80
80
|
# Delete one or more alarms by name.
|
|
81
81
|
#
|
|
82
|
-
#
|
|
82
|
+
# cloud_watch.alarms.delete('alarm1', 'alarm2')
|
|
83
83
|
#
|
|
84
84
|
# @param [String,Array<String>] alarm_names
|
|
85
85
|
# @return [nil]
|
|
@@ -136,7 +136,7 @@ module AWS
|
|
|
136
136
|
|
|
137
137
|
alarm = Alarm.new_from(
|
|
138
138
|
:describe_alarms,
|
|
139
|
-
details,
|
|
139
|
+
details,
|
|
140
140
|
details[:alarm_name],
|
|
141
141
|
:config => config)
|
|
142
142
|
|
|
@@ -63,14 +63,14 @@ module AWS
|
|
|
63
63
|
protected
|
|
64
64
|
|
|
65
65
|
def _each_item next_token, limit, options = {}, &block
|
|
66
|
-
|
|
66
|
+
|
|
67
67
|
options = @filters.merge(options)
|
|
68
68
|
options[:max_records] = limit if limit
|
|
69
69
|
options[:next_token] = next_token if next_token
|
|
70
70
|
|
|
71
71
|
resp = client.describe_alarm_history(options)
|
|
72
72
|
resp.data[:alarm_history_items].each do |details|
|
|
73
|
-
|
|
73
|
+
|
|
74
74
|
yield(AlarmHistoryItem.new(details))
|
|
75
75
|
|
|
76
76
|
end
|
|
@@ -30,212 +30,426 @@ module AWS
|
|
|
30
30
|
# @!method delete_alarms(options = {})
|
|
31
31
|
# Calls the DeleteAlarms API operation.
|
|
32
32
|
# @param [Hash] options
|
|
33
|
-
# *
|
|
33
|
+
# * `:alarm_names` - *required* - (Array<String>) A list of alarms to
|
|
34
|
+
# be deleted.
|
|
34
35
|
# @return [Core::Response]
|
|
35
36
|
|
|
36
37
|
# @!method describe_alarm_history(options = {})
|
|
37
38
|
# Calls the DescribeAlarmHistory API operation.
|
|
38
39
|
# @param [Hash] options
|
|
39
|
-
# *
|
|
40
|
-
# *
|
|
41
|
-
#
|
|
42
|
-
#
|
|
43
|
-
#
|
|
44
|
-
#
|
|
40
|
+
# * `:alarm_name` - (String) The name of the alarm.
|
|
41
|
+
# * `:history_item_type` - (String) The type of alarm histories to
|
|
42
|
+
# retrieve. Valid values include:
|
|
43
|
+
# * `ConfigurationUpdate`
|
|
44
|
+
# * `StateUpdate`
|
|
45
|
+
# * `Action`
|
|
46
|
+
# * `:start_date` - (String<ISO8601 datetime>) The starting date to
|
|
47
|
+
# retrieve alarm history.
|
|
48
|
+
# * `:end_date` - (String<ISO8601 datetime>) The ending date to
|
|
49
|
+
# retrieve alarm history.
|
|
50
|
+
# * `:max_records` - (Integer) The maximum number of alarm history
|
|
51
|
+
# records to retrieve.
|
|
52
|
+
# * `:next_token` - (String) The token returned by a previous call to
|
|
53
|
+
# indicate that there is more data available.
|
|
45
54
|
# @return [Core::Response]
|
|
46
55
|
# The #data method of the response object returns
|
|
47
56
|
# a hash with the following structure:
|
|
48
|
-
# *
|
|
49
|
-
# *
|
|
50
|
-
# *
|
|
51
|
-
# *
|
|
52
|
-
# *
|
|
53
|
-
# *
|
|
54
|
-
# *
|
|
57
|
+
# * `:alarm_history_items` - (Array<Hash>)
|
|
58
|
+
# * `:alarm_name` - (String)
|
|
59
|
+
# * `:timestamp` - (Time)
|
|
60
|
+
# * `:history_item_type` - (String)
|
|
61
|
+
# * `:history_summary` - (String)
|
|
62
|
+
# * `:history_data` - (String)
|
|
63
|
+
# * `:next_token` - (String)
|
|
55
64
|
|
|
56
65
|
# @!method describe_alarms(options = {})
|
|
57
66
|
# Calls the DescribeAlarms API operation.
|
|
58
67
|
# @param [Hash] options
|
|
59
|
-
# *
|
|
60
|
-
#
|
|
61
|
-
# *
|
|
62
|
-
#
|
|
63
|
-
# *
|
|
64
|
-
#
|
|
68
|
+
# * `:alarm_names` - (Array<String>) A list of alarm names to retrieve
|
|
69
|
+
# information for.
|
|
70
|
+
# * `:alarm_name_prefix` - (String) The alarm name prefix. AlarmNames
|
|
71
|
+
# cannot be specified if this parameter is specified.
|
|
72
|
+
# * `:state_value` - (String) The state value to be used in matching
|
|
73
|
+
# alarms. Valid values include:
|
|
74
|
+
# * `OK`
|
|
75
|
+
# * `ALARM`
|
|
76
|
+
# * `INSUFFICIENT_DATA`
|
|
77
|
+
# * `:action_prefix` - (String) The action name prefix.
|
|
78
|
+
# * `:max_records` - (Integer) The maximum number of alarm descriptions
|
|
79
|
+
# to retrieve.
|
|
80
|
+
# * `:next_token` - (String) The token returned by a previous call to
|
|
81
|
+
# indicate that there is more data available.
|
|
65
82
|
# @return [Core::Response]
|
|
66
83
|
# The #data method of the response object returns
|
|
67
84
|
# a hash with the following structure:
|
|
68
|
-
# *
|
|
69
|
-
# *
|
|
70
|
-
# *
|
|
71
|
-
# *
|
|
72
|
-
# *
|
|
73
|
-
# *
|
|
74
|
-
# *
|
|
75
|
-
# *
|
|
76
|
-
# *
|
|
77
|
-
# *
|
|
78
|
-
# *
|
|
79
|
-
# *
|
|
80
|
-
# *
|
|
81
|
-
# *
|
|
82
|
-
# *
|
|
83
|
-
# *
|
|
84
|
-
# *
|
|
85
|
-
# *
|
|
86
|
-
# *
|
|
87
|
-
# *
|
|
88
|
-
# *
|
|
89
|
-
# *
|
|
90
|
-
# *
|
|
91
|
-
# *
|
|
92
|
-
# *
|
|
85
|
+
# * `:metric_alarms` - (Array<Hash>)
|
|
86
|
+
# * `:alarm_name` - (String)
|
|
87
|
+
# * `:alarm_arn` - (String)
|
|
88
|
+
# * `:alarm_description` - (String)
|
|
89
|
+
# * `:alarm_configuration_updated_timestamp` - (Time)
|
|
90
|
+
# * `:actions_enabled` - (Boolean)
|
|
91
|
+
# * `:ok_actions` - (Array<String>)
|
|
92
|
+
# * `:alarm_actions` - (Array<String>)
|
|
93
|
+
# * `:insufficient_data_actions` - (Array<String>)
|
|
94
|
+
# * `:state_value` - (String)
|
|
95
|
+
# * `:state_reason` - (String)
|
|
96
|
+
# * `:state_reason_data` - (String)
|
|
97
|
+
# * `:state_updated_timestamp` - (Time)
|
|
98
|
+
# * `:metric_name` - (String)
|
|
99
|
+
# * `:namespace` - (String)
|
|
100
|
+
# * `:statistic` - (String)
|
|
101
|
+
# * `:dimensions` - (Array<Hash>)
|
|
102
|
+
# * `:name` - (String)
|
|
103
|
+
# * `:value` - (String)
|
|
104
|
+
# * `:period` - (Integer)
|
|
105
|
+
# * `:unit` - (String)
|
|
106
|
+
# * `:evaluation_periods` - (Integer)
|
|
107
|
+
# * `:threshold` - (Numeric)
|
|
108
|
+
# * `:comparison_operator` - (String)
|
|
109
|
+
# * `:next_token` - (String)
|
|
93
110
|
|
|
94
111
|
# @!method describe_alarms_for_metric(options = {})
|
|
95
112
|
# Calls the DescribeAlarmsForMetric API operation.
|
|
96
113
|
# @param [Hash] options
|
|
97
|
-
# *
|
|
98
|
-
# *
|
|
99
|
-
# *
|
|
100
|
-
#
|
|
101
|
-
# *
|
|
102
|
-
# *
|
|
103
|
-
#
|
|
104
|
-
#
|
|
114
|
+
# * `:metric_name` - *required* - (String) The name of the metric.
|
|
115
|
+
# * `:namespace` - *required* - (String) The namespace of the metric.
|
|
116
|
+
# * `:statistic` - (String) The statistic for the metric. Valid values
|
|
117
|
+
# include:
|
|
118
|
+
# * `SampleCount`
|
|
119
|
+
# * `Average`
|
|
120
|
+
# * `Sum`
|
|
121
|
+
# * `Minimum`
|
|
122
|
+
# * `Maximum`
|
|
123
|
+
# * `:dimensions` - (Array<Hash>) The list of dimensions associated
|
|
124
|
+
# with the metric.
|
|
125
|
+
# * `:name` - *required* - (String) The name of the dimension.
|
|
126
|
+
# * `:value` - *required* - (String) The value representing the
|
|
127
|
+
# dimension measurement
|
|
128
|
+
# * `:period` - (Integer) The period in seconds over which the
|
|
129
|
+
# statistic is applied.
|
|
130
|
+
# * `:unit` - (String) The unit for the metric. Valid values include:
|
|
131
|
+
# * `Seconds`
|
|
132
|
+
# * `Microseconds`
|
|
133
|
+
# * `Milliseconds`
|
|
134
|
+
# * `Bytes`
|
|
135
|
+
# * `Kilobytes`
|
|
136
|
+
# * `Megabytes`
|
|
137
|
+
# * `Gigabytes`
|
|
138
|
+
# * `Terabytes`
|
|
139
|
+
# * `Bits`
|
|
140
|
+
# * `Kilobits`
|
|
141
|
+
# * `Megabits`
|
|
142
|
+
# * `Gigabits`
|
|
143
|
+
# * `Terabits`
|
|
144
|
+
# * `Percent`
|
|
145
|
+
# * `Count`
|
|
146
|
+
# * `Bytes/Second`
|
|
147
|
+
# * `Kilobytes/Second`
|
|
148
|
+
# * `Megabytes/Second`
|
|
149
|
+
# * `Gigabytes/Second`
|
|
150
|
+
# * `Terabytes/Second`
|
|
151
|
+
# * `Bits/Second`
|
|
152
|
+
# * `Kilobits/Second`
|
|
153
|
+
# * `Megabits/Second`
|
|
154
|
+
# * `Gigabits/Second`
|
|
155
|
+
# * `Terabits/Second`
|
|
156
|
+
# * `Count/Second`
|
|
157
|
+
# * `None`
|
|
105
158
|
# @return [Core::Response]
|
|
106
159
|
# The #data method of the response object returns
|
|
107
160
|
# a hash with the following structure:
|
|
108
|
-
# *
|
|
109
|
-
# *
|
|
110
|
-
# *
|
|
111
|
-
# *
|
|
112
|
-
# *
|
|
113
|
-
# *
|
|
114
|
-
# *
|
|
115
|
-
# *
|
|
116
|
-
# *
|
|
117
|
-
# *
|
|
118
|
-
# *
|
|
119
|
-
# *
|
|
120
|
-
# *
|
|
121
|
-
# *
|
|
122
|
-
# *
|
|
123
|
-
# *
|
|
124
|
-
# *
|
|
125
|
-
# *
|
|
126
|
-
# *
|
|
127
|
-
# *
|
|
128
|
-
# *
|
|
129
|
-
# *
|
|
130
|
-
# *
|
|
131
|
-
# *
|
|
161
|
+
# * `:metric_alarms` - (Array<Hash>)
|
|
162
|
+
# * `:alarm_name` - (String)
|
|
163
|
+
# * `:alarm_arn` - (String)
|
|
164
|
+
# * `:alarm_description` - (String)
|
|
165
|
+
# * `:alarm_configuration_updated_timestamp` - (Time)
|
|
166
|
+
# * `:actions_enabled` - (Boolean)
|
|
167
|
+
# * `:ok_actions` - (Array<String>)
|
|
168
|
+
# * `:alarm_actions` - (Array<String>)
|
|
169
|
+
# * `:insufficient_data_actions` - (Array<String>)
|
|
170
|
+
# * `:state_value` - (String)
|
|
171
|
+
# * `:state_reason` - (String)
|
|
172
|
+
# * `:state_reason_data` - (String)
|
|
173
|
+
# * `:state_updated_timestamp` - (Time)
|
|
174
|
+
# * `:metric_name` - (String)
|
|
175
|
+
# * `:namespace` - (String)
|
|
176
|
+
# * `:statistic` - (String)
|
|
177
|
+
# * `:dimensions` - (Array<Hash>)
|
|
178
|
+
# * `:name` - (String)
|
|
179
|
+
# * `:value` - (String)
|
|
180
|
+
# * `:period` - (Integer)
|
|
181
|
+
# * `:unit` - (String)
|
|
182
|
+
# * `:evaluation_periods` - (Integer)
|
|
183
|
+
# * `:threshold` - (Numeric)
|
|
184
|
+
# * `:comparison_operator` - (String)
|
|
132
185
|
|
|
133
186
|
# @!method disable_alarm_actions(options = {})
|
|
134
187
|
# Calls the DisableAlarmActions API operation.
|
|
135
188
|
# @param [Hash] options
|
|
136
|
-
# *
|
|
189
|
+
# * `:alarm_names` - *required* - (Array<String>) The names of the
|
|
190
|
+
# alarms to disable actions for.
|
|
137
191
|
# @return [Core::Response]
|
|
138
192
|
|
|
139
193
|
# @!method enable_alarm_actions(options = {})
|
|
140
194
|
# Calls the EnableAlarmActions API operation.
|
|
141
195
|
# @param [Hash] options
|
|
142
|
-
# *
|
|
196
|
+
# * `:alarm_names` - *required* - (Array<String>) The names of the
|
|
197
|
+
# alarms to enable actions for.
|
|
143
198
|
# @return [Core::Response]
|
|
144
199
|
|
|
145
200
|
# @!method get_metric_statistics(options = {})
|
|
146
201
|
# Calls the GetMetricStatistics API operation.
|
|
147
202
|
# @param [Hash] options
|
|
148
|
-
# *
|
|
149
|
-
# *
|
|
150
|
-
# *
|
|
151
|
-
#
|
|
152
|
-
# *
|
|
153
|
-
#
|
|
154
|
-
#
|
|
155
|
-
# *
|
|
156
|
-
#
|
|
157
|
-
#
|
|
203
|
+
# * `:namespace` - *required* - (String) The namespace of the metric.
|
|
204
|
+
# * `:metric_name` - *required* - (String) The name of the metric.
|
|
205
|
+
# * `:dimensions` - (Array<Hash>) A list of dimensions describing
|
|
206
|
+
# qualities of the metric.
|
|
207
|
+
# * `:name` - *required* - (String) The name of the dimension.
|
|
208
|
+
# * `:value` - *required* - (String) The value representing the
|
|
209
|
+
# dimension measurement
|
|
210
|
+
# * `:start_time` - *required* - (String<ISO8601 datetime>) The time
|
|
211
|
+
# stamp to use for determining the first datapoint to return. The
|
|
212
|
+
# value specified is inclusive; results include datapoints with the
|
|
213
|
+
# time stamp specified. The specified start time is rounded down to
|
|
214
|
+
# the nearest value. Datapoints are returned for start times up to
|
|
215
|
+
# two weeks in the past. Specified start times that are more than two
|
|
216
|
+
# weeks in the past will not return datapoints for metrics that are
|
|
217
|
+
# older than two weeks.
|
|
218
|
+
# * `:end_time` - *required* - (String<ISO8601 datetime>) The time
|
|
219
|
+
# stamp to use for determining the last datapoint to return. The
|
|
220
|
+
# value specified is exclusive; results will include datapoints up to
|
|
221
|
+
# the time stamp specified.
|
|
222
|
+
# * `:period` - *required* - (Integer) The granularity, in seconds, of
|
|
223
|
+
# the returned datapoints. Period must be at least 60 seconds and
|
|
224
|
+
# must be a multiple of 60. The default value is 60.
|
|
225
|
+
# * `:statistics` - *required* - (Array<String>) The metric statistics
|
|
226
|
+
# to return.
|
|
227
|
+
# * `:unit` - (String) The unit for the metric. Valid values include:
|
|
228
|
+
# * `Seconds`
|
|
229
|
+
# * `Microseconds`
|
|
230
|
+
# * `Milliseconds`
|
|
231
|
+
# * `Bytes`
|
|
232
|
+
# * `Kilobytes`
|
|
233
|
+
# * `Megabytes`
|
|
234
|
+
# * `Gigabytes`
|
|
235
|
+
# * `Terabytes`
|
|
236
|
+
# * `Bits`
|
|
237
|
+
# * `Kilobits`
|
|
238
|
+
# * `Megabits`
|
|
239
|
+
# * `Gigabits`
|
|
240
|
+
# * `Terabits`
|
|
241
|
+
# * `Percent`
|
|
242
|
+
# * `Count`
|
|
243
|
+
# * `Bytes/Second`
|
|
244
|
+
# * `Kilobytes/Second`
|
|
245
|
+
# * `Megabytes/Second`
|
|
246
|
+
# * `Gigabytes/Second`
|
|
247
|
+
# * `Terabytes/Second`
|
|
248
|
+
# * `Bits/Second`
|
|
249
|
+
# * `Kilobits/Second`
|
|
250
|
+
# * `Megabits/Second`
|
|
251
|
+
# * `Gigabits/Second`
|
|
252
|
+
# * `Terabits/Second`
|
|
253
|
+
# * `Count/Second`
|
|
254
|
+
# * `None`
|
|
158
255
|
# @return [Core::Response]
|
|
159
256
|
# The #data method of the response object returns
|
|
160
257
|
# a hash with the following structure:
|
|
161
|
-
# *
|
|
162
|
-
# *
|
|
163
|
-
# *
|
|
164
|
-
# *
|
|
165
|
-
# *
|
|
166
|
-
# *
|
|
167
|
-
# *
|
|
168
|
-
# *
|
|
169
|
-
# *
|
|
258
|
+
# * `:label` - (String)
|
|
259
|
+
# * `:datapoints` - (Array<Hash>)
|
|
260
|
+
# * `:timestamp` - (Time)
|
|
261
|
+
# * `:sample_count` - (Numeric)
|
|
262
|
+
# * `:average` - (Numeric)
|
|
263
|
+
# * `:sum` - (Numeric)
|
|
264
|
+
# * `:minimum` - (Numeric)
|
|
265
|
+
# * `:maximum` - (Numeric)
|
|
266
|
+
# * `:unit` - (String)
|
|
170
267
|
|
|
171
268
|
# @!method list_metrics(options = {})
|
|
172
269
|
# Calls the ListMetrics API operation.
|
|
173
270
|
# @param [Hash] options
|
|
174
|
-
# *
|
|
175
|
-
# *
|
|
176
|
-
# *
|
|
177
|
-
#
|
|
178
|
-
# *
|
|
179
|
-
#
|
|
271
|
+
# * `:namespace` - (String) The namespace to filter against.
|
|
272
|
+
# * `:metric_name` - (String) The name of the metric to filter against.
|
|
273
|
+
# * `:dimensions` - (Array<Hash>) A list of dimensions to filter
|
|
274
|
+
# against.
|
|
275
|
+
# * `:name` - *required* - (String) The dimension name to be matched.
|
|
276
|
+
# * `:value` - (String) The value of the dimension to be matched.
|
|
277
|
+
# Specifying a Name without specifying a Value returns all values
|
|
278
|
+
# associated with that Name.
|
|
279
|
+
# * `:next_token` - (String) The token returned by a previous call to
|
|
280
|
+
# indicate that there is more data available.
|
|
180
281
|
# @return [Core::Response]
|
|
181
282
|
# The #data method of the response object returns
|
|
182
283
|
# a hash with the following structure:
|
|
183
|
-
# *
|
|
184
|
-
# *
|
|
185
|
-
# *
|
|
186
|
-
# *
|
|
187
|
-
# *
|
|
188
|
-
# *
|
|
189
|
-
# *
|
|
284
|
+
# * `:metrics` - (Array<Hash>)
|
|
285
|
+
# * `:namespace` - (String)
|
|
286
|
+
# * `:metric_name` - (String)
|
|
287
|
+
# * `:dimensions` - (Array<Hash>)
|
|
288
|
+
# * `:name` - (String)
|
|
289
|
+
# * `:value` - (String)
|
|
290
|
+
# * `:next_token` - (String)
|
|
190
291
|
|
|
191
292
|
# @!method put_metric_alarm(options = {})
|
|
192
293
|
# Calls the PutMetricAlarm API operation.
|
|
193
294
|
# @param [Hash] options
|
|
194
|
-
# *
|
|
195
|
-
#
|
|
196
|
-
# *
|
|
197
|
-
# *
|
|
198
|
-
#
|
|
199
|
-
# *
|
|
200
|
-
#
|
|
201
|
-
#
|
|
202
|
-
#
|
|
203
|
-
#
|
|
204
|
-
#
|
|
205
|
-
#
|
|
206
|
-
#
|
|
207
|
-
#
|
|
208
|
-
#
|
|
209
|
-
# *
|
|
210
|
-
#
|
|
295
|
+
# * `:alarm_name` - *required* - (String) The descriptive name for the
|
|
296
|
+
# alarm. This name must be unique within the user's AWS account
|
|
297
|
+
# * `:alarm_description` - (String) The description for the alarm.
|
|
298
|
+
# * `:actions_enabled` - (Boolean) Indicates whether or not actions
|
|
299
|
+
# should be executed during any changes to the alarm's state.
|
|
300
|
+
# * `:ok_actions` - (Array<String>) The list of actions to execute when
|
|
301
|
+
# this alarm transitions into an OK state from any other state. Each
|
|
302
|
+
# action is specified as an Amazon Resource Number (ARN). Currently
|
|
303
|
+
# the only action supported is publishing to an Amazon SNS topic or
|
|
304
|
+
# an Amazon Auto Scaling policy.
|
|
305
|
+
# * `:alarm_actions` - (Array<String>) The list of actions to execute
|
|
306
|
+
# when this alarm transitions into an ALARM state from any other
|
|
307
|
+
# state. Each action is specified as an Amazon Resource Number (ARN).
|
|
308
|
+
# Currently the only action supported is publishing to an Amazon SNS
|
|
309
|
+
# topic or an Amazon Auto Scaling policy.
|
|
310
|
+
# * `:insufficient_data_actions` - (Array<String>) The list of actions
|
|
311
|
+
# to execute when this alarm transitions into an INSUFFICIENT_DATA
|
|
312
|
+
# state from any other state. Each action is specified as an Amazon
|
|
313
|
+
# Resource Number (ARN). Currently the only action supported is
|
|
314
|
+
# publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.
|
|
315
|
+
# * `:metric_name` - *required* - (String) The name for the alarm's
|
|
316
|
+
# associated metric.
|
|
317
|
+
# * `:namespace` - *required* - (String) The namespace for the alarm's
|
|
318
|
+
# associated metric.
|
|
319
|
+
# * `:statistic` - *required* - (String) The statistic to apply to the
|
|
320
|
+
# alarm's associated metric. Valid values include:
|
|
321
|
+
# * `SampleCount`
|
|
322
|
+
# * `Average`
|
|
323
|
+
# * `Sum`
|
|
324
|
+
# * `Minimum`
|
|
325
|
+
# * `Maximum`
|
|
326
|
+
# * `:dimensions` - (Array<Hash>) The dimensions for the alarm's
|
|
327
|
+
# associated metric.
|
|
328
|
+
# * `:name` - *required* - (String) The name of the dimension.
|
|
329
|
+
# * `:value` - *required* - (String) The value representing the
|
|
330
|
+
# dimension measurement
|
|
331
|
+
# * `:period` - *required* - (Integer) The period in seconds over which
|
|
332
|
+
# the specified statistic is applied.
|
|
333
|
+
# * `:unit` - (String) The unit for the alarm's associated metric.
|
|
334
|
+
# Valid values include:
|
|
335
|
+
# * `Seconds`
|
|
336
|
+
# * `Microseconds`
|
|
337
|
+
# * `Milliseconds`
|
|
338
|
+
# * `Bytes`
|
|
339
|
+
# * `Kilobytes`
|
|
340
|
+
# * `Megabytes`
|
|
341
|
+
# * `Gigabytes`
|
|
342
|
+
# * `Terabytes`
|
|
343
|
+
# * `Bits`
|
|
344
|
+
# * `Kilobits`
|
|
345
|
+
# * `Megabits`
|
|
346
|
+
# * `Gigabits`
|
|
347
|
+
# * `Terabits`
|
|
348
|
+
# * `Percent`
|
|
349
|
+
# * `Count`
|
|
350
|
+
# * `Bytes/Second`
|
|
351
|
+
# * `Kilobytes/Second`
|
|
352
|
+
# * `Megabytes/Second`
|
|
353
|
+
# * `Gigabytes/Second`
|
|
354
|
+
# * `Terabytes/Second`
|
|
355
|
+
# * `Bits/Second`
|
|
356
|
+
# * `Kilobits/Second`
|
|
357
|
+
# * `Megabits/Second`
|
|
358
|
+
# * `Gigabits/Second`
|
|
359
|
+
# * `Terabits/Second`
|
|
360
|
+
# * `Count/Second`
|
|
361
|
+
# * `None`
|
|
362
|
+
# * `:evaluation_periods` - *required* - (Integer) The number of
|
|
363
|
+
# periods over which data is compared to the specified threshold.
|
|
364
|
+
# * `:threshold` - *required* - (Float) The value against which the
|
|
365
|
+
# specified statistic is compared.
|
|
366
|
+
# * `:comparison_operator` - *required* - (String) The arithmetic
|
|
367
|
+
# operation to use when comparing the specified Statistic and
|
|
368
|
+
# Threshold. The specified Statistic value is used as the first
|
|
369
|
+
# operand. Valid values include:
|
|
370
|
+
# * `GreaterThanOrEqualToThreshold`
|
|
371
|
+
# * `GreaterThanThreshold`
|
|
372
|
+
# * `LessThanThreshold`
|
|
373
|
+
# * `LessThanOrEqualToThreshold`
|
|
211
374
|
# @return [Core::Response]
|
|
212
375
|
|
|
213
376
|
# @!method put_metric_data(options = {})
|
|
214
377
|
# Calls the PutMetricData API operation.
|
|
215
378
|
# @param [Hash] options
|
|
216
|
-
# *
|
|
217
|
-
#
|
|
218
|
-
#
|
|
219
|
-
#
|
|
220
|
-
#
|
|
221
|
-
#
|
|
222
|
-
#
|
|
223
|
-
#
|
|
224
|
-
#
|
|
225
|
-
#
|
|
226
|
-
#
|
|
227
|
-
#
|
|
228
|
-
#
|
|
229
|
-
# *
|
|
379
|
+
# * `:namespace` - *required* - (String) The namespace for the metric
|
|
380
|
+
# data.
|
|
381
|
+
# * `:metric_data` - *required* - (Array<Hash>) A list of data
|
|
382
|
+
# describing the metric.
|
|
383
|
+
# * `:metric_name` - *required* - (String) The name of the metric.
|
|
384
|
+
# * `:dimensions` - (Array<Hash>) A list of dimensions associated
|
|
385
|
+
# with the metric.
|
|
386
|
+
# * `:name` - *required* - (String) The name of the dimension.
|
|
387
|
+
# * `:value` - *required* - (String) The value representing the
|
|
388
|
+
# dimension measurement
|
|
389
|
+
# * `:timestamp` - (String<ISO8601 datetime>) The time stamp used for
|
|
390
|
+
# the metric. If not specified, the default value is set to the
|
|
391
|
+
# time the metric data was received.
|
|
392
|
+
# * `:value` - (Float) The value for the metric. Although the Value
|
|
393
|
+
# parameter accepts numbers of type Double, Amazon CloudWatch
|
|
394
|
+
# truncates values with very large exponents. Values with base-10
|
|
395
|
+
# exponents greater than 126 (1 x 10^126) are truncated. Likewise,
|
|
396
|
+
# values with base-10 exponents less than -130 (1 x 10^-130) are
|
|
397
|
+
# also truncated.
|
|
398
|
+
# * `:statistic_values` - (Hash) A set of statistical values
|
|
399
|
+
# describing the metric.
|
|
400
|
+
# * `:sample_count` - *required* - (Float) The number of samples
|
|
401
|
+
# used for the statistic set.
|
|
402
|
+
# * `:sum` - *required* - (Float) The sum of values for the sample
|
|
403
|
+
# set.
|
|
404
|
+
# * `:minimum` - *required* - (Float) The minimum value of the
|
|
405
|
+
# sample set.
|
|
406
|
+
# * `:maximum` - *required* - (Float) The maximum value of the
|
|
407
|
+
# sample set.
|
|
408
|
+
# * `:unit` - (String) The unit of the metric. Valid values include:
|
|
409
|
+
# * `Seconds`
|
|
410
|
+
# * `Microseconds`
|
|
411
|
+
# * `Milliseconds`
|
|
412
|
+
# * `Bytes`
|
|
413
|
+
# * `Kilobytes`
|
|
414
|
+
# * `Megabytes`
|
|
415
|
+
# * `Gigabytes`
|
|
416
|
+
# * `Terabytes`
|
|
417
|
+
# * `Bits`
|
|
418
|
+
# * `Kilobits`
|
|
419
|
+
# * `Megabits`
|
|
420
|
+
# * `Gigabits`
|
|
421
|
+
# * `Terabits`
|
|
422
|
+
# * `Percent`
|
|
423
|
+
# * `Count`
|
|
424
|
+
# * `Bytes/Second`
|
|
425
|
+
# * `Kilobytes/Second`
|
|
426
|
+
# * `Megabytes/Second`
|
|
427
|
+
# * `Gigabytes/Second`
|
|
428
|
+
# * `Terabytes/Second`
|
|
429
|
+
# * `Bits/Second`
|
|
430
|
+
# * `Kilobits/Second`
|
|
431
|
+
# * `Megabits/Second`
|
|
432
|
+
# * `Gigabits/Second`
|
|
433
|
+
# * `Terabits/Second`
|
|
434
|
+
# * `Count/Second`
|
|
435
|
+
# * `None`
|
|
230
436
|
# @return [Core::Response]
|
|
231
437
|
|
|
232
438
|
# @!method set_alarm_state(options = {})
|
|
233
439
|
# Calls the SetAlarmState API operation.
|
|
234
440
|
# @param [Hash] options
|
|
235
|
-
# *
|
|
236
|
-
#
|
|
237
|
-
#
|
|
238
|
-
# *
|
|
441
|
+
# * `:alarm_name` - *required* - (String) The descriptive name for the
|
|
442
|
+
# alarm. This name must be unique within the user's AWS account. The
|
|
443
|
+
# maximum length is 255 characters.
|
|
444
|
+
# * `:state_value` - *required* - (String) The value of the state.
|
|
445
|
+
# Valid values include:
|
|
446
|
+
# * `OK`
|
|
447
|
+
# * `ALARM`
|
|
448
|
+
# * `INSUFFICIENT_DATA`
|
|
449
|
+
# * `:state_reason` - *required* - (String) The reason that this alarm
|
|
450
|
+
# is set to this specific state (in human-readable text format)
|
|
451
|
+
# * `:state_reason_data` - (String) The reason that this alarm is set
|
|
452
|
+
# to this specific state (in machine-readable JSON format)
|
|
239
453
|
# @return [Core::Response]
|
|
240
454
|
|
|
241
455
|
# end client methods #
|