aws-sdk-applicationsignals 1.31.0 → 1.32.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 +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-applicationsignals/client.rb +230 -78
- data/lib/aws-sdk-applicationsignals/client_api.rb +46 -0
- data/lib/aws-sdk-applicationsignals/types.rb +439 -222
- data/lib/aws-sdk-applicationsignals.rb +1 -1
- data/sig/client.rbs +23 -1
- data/sig/types.rbs +24 -1
- metadata +1 -1
|
@@ -23,18 +23,19 @@ module Aws::ApplicationSignals
|
|
|
23
23
|
include Aws::Structure
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
#
|
|
27
|
-
#
|
|
26
|
+
# A structure that defines a filter for narrowing down results based on
|
|
27
|
+
# specific attribute values. This can be used to filter services by
|
|
28
|
+
# platform, environment, or other service characteristics.
|
|
28
29
|
#
|
|
29
30
|
# @!attribute [rw] attribute_filter_name
|
|
30
|
-
# The name of the attribute to filter
|
|
31
|
-
#
|
|
31
|
+
# The name of the attribute to filter by, such as `Platform`,
|
|
32
|
+
# `Environment`, or `BusinessUnit`.
|
|
32
33
|
# @return [String]
|
|
33
34
|
#
|
|
34
35
|
# @!attribute [rw] attribute_filter_values
|
|
35
|
-
# An array of values to match
|
|
36
|
-
#
|
|
37
|
-
#
|
|
36
|
+
# An array of values to match for the specified attribute. Services
|
|
37
|
+
# that have any of these values for the attribute will be included in
|
|
38
|
+
# the results.
|
|
38
39
|
# @return [Array<String>]
|
|
39
40
|
#
|
|
40
41
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AttributeFilter AWS API Documentation
|
|
@@ -46,40 +47,42 @@ module Aws::ApplicationSignals
|
|
|
46
47
|
include Aws::Structure
|
|
47
48
|
end
|
|
48
49
|
|
|
49
|
-
#
|
|
50
|
-
#
|
|
51
|
-
#
|
|
50
|
+
# A structure that contains information about an audit finding, which
|
|
51
|
+
# represents an automated analysis result about service behavior,
|
|
52
|
+
# performance issues, or potential problems identified through heuristic
|
|
53
|
+
# algorithms.
|
|
52
54
|
#
|
|
53
55
|
# @!attribute [rw] key_attributes
|
|
54
|
-
#
|
|
55
|
-
#
|
|
56
|
-
#
|
|
56
|
+
# The key attributes that identify the service or entity this audit
|
|
57
|
+
# finding relates to. This is a string-to-string map that includes
|
|
58
|
+
# fields like Type, Name, and Environment.
|
|
57
59
|
# @return [Hash<String,String>]
|
|
58
60
|
#
|
|
59
61
|
# @!attribute [rw] auditor_results
|
|
60
|
-
# An array of results
|
|
61
|
-
#
|
|
62
|
-
#
|
|
62
|
+
# An array of auditor results that contain the specific findings,
|
|
63
|
+
# descriptions, and severity levels identified by different auditing
|
|
64
|
+
# algorithms.
|
|
63
65
|
# @return [Array<Types::AuditorResult>]
|
|
64
66
|
#
|
|
65
67
|
# @!attribute [rw] operation
|
|
66
|
-
# The
|
|
67
|
-
#
|
|
68
|
+
# The name of the operation associated with this audit finding, if the
|
|
69
|
+
# finding is specific to a particular service operation.
|
|
68
70
|
# @return [String]
|
|
69
71
|
#
|
|
70
72
|
# @!attribute [rw] metric_graph
|
|
71
|
-
# A
|
|
72
|
-
#
|
|
73
|
+
# A structure containing metric data queries and time range
|
|
74
|
+
# information that provides context for the audit finding through
|
|
75
|
+
# relevant performance metrics.
|
|
73
76
|
# @return [Types::MetricGraph]
|
|
74
77
|
#
|
|
75
78
|
# @!attribute [rw] dependency_graph
|
|
76
|
-
# A
|
|
77
|
-
#
|
|
79
|
+
# A structure containing nodes and edges that represent the dependency
|
|
80
|
+
# relationships relevant to this audit finding, helping to understand
|
|
81
|
+
# the context and potential impact.
|
|
78
82
|
# @return [Types::DependencyGraph]
|
|
79
83
|
#
|
|
80
84
|
# @!attribute [rw] type
|
|
81
|
-
# The type
|
|
82
|
-
# "Security", or "Configuration".
|
|
85
|
+
# The type of audit finding.
|
|
83
86
|
# @return [String]
|
|
84
87
|
#
|
|
85
88
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AuditFinding AWS API Documentation
|
|
@@ -95,17 +98,16 @@ module Aws::ApplicationSignals
|
|
|
95
98
|
include Aws::Structure
|
|
96
99
|
end
|
|
97
100
|
|
|
98
|
-
#
|
|
99
|
-
#
|
|
101
|
+
# A structure that specifies the target entity for audit analysis, such
|
|
102
|
+
# as a `service`, `SLO`, `service_operation`, or `canary`.
|
|
100
103
|
#
|
|
101
104
|
# @!attribute [rw] type
|
|
102
|
-
# The type of
|
|
103
|
-
#
|
|
105
|
+
# The type of entity being audited, such as `service`, `SLO`,
|
|
106
|
+
# `service_operation`, or `canary`.
|
|
104
107
|
# @return [String]
|
|
105
108
|
#
|
|
106
109
|
# @!attribute [rw] data
|
|
107
|
-
# The specific data
|
|
108
|
-
# containing details needed to identify and examine the resource.
|
|
110
|
+
# The specific data identifying the audit target entity.
|
|
109
111
|
# @return [Types::AuditTargetEntity]
|
|
110
112
|
#
|
|
111
113
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AuditTarget AWS API Documentation
|
|
@@ -117,8 +119,8 @@ module Aws::ApplicationSignals
|
|
|
117
119
|
include Aws::Structure
|
|
118
120
|
end
|
|
119
121
|
|
|
120
|
-
# A union
|
|
121
|
-
#
|
|
122
|
+
# A union structure that contains the specific entity information for
|
|
123
|
+
# different types of audit targets.
|
|
122
124
|
#
|
|
123
125
|
# @note AuditTargetEntity is a union - when making an API calls you must set exactly one of the members.
|
|
124
126
|
#
|
|
@@ -127,13 +129,13 @@ module Aws::ApplicationSignals
|
|
|
127
129
|
# @return [Types::ServiceEntity]
|
|
128
130
|
#
|
|
129
131
|
# @!attribute [rw] slo
|
|
130
|
-
#
|
|
131
|
-
#
|
|
132
|
+
# SLO entity information when the audit target is a service level
|
|
133
|
+
# objective.
|
|
132
134
|
# @return [Types::ServiceLevelObjectiveEntity]
|
|
133
135
|
#
|
|
134
136
|
# @!attribute [rw] service_operation
|
|
135
137
|
# Service operation entity information when the audit target is a
|
|
136
|
-
# specific operation
|
|
138
|
+
# specific service operation.
|
|
137
139
|
# @return [Types::ServiceOperationEntity]
|
|
138
140
|
#
|
|
139
141
|
# @!attribute [rw] canary
|
|
@@ -160,22 +162,27 @@ module Aws::ApplicationSignals
|
|
|
160
162
|
class Unknown < AuditTargetEntity; end
|
|
161
163
|
end
|
|
162
164
|
|
|
163
|
-
#
|
|
164
|
-
#
|
|
165
|
+
# A structure that contains the result of an automated audit analysis,
|
|
166
|
+
# including the auditor name, description of findings, additional data,
|
|
167
|
+
# and severity level.
|
|
165
168
|
#
|
|
166
169
|
# @!attribute [rw] auditor
|
|
167
|
-
# The name
|
|
168
|
-
# and generated this result.
|
|
170
|
+
# The name of the auditor algorithm that generated this result.
|
|
169
171
|
# @return [String]
|
|
170
172
|
#
|
|
171
173
|
# @!attribute [rw] description
|
|
172
|
-
# A detailed description of
|
|
173
|
-
#
|
|
174
|
+
# A detailed description of the audit finding, explaining what was
|
|
175
|
+
# observed and potential implications.
|
|
174
176
|
# @return [String]
|
|
175
177
|
#
|
|
178
|
+
# @!attribute [rw] data
|
|
179
|
+
# This is a string-to-string map. It contains additional data about
|
|
180
|
+
# the result of an automated audit analysis.
|
|
181
|
+
# @return [Hash<String,String>]
|
|
182
|
+
#
|
|
176
183
|
# @!attribute [rw] severity
|
|
177
|
-
# The severity level of
|
|
178
|
-
#
|
|
184
|
+
# The severity level of this audit finding, indicating the importance
|
|
185
|
+
# and potential impact of the issue.
|
|
179
186
|
# @return [String]
|
|
180
187
|
#
|
|
181
188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AuditorResult AWS API Documentation
|
|
@@ -183,6 +190,7 @@ module Aws::ApplicationSignals
|
|
|
183
190
|
class AuditorResult < Struct.new(
|
|
184
191
|
:auditor,
|
|
185
192
|
:description,
|
|
193
|
+
:data,
|
|
186
194
|
:severity)
|
|
187
195
|
SENSITIVE = []
|
|
188
196
|
include Aws::Structure
|
|
@@ -364,8 +372,8 @@ module Aws::ApplicationSignals
|
|
|
364
372
|
include Aws::Structure
|
|
365
373
|
end
|
|
366
374
|
|
|
367
|
-
#
|
|
368
|
-
#
|
|
375
|
+
# A structure that contains identifying information for a CloudWatch
|
|
376
|
+
# Synthetics canary entity used in audit targeting.
|
|
369
377
|
#
|
|
370
378
|
# @!attribute [rw] canary_name
|
|
371
379
|
# The name of the CloudWatch Synthetics canary.
|
|
@@ -379,44 +387,74 @@ module Aws::ApplicationSignals
|
|
|
379
387
|
include Aws::Structure
|
|
380
388
|
end
|
|
381
389
|
|
|
382
|
-
#
|
|
383
|
-
#
|
|
384
|
-
# may impact service performance.
|
|
390
|
+
# A structure that contains information about a change event that
|
|
391
|
+
# occurred for a service, such as a deployment or configuration change.
|
|
385
392
|
#
|
|
386
393
|
# @!attribute [rw] timestamp
|
|
387
|
-
# The timestamp when
|
|
388
|
-
#
|
|
394
|
+
# The timestamp when this change event occurred. When used in a raw
|
|
395
|
+
# HTTP Query API, it is formatted as epoch time in seconds.
|
|
389
396
|
# @return [Time]
|
|
390
397
|
#
|
|
391
398
|
# @!attribute [rw] account_id
|
|
392
|
-
# The
|
|
399
|
+
# The Amazon Web Services account ID where this change event occurred.
|
|
393
400
|
# @return [String]
|
|
394
401
|
#
|
|
395
402
|
# @!attribute [rw] region
|
|
396
|
-
# The
|
|
403
|
+
# The Amazon Web Services region where this change event occurred.
|
|
397
404
|
# @return [String]
|
|
398
405
|
#
|
|
399
406
|
# @!attribute [rw] entity
|
|
400
|
-
# The entity or resource that was
|
|
401
|
-
#
|
|
407
|
+
# The entity (service or resource) that was affected by this change
|
|
408
|
+
# event, including its key attributes.
|
|
409
|
+
#
|
|
410
|
+
# This is a string-to-string map. It can include the following fields.
|
|
411
|
+
#
|
|
412
|
+
# * `Type` designates the type of object this is.
|
|
413
|
+
#
|
|
414
|
+
# * `ResourceType` specifies the type of the resource. This field is
|
|
415
|
+
# used only when the value of the `Type` field is `Resource` or
|
|
416
|
+
# `AWS::Resource`.
|
|
417
|
+
#
|
|
418
|
+
# * `Name` specifies the name of the object. This is used only if the
|
|
419
|
+
# value of the `Type` field is `Service`, `RemoteService`, or
|
|
420
|
+
# `AWS::Service`.
|
|
421
|
+
#
|
|
422
|
+
# * `Identifier` identifies the resource objects of this resource.
|
|
423
|
+
# This is used only if the value of the `Type` field is `Resource`
|
|
424
|
+
# or `AWS::Resource`.
|
|
425
|
+
#
|
|
426
|
+
# * `Environment` specifies the location where this object is hosted,
|
|
427
|
+
# or what it belongs to.
|
|
428
|
+
#
|
|
429
|
+
# * `AwsAccountId` specifies the account where this object is in.
|
|
430
|
+
#
|
|
431
|
+
# Below is an example of a service.
|
|
432
|
+
#
|
|
433
|
+
# `{ "Type": "Service", "Name": "visits-service", "Environment":
|
|
434
|
+
# "petclinic-test" }`
|
|
435
|
+
#
|
|
436
|
+
# Below is an example of a resource.
|
|
437
|
+
#
|
|
438
|
+
# `{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table",
|
|
439
|
+
# "Identifier": "Customers" }`
|
|
402
440
|
# @return [Hash<String,String>]
|
|
403
441
|
#
|
|
404
442
|
# @!attribute [rw] change_event_type
|
|
405
|
-
# The type of change that occurred, such as
|
|
406
|
-
# "Configuration", or "Infrastructure".
|
|
443
|
+
# The type of change event that occurred, such as `DEPLOYMENT`.
|
|
407
444
|
# @return [String]
|
|
408
445
|
#
|
|
409
446
|
# @!attribute [rw] event_id
|
|
410
|
-
# A unique identifier for
|
|
447
|
+
# A unique identifier for this change event. For CloudTrail-based
|
|
448
|
+
# events, this is the CloudTrail event id. For other events, this will
|
|
449
|
+
# be `Unknown`.
|
|
411
450
|
# @return [String]
|
|
412
451
|
#
|
|
413
452
|
# @!attribute [rw] user_name
|
|
414
|
-
# The name of the user
|
|
453
|
+
# The name of the user who initiated this change event, if available.
|
|
415
454
|
# @return [String]
|
|
416
455
|
#
|
|
417
456
|
# @!attribute [rw] event_name
|
|
418
|
-
#
|
|
419
|
-
# what changed.
|
|
457
|
+
# The name or description of this change event.
|
|
420
458
|
# @return [String]
|
|
421
459
|
#
|
|
422
460
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ChangeEvent AWS API Documentation
|
|
@@ -585,17 +623,18 @@ module Aws::ApplicationSignals
|
|
|
585
623
|
include Aws::Structure
|
|
586
624
|
end
|
|
587
625
|
|
|
588
|
-
#
|
|
589
|
-
#
|
|
626
|
+
# A structure that represents the dependency relationships relevant to
|
|
627
|
+
# an audit finding, containing nodes and edges that show how services
|
|
628
|
+
# and resources are connected.
|
|
590
629
|
#
|
|
591
630
|
# @!attribute [rw] nodes
|
|
592
|
-
# An array of nodes
|
|
593
|
-
#
|
|
631
|
+
# An array of nodes representing the services, resources, or other
|
|
632
|
+
# entities in the dependency graph.
|
|
594
633
|
# @return [Array<Types::Node>]
|
|
595
634
|
#
|
|
596
635
|
# @!attribute [rw] edges
|
|
597
|
-
# An array of edges
|
|
598
|
-
#
|
|
636
|
+
# An array of edges representing the connections and relationships
|
|
637
|
+
# between the nodes in the dependency graph.
|
|
599
638
|
# @return [Array<Types::Edge>]
|
|
600
639
|
#
|
|
601
640
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/DependencyGraph AWS API Documentation
|
|
@@ -639,26 +678,26 @@ module Aws::ApplicationSignals
|
|
|
639
678
|
include Aws::Structure
|
|
640
679
|
end
|
|
641
680
|
|
|
642
|
-
#
|
|
643
|
-
#
|
|
681
|
+
# A structure that represents a connection between two nodes in a
|
|
682
|
+
# dependency graph, showing the relationship and characteristics of the
|
|
683
|
+
# connection.
|
|
644
684
|
#
|
|
645
685
|
# @!attribute [rw] source_node_id
|
|
646
|
-
# The identifier of the source node in
|
|
686
|
+
# The identifier of the source node in this edge connection.
|
|
647
687
|
# @return [String]
|
|
648
688
|
#
|
|
649
689
|
# @!attribute [rw] destination_node_id
|
|
650
|
-
# The identifier of the destination node in
|
|
651
|
-
# relationship.
|
|
690
|
+
# The identifier of the destination node in this edge connection.
|
|
652
691
|
# @return [String]
|
|
653
692
|
#
|
|
654
693
|
# @!attribute [rw] duration
|
|
655
|
-
# The
|
|
656
|
-
#
|
|
694
|
+
# The duration or latency associated with this connection, if
|
|
695
|
+
# applicable.
|
|
657
696
|
# @return [Float]
|
|
658
697
|
#
|
|
659
698
|
# @!attribute [rw] connection_type
|
|
660
|
-
# The type of connection between the nodes,
|
|
661
|
-
#
|
|
699
|
+
# The type of connection between the nodes, indicating the nature of
|
|
700
|
+
# the relationship.
|
|
662
701
|
# @return [String]
|
|
663
702
|
#
|
|
664
703
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/Edge AWS API Documentation
|
|
@@ -877,25 +916,27 @@ module Aws::ApplicationSignals
|
|
|
877
916
|
include Aws::Structure
|
|
878
917
|
end
|
|
879
918
|
|
|
880
|
-
#
|
|
881
|
-
#
|
|
882
|
-
#
|
|
919
|
+
# A structure that defines how services should be grouped based on
|
|
920
|
+
# specific attributes. This includes the friendly name for the grouping,
|
|
921
|
+
# the source keys to derive values from, and an optional default value.
|
|
883
922
|
#
|
|
884
923
|
# @!attribute [rw] grouping_name
|
|
885
|
-
# The name
|
|
886
|
-
#
|
|
924
|
+
# The friendly name for this grouping attribute, such as
|
|
925
|
+
# `BusinessUnit` or `Environment`. This name is used to identify the
|
|
926
|
+
# grouping in the console and APIs.
|
|
887
927
|
# @return [String]
|
|
888
928
|
#
|
|
889
929
|
# @!attribute [rw] grouping_source_keys
|
|
890
|
-
# An array of source
|
|
891
|
-
#
|
|
892
|
-
#
|
|
930
|
+
# An array of source keys used to derive the grouping attribute value
|
|
931
|
+
# from telemetry data, Amazon Web Services tags, or other sources. For
|
|
932
|
+
# example, \["business\_unit", "team"\] would look for values in
|
|
933
|
+
# those fields.
|
|
893
934
|
# @return [Array<String>]
|
|
894
935
|
#
|
|
895
936
|
# @!attribute [rw] default_grouping_value
|
|
896
|
-
# The default value to use for grouping when
|
|
897
|
-
#
|
|
898
|
-
#
|
|
937
|
+
# The default value to use for this grouping attribute when no value
|
|
938
|
+
# can be derived from the source keys. This ensures all services have
|
|
939
|
+
# a grouping value even if the source data is missing.
|
|
899
940
|
# @return [String]
|
|
900
941
|
#
|
|
901
942
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/GroupingAttributeDefinition AWS API Documentation
|
|
@@ -908,18 +949,19 @@ module Aws::ApplicationSignals
|
|
|
908
949
|
include Aws::Structure
|
|
909
950
|
end
|
|
910
951
|
|
|
911
|
-
#
|
|
912
|
-
#
|
|
952
|
+
# A structure that contains the complete grouping configuration for an
|
|
953
|
+
# account, including all defined grouping attributes and metadata about
|
|
954
|
+
# when it was last updated.
|
|
913
955
|
#
|
|
914
956
|
# @!attribute [rw] grouping_attribute_definitions
|
|
915
|
-
# An array of grouping attribute definitions that specify
|
|
916
|
-
#
|
|
957
|
+
# An array of grouping attribute definitions that specify how services
|
|
958
|
+
# should be grouped based on various attributes and source keys.
|
|
917
959
|
# @return [Array<Types::GroupingAttributeDefinition>]
|
|
918
960
|
#
|
|
919
961
|
# @!attribute [rw] updated_at
|
|
920
|
-
# The timestamp when
|
|
921
|
-
#
|
|
922
|
-
#
|
|
962
|
+
# The timestamp when this grouping configuration was last updated.
|
|
963
|
+
# When used in a raw HTTP Query API, it is formatted as epoch time in
|
|
964
|
+
# seconds.
|
|
923
965
|
# @return [Time]
|
|
924
966
|
#
|
|
925
967
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/GroupingConfiguration AWS API Documentation
|
|
@@ -964,38 +1006,79 @@ module Aws::ApplicationSignals
|
|
|
964
1006
|
end
|
|
965
1007
|
|
|
966
1008
|
# @!attribute [rw] start_time
|
|
967
|
-
# The start time
|
|
968
|
-
#
|
|
969
|
-
#
|
|
970
|
-
# UTC.
|
|
1009
|
+
# The start of the time period to retrieve audit findings for. When
|
|
1010
|
+
# used in a raw HTTP Query API, it is formatted as epoch time in
|
|
1011
|
+
# seconds. For example, `1698778057`
|
|
971
1012
|
# @return [Time]
|
|
972
1013
|
#
|
|
973
1014
|
# @!attribute [rw] end_time
|
|
974
|
-
# The end time
|
|
975
|
-
#
|
|
976
|
-
#
|
|
1015
|
+
# The end of the time period to retrieve audit findings for. When used
|
|
1016
|
+
# in a raw HTTP Query API, it is formatted as epoch time in seconds.
|
|
1017
|
+
# For example, `1698778057`
|
|
977
1018
|
# @return [Time]
|
|
978
1019
|
#
|
|
979
1020
|
# @!attribute [rw] auditors
|
|
980
|
-
#
|
|
981
|
-
# generated by the specified auditors will be returned.
|
|
982
|
-
#
|
|
1021
|
+
# A list of auditor names to filter the findings by. Only findings
|
|
1022
|
+
# generated by the specified auditors will be returned.
|
|
1023
|
+
#
|
|
1024
|
+
# The following auditors are available for configuration:
|
|
1025
|
+
#
|
|
1026
|
+
# * `slo` - SloAuditor: Identifies SLO violations and detects breached
|
|
1027
|
+
# thresholds during the Assessment phase.
|
|
1028
|
+
#
|
|
1029
|
+
# * `operation_metric` - OperationMetricAuditor: Detects anomalies in
|
|
1030
|
+
# service operation metrics from Application Signals RED metrics
|
|
1031
|
+
# during the Assessment phase
|
|
1032
|
+
#
|
|
1033
|
+
# <note markdown="1"> Anomaly detection is not supported for sparse metrics (those
|
|
1034
|
+
# missing more than 80% of datapoints within the given time period).
|
|
1035
|
+
#
|
|
1036
|
+
# </note>
|
|
1037
|
+
#
|
|
1038
|
+
# * `service_quota` - ServiceQuotaAuditor: Monitors resource
|
|
1039
|
+
# utilization against service quotas during the Assessment phase
|
|
1040
|
+
#
|
|
1041
|
+
# * `trace` - TraceAuditor: Performs deep-dive analysis of distributed
|
|
1042
|
+
# traces, correlating traces with breached SLOs or abnormal RED
|
|
1043
|
+
# metrics during the Analysis phase
|
|
1044
|
+
#
|
|
1045
|
+
# * `dependency_metric` - CriticalPathAuditor: Analyzes service
|
|
1046
|
+
# dependency impacts and maps dependency relationships from
|
|
1047
|
+
# Application Signals RED metrics during the Analysis phase
|
|
1048
|
+
#
|
|
1049
|
+
# * `top_contributor` - TopContributorAuditor: Identifies
|
|
1050
|
+
# infrastructure-level contributors to issues by analyzing EMF logs
|
|
1051
|
+
# of Application Signals RED metrics during the Analysis phase
|
|
1052
|
+
#
|
|
1053
|
+
# * `log` - LogAuditor: Extracts insights from application logs,
|
|
1054
|
+
# categorizing error types and ranking severity by frequency during
|
|
1055
|
+
# the Analysis phase
|
|
1056
|
+
#
|
|
1057
|
+
# <note markdown="1"> `InitAuditor` and `Summarizer` auditors are not configurable as they
|
|
1058
|
+
# are automatically triggered during the audit process.
|
|
1059
|
+
#
|
|
1060
|
+
# </note>
|
|
983
1061
|
# @return [Array<String>]
|
|
984
1062
|
#
|
|
985
1063
|
# @!attribute [rw] audit_targets
|
|
986
|
-
#
|
|
987
|
-
#
|
|
988
|
-
#
|
|
1064
|
+
# A list of audit targets to filter the findings by. You can specify
|
|
1065
|
+
# services, SLOs, or service operations to limit the audit findings to
|
|
1066
|
+
# specific entities.
|
|
989
1067
|
# @return [Array<Types::AuditTarget>]
|
|
990
1068
|
#
|
|
1069
|
+
# @!attribute [rw] detail_level
|
|
1070
|
+
# The level of details of the audit findings. Supported values:
|
|
1071
|
+
# `BRIEF`, `DETAILED`.
|
|
1072
|
+
# @return [String]
|
|
1073
|
+
#
|
|
991
1074
|
# @!attribute [rw] next_token
|
|
992
|
-
#
|
|
993
|
-
#
|
|
1075
|
+
# Include this value, if it was returned by the previous operation, to
|
|
1076
|
+
# get the next set of audit findings.
|
|
994
1077
|
# @return [String]
|
|
995
1078
|
#
|
|
996
1079
|
# @!attribute [rw] max_results
|
|
997
|
-
# The maximum number of audit findings to return in
|
|
998
|
-
#
|
|
1080
|
+
# The maximum number of audit findings to return in one operation. If
|
|
1081
|
+
# you omit this parameter, the default of 10 is used.
|
|
999
1082
|
# @return [Integer]
|
|
1000
1083
|
#
|
|
1001
1084
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListAuditFindingsInput AWS API Documentation
|
|
@@ -1005,62 +1088,194 @@ module Aws::ApplicationSignals
|
|
|
1005
1088
|
:end_time,
|
|
1006
1089
|
:auditors,
|
|
1007
1090
|
:audit_targets,
|
|
1091
|
+
:detail_level,
|
|
1008
1092
|
:next_token,
|
|
1009
1093
|
:max_results)
|
|
1010
1094
|
SENSITIVE = []
|
|
1011
1095
|
include Aws::Structure
|
|
1012
1096
|
end
|
|
1013
1097
|
|
|
1098
|
+
# @!attribute [rw] start_time
|
|
1099
|
+
# The start of the time period that the returned audit findings apply
|
|
1100
|
+
# to. When used in a raw HTTP Query API, it is formatted as epoch time
|
|
1101
|
+
# in seconds. For example, `1698778057`
|
|
1102
|
+
# @return [Time]
|
|
1103
|
+
#
|
|
1104
|
+
# @!attribute [rw] end_time
|
|
1105
|
+
# The end of the time period that the returned audit findings apply
|
|
1106
|
+
# to. When used in a raw HTTP Query API, it is formatted as epoch time
|
|
1107
|
+
# in seconds. For example, `1698778057`
|
|
1108
|
+
# @return [Time]
|
|
1109
|
+
#
|
|
1014
1110
|
# @!attribute [rw] audit_findings
|
|
1015
|
-
# An array of
|
|
1016
|
-
#
|
|
1017
|
-
#
|
|
1111
|
+
# An array of structures, where each structure contains information
|
|
1112
|
+
# about one audit finding, including the auditor results, severity,
|
|
1113
|
+
# and associated metric and dependency graphs.
|
|
1018
1114
|
# @return [Array<Types::AuditFinding>]
|
|
1019
1115
|
#
|
|
1020
1116
|
# @!attribute [rw] next_token
|
|
1021
|
-
#
|
|
1022
|
-
#
|
|
1023
|
-
# returned in the current response.
|
|
1117
|
+
# Include this value in your next use of this API to get the next set
|
|
1118
|
+
# of audit findings.
|
|
1024
1119
|
# @return [String]
|
|
1025
1120
|
#
|
|
1026
1121
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListAuditFindingsOutput AWS API Documentation
|
|
1027
1122
|
#
|
|
1028
1123
|
class ListAuditFindingsOutput < Struct.new(
|
|
1124
|
+
:start_time,
|
|
1125
|
+
:end_time,
|
|
1029
1126
|
:audit_findings,
|
|
1030
1127
|
:next_token)
|
|
1031
1128
|
SENSITIVE = []
|
|
1032
1129
|
include Aws::Structure
|
|
1033
1130
|
end
|
|
1034
1131
|
|
|
1132
|
+
# @!attribute [rw] entity
|
|
1133
|
+
# The entity for which to retrieve change events. This specifies the
|
|
1134
|
+
# service, resource, or other entity whose event history you want to
|
|
1135
|
+
# examine.
|
|
1136
|
+
#
|
|
1137
|
+
# This is a string-to-string map. It can include the following fields.
|
|
1138
|
+
#
|
|
1139
|
+
# * `Type` designates the type of object this is.
|
|
1140
|
+
#
|
|
1141
|
+
# * `ResourceType` specifies the type of the resource. This field is
|
|
1142
|
+
# used only when the value of the `Type` field is `Resource` or
|
|
1143
|
+
# `AWS::Resource`.
|
|
1144
|
+
#
|
|
1145
|
+
# * `Name` specifies the name of the object. This is used only if the
|
|
1146
|
+
# value of the `Type` field is `Service`, `RemoteService`, or
|
|
1147
|
+
# `AWS::Service`.
|
|
1148
|
+
#
|
|
1149
|
+
# * `Identifier` identifies the resource objects of this resource.
|
|
1150
|
+
# This is used only if the value of the `Type` field is `Resource`
|
|
1151
|
+
# or `AWS::Resource`.
|
|
1152
|
+
#
|
|
1153
|
+
# * `Environment` specifies the location where this object is hosted,
|
|
1154
|
+
# or what it belongs to.
|
|
1155
|
+
#
|
|
1156
|
+
# * `AwsAccountId` specifies the account where this object is in.
|
|
1157
|
+
#
|
|
1158
|
+
# Below is an example of a service.
|
|
1159
|
+
#
|
|
1160
|
+
# `{ "Type": "Service", "Name": "visits-service", "Environment":
|
|
1161
|
+
# "petclinic-test" }`
|
|
1162
|
+
#
|
|
1163
|
+
# Below is an example of a resource.
|
|
1164
|
+
#
|
|
1165
|
+
# `{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table",
|
|
1166
|
+
# "Identifier": "Customers" }`
|
|
1167
|
+
# @return [Hash<String,String>]
|
|
1168
|
+
#
|
|
1169
|
+
# @!attribute [rw] start_time
|
|
1170
|
+
# The start of the time period to retrieve change events for. When
|
|
1171
|
+
# used in a raw HTTP Query API, it is formatted as epoch time in
|
|
1172
|
+
# seconds. For example: `1698778057`
|
|
1173
|
+
# @return [Time]
|
|
1174
|
+
#
|
|
1175
|
+
# @!attribute [rw] end_time
|
|
1176
|
+
# The end of the time period to retrieve change events for. When used
|
|
1177
|
+
# in a raw HTTP Query API, it is formatted as epoch time in seconds.
|
|
1178
|
+
# For example: `1698778057`
|
|
1179
|
+
# @return [Time]
|
|
1180
|
+
#
|
|
1181
|
+
# @!attribute [rw] max_results
|
|
1182
|
+
# The maximum number of change events to return in one operation. If
|
|
1183
|
+
# you omit this parameter, the default of 50 is used.
|
|
1184
|
+
# @return [Integer]
|
|
1185
|
+
#
|
|
1186
|
+
# @!attribute [rw] next_token
|
|
1187
|
+
# Include this value, if it was returned by the previous operation, to
|
|
1188
|
+
# get the next set of change events.
|
|
1189
|
+
# @return [String]
|
|
1190
|
+
#
|
|
1191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListEntityEventsInput AWS API Documentation
|
|
1192
|
+
#
|
|
1193
|
+
class ListEntityEventsInput < Struct.new(
|
|
1194
|
+
:entity,
|
|
1195
|
+
:start_time,
|
|
1196
|
+
:end_time,
|
|
1197
|
+
:max_results,
|
|
1198
|
+
:next_token)
|
|
1199
|
+
SENSITIVE = []
|
|
1200
|
+
include Aws::Structure
|
|
1201
|
+
end
|
|
1202
|
+
|
|
1203
|
+
# @!attribute [rw] start_time
|
|
1204
|
+
# The start of the time period that the returned change events apply
|
|
1205
|
+
# to. When used in a raw HTTP Query API, it is formatted as epoch time
|
|
1206
|
+
# in seconds. For example: `1698778057`
|
|
1207
|
+
# @return [Time]
|
|
1208
|
+
#
|
|
1209
|
+
# @!attribute [rw] end_time
|
|
1210
|
+
# The end of the time period that the returned change events apply to.
|
|
1211
|
+
# When used in a raw HTTP Query API, it is formatted as epoch time in
|
|
1212
|
+
# seconds. For example: `1698778057`
|
|
1213
|
+
# @return [Time]
|
|
1214
|
+
#
|
|
1215
|
+
# @!attribute [rw] change_events
|
|
1216
|
+
# An array of structures, where each structure contains information
|
|
1217
|
+
# about one change event that occurred for the specified entity during
|
|
1218
|
+
# the requested time period.
|
|
1219
|
+
# @return [Array<Types::ChangeEvent>]
|
|
1220
|
+
#
|
|
1221
|
+
# @!attribute [rw] next_token
|
|
1222
|
+
# Include this value in your next use of this API to get the next set
|
|
1223
|
+
# of change events.
|
|
1224
|
+
# @return [String]
|
|
1225
|
+
#
|
|
1226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListEntityEventsOutput AWS API Documentation
|
|
1227
|
+
#
|
|
1228
|
+
class ListEntityEventsOutput < Struct.new(
|
|
1229
|
+
:start_time,
|
|
1230
|
+
:end_time,
|
|
1231
|
+
:change_events,
|
|
1232
|
+
:next_token)
|
|
1233
|
+
SENSITIVE = []
|
|
1234
|
+
include Aws::Structure
|
|
1235
|
+
end
|
|
1236
|
+
|
|
1035
1237
|
# @!attribute [rw] next_token
|
|
1036
|
-
#
|
|
1037
|
-
#
|
|
1038
|
-
# set is large.
|
|
1238
|
+
# Include this value, if it was returned by the previous operation, to
|
|
1239
|
+
# get the next set of grouping attribute definitions.
|
|
1039
1240
|
# @return [String]
|
|
1040
1241
|
#
|
|
1242
|
+
# @!attribute [rw] aws_account_id
|
|
1243
|
+
# The Amazon Web Services account ID to retrieve grouping attribute
|
|
1244
|
+
# definitions for. Use this when accessing grouping configurations
|
|
1245
|
+
# from a different account in cross-account monitoring scenarios.
|
|
1246
|
+
# @return [String]
|
|
1247
|
+
#
|
|
1248
|
+
# @!attribute [rw] include_linked_accounts
|
|
1249
|
+
# If you are using this operation in a monitoring account, specify
|
|
1250
|
+
# `true` to include grouping attributes from source accounts in the
|
|
1251
|
+
# returned data.
|
|
1252
|
+
# @return [Boolean]
|
|
1253
|
+
#
|
|
1041
1254
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListGroupingAttributeDefinitionsInput AWS API Documentation
|
|
1042
1255
|
#
|
|
1043
1256
|
class ListGroupingAttributeDefinitionsInput < Struct.new(
|
|
1044
|
-
:next_token
|
|
1257
|
+
:next_token,
|
|
1258
|
+
:aws_account_id,
|
|
1259
|
+
:include_linked_accounts)
|
|
1045
1260
|
SENSITIVE = []
|
|
1046
1261
|
include Aws::Structure
|
|
1047
1262
|
end
|
|
1048
1263
|
|
|
1049
1264
|
# @!attribute [rw] grouping_attribute_definitions
|
|
1050
|
-
# An array of
|
|
1051
|
-
#
|
|
1265
|
+
# An array of structures, where each structure contains information
|
|
1266
|
+
# about one grouping attribute definition, including the grouping
|
|
1267
|
+
# name, source keys, and default values.
|
|
1052
1268
|
# @return [Array<Types::GroupingAttributeDefinition>]
|
|
1053
1269
|
#
|
|
1054
1270
|
# @!attribute [rw] updated_at
|
|
1055
|
-
# The timestamp when the grouping
|
|
1056
|
-
#
|
|
1057
|
-
#
|
|
1271
|
+
# The timestamp when the grouping configuration was last updated. When
|
|
1272
|
+
# used in a raw HTTP Query API, it is formatted as epoch time in
|
|
1273
|
+
# seconds.
|
|
1058
1274
|
# @return [Time]
|
|
1059
1275
|
#
|
|
1060
1276
|
# @!attribute [rw] next_token
|
|
1061
|
-
#
|
|
1062
|
-
#
|
|
1063
|
-
# returned in the current response.
|
|
1277
|
+
# Include this value in your next use of this API to get the next set
|
|
1278
|
+
# of grouping attribute definitions.
|
|
1064
1279
|
# @return [String]
|
|
1065
1280
|
#
|
|
1066
1281
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListGroupingAttributeDefinitionsOutput AWS API Documentation
|
|
@@ -1531,44 +1746,41 @@ module Aws::ApplicationSignals
|
|
|
1531
1746
|
end
|
|
1532
1747
|
|
|
1533
1748
|
# @!attribute [rw] start_time
|
|
1534
|
-
# The start
|
|
1535
|
-
#
|
|
1536
|
-
#
|
|
1749
|
+
# The start of the time period to retrieve service state information
|
|
1750
|
+
# for. When used in a raw HTTP Query API, it is formatted as epoch
|
|
1751
|
+
# time in seconds. For example, `1698778057`.
|
|
1537
1752
|
# @return [Time]
|
|
1538
1753
|
#
|
|
1539
1754
|
# @!attribute [rw] end_time
|
|
1540
|
-
# The end
|
|
1541
|
-
#
|
|
1542
|
-
#
|
|
1755
|
+
# The end of the time period to retrieve service state information
|
|
1756
|
+
# for. When used in a raw HTTP Query API, it is formatted as epoch
|
|
1757
|
+
# time in seconds. For example, `1698778057`.
|
|
1543
1758
|
# @return [Time]
|
|
1544
1759
|
#
|
|
1545
1760
|
# @!attribute [rw] max_results
|
|
1546
|
-
# The maximum number of service states to return in
|
|
1547
|
-
#
|
|
1761
|
+
# The maximum number of service states to return in one operation. If
|
|
1762
|
+
# you omit this parameter, the default of 20 is used.
|
|
1548
1763
|
# @return [Integer]
|
|
1549
1764
|
#
|
|
1550
1765
|
# @!attribute [rw] next_token
|
|
1551
|
-
#
|
|
1552
|
-
#
|
|
1766
|
+
# Include this value, if it was returned by the previous operation, to
|
|
1767
|
+
# get the next set of service states.
|
|
1553
1768
|
# @return [String]
|
|
1554
1769
|
#
|
|
1555
1770
|
# @!attribute [rw] include_linked_accounts
|
|
1556
|
-
#
|
|
1557
|
-
#
|
|
1558
|
-
#
|
|
1771
|
+
# If you are using this operation in a monitoring account, specify
|
|
1772
|
+
# `true` to include service states from source accounts in the
|
|
1773
|
+
# returned data.
|
|
1559
1774
|
# @return [Boolean]
|
|
1560
1775
|
#
|
|
1561
1776
|
# @!attribute [rw] aws_account_id
|
|
1562
|
-
# The
|
|
1563
|
-
#
|
|
1564
|
-
# service states from the current account (and linked accounts if
|
|
1565
|
-
# enabled) are returned.
|
|
1777
|
+
# The Amazon Web Services account ID to filter service states by. Use
|
|
1778
|
+
# this to limit results to services from a specific account.
|
|
1566
1779
|
# @return [String]
|
|
1567
1780
|
#
|
|
1568
1781
|
# @!attribute [rw] attribute_filters
|
|
1569
|
-
#
|
|
1570
|
-
#
|
|
1571
|
-
# match against.
|
|
1782
|
+
# A list of attribute filters to narrow down the services. You can
|
|
1783
|
+
# filter by platform, environment, or other service attributes.
|
|
1572
1784
|
# @return [Array<Types::AttributeFilter>]
|
|
1573
1785
|
#
|
|
1574
1786
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListServiceStatesInput AWS API Documentation
|
|
@@ -1586,25 +1798,26 @@ module Aws::ApplicationSignals
|
|
|
1586
1798
|
end
|
|
1587
1799
|
|
|
1588
1800
|
# @!attribute [rw] start_time
|
|
1589
|
-
# The start
|
|
1590
|
-
#
|
|
1801
|
+
# The start of the time period that the returned information applies
|
|
1802
|
+
# to. When used in a raw HTTP Query API, it is formatted as epoch time
|
|
1803
|
+
# in seconds. For example, `1698778057`.
|
|
1591
1804
|
# @return [Time]
|
|
1592
1805
|
#
|
|
1593
1806
|
# @!attribute [rw] end_time
|
|
1594
|
-
# The end
|
|
1595
|
-
#
|
|
1807
|
+
# The end of the time period that the returned information applies to.
|
|
1808
|
+
# When used in a raw HTTP Query API, it is formatted as epoch time in
|
|
1809
|
+
# seconds. For example, `1698778057`.
|
|
1596
1810
|
# @return [Time]
|
|
1597
1811
|
#
|
|
1598
1812
|
# @!attribute [rw] service_states
|
|
1599
|
-
# An array of
|
|
1600
|
-
#
|
|
1601
|
-
#
|
|
1813
|
+
# An array of structures, where each structure contains information
|
|
1814
|
+
# about the state of one service, including its latest change events
|
|
1815
|
+
# such as deployments.
|
|
1602
1816
|
# @return [Array<Types::ServiceState>]
|
|
1603
1817
|
#
|
|
1604
1818
|
# @!attribute [rw] next_token
|
|
1605
|
-
#
|
|
1606
|
-
#
|
|
1607
|
-
# returned in the current response.
|
|
1819
|
+
# Include this value in your next use of this API to get the next set
|
|
1820
|
+
# of service states.
|
|
1608
1821
|
# @return [String]
|
|
1609
1822
|
#
|
|
1610
1823
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListServiceStatesOutput AWS API Documentation
|
|
@@ -1912,23 +2125,23 @@ module Aws::ApplicationSignals
|
|
|
1912
2125
|
include Aws::Structure
|
|
1913
2126
|
end
|
|
1914
2127
|
|
|
1915
|
-
#
|
|
1916
|
-
#
|
|
2128
|
+
# A structure that contains metric data queries and time range
|
|
2129
|
+
# information that provides context for audit findings through relevant
|
|
2130
|
+
# performance metrics.
|
|
1917
2131
|
#
|
|
1918
2132
|
# @!attribute [rw] metric_data_queries
|
|
1919
|
-
# An array of metric data queries that define
|
|
1920
|
-
#
|
|
1921
|
-
# and time range.
|
|
2133
|
+
# An array of metric data queries that define the metrics to be
|
|
2134
|
+
# retrieved and analyzed as part of the audit finding context.
|
|
1922
2135
|
# @return [Array<Types::MetricDataQuery>]
|
|
1923
2136
|
#
|
|
1924
2137
|
# @!attribute [rw] start_time
|
|
1925
|
-
# The start time for the metric data
|
|
1926
|
-
#
|
|
2138
|
+
# The start time for the metric data included in this graph. When used
|
|
2139
|
+
# in a raw HTTP Query API, it is formatted as epoch time in seconds.
|
|
1927
2140
|
# @return [Time]
|
|
1928
2141
|
#
|
|
1929
2142
|
# @!attribute [rw] end_time
|
|
1930
|
-
# The end time for the metric data
|
|
1931
|
-
#
|
|
2143
|
+
# The end time for the metric data included in this graph. When used
|
|
2144
|
+
# in a raw HTTP Query API, it is formatted as epoch time in seconds.
|
|
1932
2145
|
# @return [Time]
|
|
1933
2146
|
#
|
|
1934
2147
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/MetricGraph AWS API Documentation
|
|
@@ -2073,41 +2286,39 @@ module Aws::ApplicationSignals
|
|
|
2073
2286
|
class Unknown < MonitoredRequestCountMetricDataQueries; end
|
|
2074
2287
|
end
|
|
2075
2288
|
|
|
2076
|
-
#
|
|
2077
|
-
# service or
|
|
2289
|
+
# A structure that represents a node in a dependency graph, containing
|
|
2290
|
+
# information about a service, resource, or other entity and its
|
|
2291
|
+
# characteristics.
|
|
2078
2292
|
#
|
|
2079
2293
|
# @!attribute [rw] key_attributes
|
|
2080
|
-
#
|
|
2081
|
-
#
|
|
2294
|
+
# The key attributes that identify this node, including Type, Name,
|
|
2295
|
+
# and Environment information.
|
|
2082
2296
|
# @return [Hash<String,String>]
|
|
2083
2297
|
#
|
|
2084
2298
|
# @!attribute [rw] name
|
|
2085
|
-
# The
|
|
2086
|
-
# name.
|
|
2299
|
+
# The name of the entity represented by this node.
|
|
2087
2300
|
# @return [String]
|
|
2088
2301
|
#
|
|
2089
2302
|
# @!attribute [rw] node_id
|
|
2090
|
-
# A unique identifier for
|
|
2303
|
+
# A unique identifier for this node within the dependency graph.
|
|
2091
2304
|
# @return [String]
|
|
2092
2305
|
#
|
|
2093
2306
|
# @!attribute [rw] operation
|
|
2094
|
-
# The
|
|
2095
|
-
# represents, if applicable.
|
|
2307
|
+
# The operation associated with this node, if applicable.
|
|
2096
2308
|
# @return [String]
|
|
2097
2309
|
#
|
|
2098
2310
|
# @!attribute [rw] type
|
|
2099
|
-
# The type of node, such as
|
|
2100
|
-
#
|
|
2311
|
+
# The type of entity represented by this node, such as `Service` or
|
|
2312
|
+
# `Resource`.
|
|
2101
2313
|
# @return [String]
|
|
2102
2314
|
#
|
|
2103
2315
|
# @!attribute [rw] duration
|
|
2104
|
-
# The
|
|
2105
|
-
#
|
|
2316
|
+
# The duration or processing time associated with this node, if
|
|
2317
|
+
# applicable.
|
|
2106
2318
|
# @return [Float]
|
|
2107
2319
|
#
|
|
2108
2320
|
# @!attribute [rw] status
|
|
2109
|
-
# The
|
|
2110
|
-
# "Warning", or "Critical".
|
|
2321
|
+
# The status of the entity represented by this node.
|
|
2111
2322
|
# @return [String]
|
|
2112
2323
|
#
|
|
2113
2324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/Node AWS API Documentation
|
|
@@ -2126,8 +2337,9 @@ module Aws::ApplicationSignals
|
|
|
2126
2337
|
|
|
2127
2338
|
# @!attribute [rw] grouping_attribute_definitions
|
|
2128
2339
|
# An array of grouping attribute definitions that specify how services
|
|
2129
|
-
# should be grouped. Each definition includes
|
|
2130
|
-
#
|
|
2340
|
+
# should be grouped. Each definition includes a friendly name, source
|
|
2341
|
+
# keys to derive the grouping value from, and an optional default
|
|
2342
|
+
# value.
|
|
2131
2343
|
# @return [Array<Types::GroupingAttributeDefinition>]
|
|
2132
2344
|
#
|
|
2133
2345
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/PutGroupingConfigurationInput AWS API Documentation
|
|
@@ -2139,8 +2351,9 @@ module Aws::ApplicationSignals
|
|
|
2139
2351
|
end
|
|
2140
2352
|
|
|
2141
2353
|
# @!attribute [rw] grouping_configuration
|
|
2142
|
-
#
|
|
2143
|
-
# attribute definitions and
|
|
2354
|
+
# A structure containing the updated grouping configuration, including
|
|
2355
|
+
# all grouping attribute definitions and the timestamp when it was
|
|
2356
|
+
# last updated.
|
|
2144
2357
|
# @return [Types::GroupingConfiguration]
|
|
2145
2358
|
#
|
|
2146
2359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/PutGroupingConfigurationOutput AWS API Documentation
|
|
@@ -2492,7 +2705,7 @@ module Aws::ApplicationSignals
|
|
|
2492
2705
|
#
|
|
2493
2706
|
# @!attribute [rw] service_groups
|
|
2494
2707
|
# An array of service groups that this service belongs to, based on
|
|
2495
|
-
# the configured grouping
|
|
2708
|
+
# the configured grouping attributes.
|
|
2496
2709
|
# @return [Array<Types::ServiceGroup>]
|
|
2497
2710
|
#
|
|
2498
2711
|
# @!attribute [rw] metric_references
|
|
@@ -2627,24 +2840,24 @@ module Aws::ApplicationSignals
|
|
|
2627
2840
|
include Aws::Structure
|
|
2628
2841
|
end
|
|
2629
2842
|
|
|
2630
|
-
#
|
|
2843
|
+
# A structure that contains identifying information for a service
|
|
2844
|
+
# entity.
|
|
2631
2845
|
#
|
|
2632
2846
|
# @!attribute [rw] type
|
|
2633
|
-
# The type of service
|
|
2634
|
-
# "Queue", or "Function".
|
|
2847
|
+
# The type of the service entity.
|
|
2635
2848
|
# @return [String]
|
|
2636
2849
|
#
|
|
2637
2850
|
# @!attribute [rw] name
|
|
2638
|
-
# The name of the service
|
|
2851
|
+
# The name of the service.
|
|
2639
2852
|
# @return [String]
|
|
2640
2853
|
#
|
|
2641
2854
|
# @!attribute [rw] environment
|
|
2642
|
-
# The environment where the service is deployed
|
|
2643
|
-
# "Production", "Staging", or "Development".
|
|
2855
|
+
# The environment where the service is deployed.
|
|
2644
2856
|
# @return [String]
|
|
2645
2857
|
#
|
|
2646
2858
|
# @!attribute [rw] aws_account_id
|
|
2647
|
-
# The
|
|
2859
|
+
# The Amazon Web Services account ID where the service is located.
|
|
2860
|
+
# Provide this value only for cross-account access.
|
|
2648
2861
|
# @return [String]
|
|
2649
2862
|
#
|
|
2650
2863
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceEntity AWS API Documentation
|
|
@@ -2658,26 +2871,27 @@ module Aws::ApplicationSignals
|
|
|
2658
2871
|
include Aws::Structure
|
|
2659
2872
|
end
|
|
2660
2873
|
|
|
2661
|
-
#
|
|
2662
|
-
# or
|
|
2874
|
+
# A structure that represents a logical grouping of services based on
|
|
2875
|
+
# shared attributes such as business unit, environment, or entry point.
|
|
2663
2876
|
#
|
|
2664
2877
|
# @!attribute [rw] group_name
|
|
2665
|
-
# The name of the
|
|
2666
|
-
#
|
|
2878
|
+
# The name of the grouping attribute, such as `BusinessUnit` or
|
|
2879
|
+
# `Environment`.
|
|
2667
2880
|
# @return [String]
|
|
2668
2881
|
#
|
|
2669
2882
|
# @!attribute [rw] group_value
|
|
2670
|
-
# The
|
|
2671
|
-
#
|
|
2883
|
+
# The value of the grouping attribute for this service, such as
|
|
2884
|
+
# `Payments` or `Production`.
|
|
2672
2885
|
# @return [String]
|
|
2673
2886
|
#
|
|
2674
2887
|
# @!attribute [rw] group_source
|
|
2675
|
-
# The source of the grouping
|
|
2676
|
-
#
|
|
2888
|
+
# The source of the grouping attribute, such as `TAG`, `OTEL`, or
|
|
2889
|
+
# `DEFAULT`.
|
|
2677
2890
|
# @return [String]
|
|
2678
2891
|
#
|
|
2679
2892
|
# @!attribute [rw] group_identifier
|
|
2680
|
-
# A unique identifier for
|
|
2893
|
+
# A unique identifier for this grouping attribute value, used for
|
|
2894
|
+
# filtering and API operations.
|
|
2681
2895
|
# @return [String]
|
|
2682
2896
|
#
|
|
2683
2897
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceGroup AWS API Documentation
|
|
@@ -2847,8 +3061,8 @@ module Aws::ApplicationSignals
|
|
|
2847
3061
|
# @return [String]
|
|
2848
3062
|
#
|
|
2849
3063
|
# @!attribute [rw] metric_name
|
|
2850
|
-
# The name of the CloudWatch metric
|
|
2851
|
-
#
|
|
3064
|
+
# The name of the CloudWatch metric to use for the SLO, when using a
|
|
3065
|
+
# custom metric rather than Application Signals standard metrics.
|
|
2852
3066
|
# @return [String]
|
|
2853
3067
|
#
|
|
2854
3068
|
# @!attribute [rw] statistic
|
|
@@ -3138,15 +3352,16 @@ module Aws::ApplicationSignals
|
|
|
3138
3352
|
include Aws::Structure
|
|
3139
3353
|
end
|
|
3140
3354
|
|
|
3141
|
-
#
|
|
3142
|
-
#
|
|
3355
|
+
# A structure that contains identifying information for a service level
|
|
3356
|
+
# objective entity.
|
|
3143
3357
|
#
|
|
3144
3358
|
# @!attribute [rw] slo_name
|
|
3145
|
-
# The name of the
|
|
3359
|
+
# The name of the service level objective.
|
|
3146
3360
|
# @return [String]
|
|
3147
3361
|
#
|
|
3148
3362
|
# @!attribute [rw] slo_arn
|
|
3149
|
-
# The
|
|
3363
|
+
# The ARN of the service level objective. The SLO must be provided
|
|
3364
|
+
# with ARN for cross-account access.
|
|
3150
3365
|
# @return [String]
|
|
3151
3366
|
#
|
|
3152
3367
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceLevelObjectiveEntity AWS API Documentation
|
|
@@ -3261,20 +3476,19 @@ module Aws::ApplicationSignals
|
|
|
3261
3476
|
include Aws::Structure
|
|
3262
3477
|
end
|
|
3263
3478
|
|
|
3264
|
-
#
|
|
3265
|
-
#
|
|
3479
|
+
# A structure that contains identifying information for a service
|
|
3480
|
+
# operation entity.
|
|
3266
3481
|
#
|
|
3267
3482
|
# @!attribute [rw] service
|
|
3268
3483
|
# The service entity that contains this operation.
|
|
3269
3484
|
# @return [Types::ServiceEntity]
|
|
3270
3485
|
#
|
|
3271
3486
|
# @!attribute [rw] operation
|
|
3272
|
-
# The name of the
|
|
3487
|
+
# The name of the operation.
|
|
3273
3488
|
# @return [String]
|
|
3274
3489
|
#
|
|
3275
3490
|
# @!attribute [rw] metric_type
|
|
3276
|
-
# The type of metric associated with this service operation
|
|
3277
|
-
# "Latency", "ErrorRate", or "Throughput".
|
|
3491
|
+
# The type of metric associated with this service operation.
|
|
3278
3492
|
# @return [String]
|
|
3279
3493
|
#
|
|
3280
3494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceOperationEntity AWS API Documentation
|
|
@@ -3300,21 +3514,24 @@ module Aws::ApplicationSignals
|
|
|
3300
3514
|
include Aws::Structure
|
|
3301
3515
|
end
|
|
3302
3516
|
|
|
3303
|
-
#
|
|
3304
|
-
#
|
|
3517
|
+
# A structure that contains information about the current state of a
|
|
3518
|
+
# service, including its latest change events such as deployments and
|
|
3519
|
+
# other state-changing activities.
|
|
3305
3520
|
#
|
|
3306
3521
|
# @!attribute [rw] attribute_filters
|
|
3307
3522
|
# The attribute filters that were applied when retrieving this service
|
|
3308
|
-
# state.
|
|
3523
|
+
# state information.
|
|
3309
3524
|
# @return [Array<Types::AttributeFilter>]
|
|
3310
3525
|
#
|
|
3311
3526
|
# @!attribute [rw] service
|
|
3312
|
-
# The
|
|
3527
|
+
# The key attributes that identify this service, including Type, Name,
|
|
3528
|
+
# and Environment information.
|
|
3313
3529
|
# @return [Hash<String,String>]
|
|
3314
3530
|
#
|
|
3315
3531
|
# @!attribute [rw] latest_change_events
|
|
3316
|
-
# An array
|
|
3317
|
-
#
|
|
3532
|
+
# An array containing the most recent change events for this service,
|
|
3533
|
+
# such as deployments, with information about when they occurred and
|
|
3534
|
+
# who initiated them.
|
|
3318
3535
|
# @return [Array<Types::ChangeEvent>]
|
|
3319
3536
|
#
|
|
3320
3537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceState AWS API Documentation
|
|
@@ -3412,8 +3629,8 @@ module Aws::ApplicationSignals
|
|
|
3412
3629
|
# @return [Array<Types::MetricReference>]
|
|
3413
3630
|
#
|
|
3414
3631
|
# @!attribute [rw] service_groups
|
|
3415
|
-
# An array of service groups that this service belongs to,
|
|
3416
|
-
#
|
|
3632
|
+
# An array of service groups that this service belongs to, based on
|
|
3633
|
+
# the configured grouping attributes.
|
|
3417
3634
|
# @return [Array<Types::ServiceGroup>]
|
|
3418
3635
|
#
|
|
3419
3636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceSummary AWS API Documentation
|