aws-sdk-applicationsignals 1.30.0 → 1.31.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.
@@ -23,19 +23,18 @@ module Aws::ApplicationSignals
23
23
  include Aws::Structure
24
24
  end
25
25
 
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.
26
+ # Represents a filter for service attributes. Used to narrow down
27
+ # results based on specific attribute names and values.
29
28
  #
30
29
  # @!attribute [rw] attribute_filter_name
31
- # The name of the attribute to filter by, such as `Platform`,
32
- # `Environment`, or `BusinessUnit`.
30
+ # The name of the attribute to filter on. This corresponds to service
31
+ # metadata attributes such as environment, team, or custom tags.
33
32
  # @return [String]
34
33
  #
35
34
  # @!attribute [rw] attribute_filter_values
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.
35
+ # An array of values to match against the specified attribute.
36
+ # Services with attribute values matching any of these values will be
37
+ # included in the results.
39
38
  # @return [Array<String>]
40
39
  #
41
40
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AttributeFilter AWS API Documentation
@@ -47,42 +46,40 @@ module Aws::ApplicationSignals
47
46
  include Aws::Structure
48
47
  end
49
48
 
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.
49
+ # Represents an audit finding that identifies a potential issue,
50
+ # misconfiguration, or compliance violation in Application Signals
51
+ # resources.
54
52
  #
55
53
  # @!attribute [rw] key_attributes
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.
54
+ # A map of key attributes that identify the resource associated with
55
+ # this audit finding. These attributes help locate and understand the
56
+ # context of the finding.
59
57
  # @return [Hash<String,String>]
60
58
  #
61
59
  # @!attribute [rw] auditor_results
62
- # An array of auditor results that contain the specific findings,
63
- # descriptions, and severity levels identified by different auditing
64
- # algorithms.
60
+ # An array of results from different auditors that examined the
61
+ # resource. Each result includes the auditor name, description, and
62
+ # severity level.
65
63
  # @return [Array<Types::AuditorResult>]
66
64
  #
67
65
  # @!attribute [rw] operation
68
- # The name of the operation associated with this audit finding, if the
69
- # finding is specific to a particular service operation.
66
+ # The operation or action that was being audited when this finding was
67
+ # discovered. This provides context about what was being examined.
70
68
  # @return [String]
71
69
  #
72
70
  # @!attribute [rw] metric_graph
73
- # A structure containing metric data queries and time range
74
- # information that provides context for the audit finding through
75
- # relevant performance metrics.
71
+ # A metric graph associated with the audit finding, showing relevant
72
+ # performance data that may be related to the identified issue.
76
73
  # @return [Types::MetricGraph]
77
74
  #
78
75
  # @!attribute [rw] dependency_graph
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.
76
+ # A dependency graph showing the relationships between services that
77
+ # may be affected by or related to the audit finding.
82
78
  # @return [Types::DependencyGraph]
83
79
  #
84
80
  # @!attribute [rw] type
85
- # The type of audit finding.
81
+ # The type or category of the audit finding, such as "Performance",
82
+ # "Security", or "Configuration".
86
83
  # @return [String]
87
84
  #
88
85
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AuditFinding AWS API Documentation
@@ -98,16 +95,17 @@ module Aws::ApplicationSignals
98
95
  include Aws::Structure
99
96
  end
100
97
 
101
- # A structure that specifies the target entity for audit analysis, such
102
- # as a `service`, `SLO`, or `service_operation`.
98
+ # Specifies a target resource for auditing, such as a service, SLO, or
99
+ # operation.
103
100
  #
104
101
  # @!attribute [rw] type
105
- # The type of entity being audited, such as `Service`, `SLO`, or
106
- # `ServiceOperation`.
102
+ # The type of resource being targeted for audit, such as "Service",
103
+ # "SLO", "ServiceOperation", or "Canary".
107
104
  # @return [String]
108
105
  #
109
106
  # @!attribute [rw] data
110
- # The specific data identifying the audit target entity.
107
+ # The specific data or entity information for the audit target,
108
+ # containing details needed to identify and examine the resource.
111
109
  # @return [Types::AuditTargetEntity]
112
110
  #
113
111
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AuditTarget AWS API Documentation
@@ -119,8 +117,8 @@ module Aws::ApplicationSignals
119
117
  include Aws::Structure
120
118
  end
121
119
 
122
- # A union structure that contains the specific entity information for
123
- # different types of audit targets.
120
+ # A union type that represents different types of entities that can be
121
+ # audited, such as services, SLOs, service operations, or canaries.
124
122
  #
125
123
  # @note AuditTargetEntity is a union - when making an API calls you must set exactly one of the members.
126
124
  #
@@ -129,21 +127,27 @@ module Aws::ApplicationSignals
129
127
  # @return [Types::ServiceEntity]
130
128
  #
131
129
  # @!attribute [rw] slo
132
- # SLO entity information when the audit target is a service level
133
- # objective.
130
+ # Service Level Objective entity information when the audit target is
131
+ # an SLO.
134
132
  # @return [Types::ServiceLevelObjectiveEntity]
135
133
  #
136
134
  # @!attribute [rw] service_operation
137
135
  # Service operation entity information when the audit target is a
138
- # specific service operation.
136
+ # specific operation within a service.
139
137
  # @return [Types::ServiceOperationEntity]
140
138
  #
139
+ # @!attribute [rw] canary
140
+ # Canary entity information when the audit target is a CloudWatch
141
+ # Synthetics canary.
142
+ # @return [Types::CanaryEntity]
143
+ #
141
144
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AuditTargetEntity AWS API Documentation
142
145
  #
143
146
  class AuditTargetEntity < Struct.new(
144
147
  :service,
145
148
  :slo,
146
149
  :service_operation,
150
+ :canary,
147
151
  :unknown)
148
152
  SENSITIVE = []
149
153
  include Aws::Structure
@@ -152,25 +156,26 @@ module Aws::ApplicationSignals
152
156
  class Service < AuditTargetEntity; end
153
157
  class Slo < AuditTargetEntity; end
154
158
  class ServiceOperation < AuditTargetEntity; end
159
+ class Canary < AuditTargetEntity; end
155
160
  class Unknown < AuditTargetEntity; end
156
161
  end
157
162
 
158
- # A structure that contains the result of an automated audit analysis,
159
- # including the auditor name, description of findings, and severity
160
- # level.
163
+ # Represents the result of an audit performed by a specific auditor on a
164
+ # resource.
161
165
  #
162
166
  # @!attribute [rw] auditor
163
- # The name of the auditor algorithm that generated this result.
167
+ # The name or identifier of the auditor that performed the examination
168
+ # and generated this result.
164
169
  # @return [String]
165
170
  #
166
171
  # @!attribute [rw] description
167
- # A detailed description of the audit finding, explaining what was
168
- # observed and potential implications.
172
+ # A detailed description of what the auditor found, including any
173
+ # recommendations for remediation or further investigation.
169
174
  # @return [String]
170
175
  #
171
176
  # @!attribute [rw] severity
172
- # The severity level of this audit finding, indicating the importance
173
- # and potential impact of the issue.
177
+ # The severity level of the finding, such as "Critical", "High",
178
+ # "Medium", or "Low". This helps prioritize remediation efforts.
174
179
  # @return [String]
175
180
  #
176
181
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/AuditorResult AWS API Documentation
@@ -359,41 +364,59 @@ module Aws::ApplicationSignals
359
364
  include Aws::Structure
360
365
  end
361
366
 
362
- # A structure that contains information about a change event that
363
- # occurred for a service, such as a deployment or configuration change.
367
+ # Represents a CloudWatch Synthetics canary that can be audited for
368
+ # performance and configuration issues.
369
+ #
370
+ # @!attribute [rw] canary_name
371
+ # The name of the CloudWatch Synthetics canary.
372
+ # @return [String]
373
+ #
374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/CanaryEntity AWS API Documentation
375
+ #
376
+ class CanaryEntity < Struct.new(
377
+ :canary_name)
378
+ SENSITIVE = []
379
+ include Aws::Structure
380
+ end
381
+
382
+ # Represents a change event that occurred in the system, such as
383
+ # deployments, configuration changes, or other operational events that
384
+ # may impact service performance.
364
385
  #
365
386
  # @!attribute [rw] timestamp
366
- # The timestamp when this change event occurred. When used in a raw
367
- # HTTP Query API, it is formatted as epoch time in seconds.
387
+ # The timestamp when the change event occurred, expressed as the
388
+ # number of milliseconds since January 1, 1970, 00:00:00 UTC.
368
389
  # @return [Time]
369
390
  #
370
391
  # @!attribute [rw] account_id
371
- # The Amazon Web Services account ID where this change event occurred.
392
+ # The AWS account ID where the change event occurred.
372
393
  # @return [String]
373
394
  #
374
395
  # @!attribute [rw] region
375
- # The Amazon Web Services region where this change event occurred.
396
+ # The AWS region where the change event occurred.
376
397
  # @return [String]
377
398
  #
378
399
  # @!attribute [rw] entity
379
- # The entity (service or resource) that was affected by this change
380
- # event, including its key attributes.
400
+ # The entity or resource that was changed, such as a service,
401
+ # deployment, or configuration.
381
402
  # @return [Hash<String,String>]
382
403
  #
383
404
  # @!attribute [rw] change_event_type
384
- # The type of change event that occurred, such as `DEPLOYMENT`.
405
+ # The type of change that occurred, such as "Deployment",
406
+ # "Configuration", or "Infrastructure".
385
407
  # @return [String]
386
408
  #
387
409
  # @!attribute [rw] event_id
388
- # A unique identifier for this change event.
410
+ # A unique identifier for the change event.
389
411
  # @return [String]
390
412
  #
391
413
  # @!attribute [rw] user_name
392
- # The name of the user who initiated this change event, if available.
414
+ # The name of the user or system that initiated the change event.
393
415
  # @return [String]
394
416
  #
395
417
  # @!attribute [rw] event_name
396
- # The name or description of this change event.
418
+ # A descriptive name for the change event that provides context about
419
+ # what changed.
397
420
  # @return [String]
398
421
  #
399
422
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ChangeEvent AWS API Documentation
@@ -562,18 +585,17 @@ module Aws::ApplicationSignals
562
585
  include Aws::Structure
563
586
  end
564
587
 
565
- # A structure that represents the dependency relationships relevant to
566
- # an audit finding, containing nodes and edges that show how services
567
- # and resources are connected.
588
+ # Represents a graph showing the dependencies between services and
589
+ # components in your application architecture.
568
590
  #
569
591
  # @!attribute [rw] nodes
570
- # An array of nodes representing the services, resources, or other
571
- # entities in the dependency graph.
592
+ # An array of nodes in the dependency graph, where each node
593
+ # represents a service or component.
572
594
  # @return [Array<Types::Node>]
573
595
  #
574
596
  # @!attribute [rw] edges
575
- # An array of edges representing the connections and relationships
576
- # between the nodes in the dependency graph.
597
+ # An array of edges in the dependency graph, where each edge
598
+ # represents a connection or dependency between two nodes.
577
599
  # @return [Array<Types::Edge>]
578
600
  #
579
601
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/DependencyGraph AWS API Documentation
@@ -617,26 +639,26 @@ module Aws::ApplicationSignals
617
639
  include Aws::Structure
618
640
  end
619
641
 
620
- # A structure that represents a connection between two nodes in a
621
- # dependency graph, showing the relationship and characteristics of the
622
- # connection.
642
+ # Represents a connection between two nodes in a dependency graph,
643
+ # showing how services or components interact with each other.
623
644
  #
624
645
  # @!attribute [rw] source_node_id
625
- # The identifier of the source node in this edge connection.
646
+ # The identifier of the source node in the dependency relationship.
626
647
  # @return [String]
627
648
  #
628
649
  # @!attribute [rw] destination_node_id
629
- # The identifier of the destination node in this edge connection.
650
+ # The identifier of the destination node in the dependency
651
+ # relationship.
630
652
  # @return [String]
631
653
  #
632
654
  # @!attribute [rw] duration
633
- # The duration or latency associated with this connection, if
634
- # applicable.
655
+ # The typical duration or latency of interactions along this edge,
656
+ # measured in milliseconds.
635
657
  # @return [Float]
636
658
  #
637
659
  # @!attribute [rw] connection_type
638
- # The type of connection between the nodes, indicating the nature of
639
- # the relationship.
660
+ # The type of connection between the nodes, such as "HTTP",
661
+ # "Database", "Queue", or "Internal".
640
662
  # @return [String]
641
663
  #
642
664
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/Edge AWS API Documentation
@@ -855,27 +877,25 @@ module Aws::ApplicationSignals
855
877
  include Aws::Structure
856
878
  end
857
879
 
858
- # A structure that defines how services should be grouped based on
859
- # specific attributes. This includes the friendly name for the grouping,
860
- # the source keys to derive values from, and an optional default value.
880
+ # Defines how services should be grouped based on specific attributes.
881
+ # This allows logical organization of services in dashboards and service
882
+ # maps.
861
883
  #
862
884
  # @!attribute [rw] grouping_name
863
- # The friendly name for this grouping attribute, such as
864
- # `BusinessUnit` or `Environment`. This name is used to identify the
865
- # grouping in the console and APIs.
885
+ # The name of the grouping attribute, such as "Environment",
886
+ # "Team", or "Application".
866
887
  # @return [String]
867
888
  #
868
889
  # @!attribute [rw] grouping_source_keys
869
- # An array of source keys used to derive the grouping attribute value
870
- # from telemetry data, Amazon Web Services tags, or other sources. For
871
- # example, \["business\_unit", "team"\] would look for values in
872
- # those fields.
890
+ # An array of source attribute keys that will be used to determine the
891
+ # grouping value for each service. These keys correspond to service
892
+ # metadata or tags.
873
893
  # @return [Array<String>]
874
894
  #
875
895
  # @!attribute [rw] default_grouping_value
876
- # The default value to use for this grouping attribute when no value
877
- # can be derived from the source keys. This ensures all services have
878
- # a grouping value even if the source data is missing.
896
+ # The default value to use for grouping when a service doesn't have
897
+ # any of the specified source keys, such as "Unknown" or
898
+ # "Unassigned".
879
899
  # @return [String]
880
900
  #
881
901
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/GroupingAttributeDefinition AWS API Documentation
@@ -888,19 +908,18 @@ module Aws::ApplicationSignals
888
908
  include Aws::Structure
889
909
  end
890
910
 
891
- # A structure that contains the complete grouping configuration for an
892
- # account, including all defined grouping attributes and metadata about
893
- # when it was last updated.
911
+ # Contains the complete configuration for how services are grouped and
912
+ # organized in Application Signals.
894
913
  #
895
914
  # @!attribute [rw] grouping_attribute_definitions
896
- # An array of grouping attribute definitions that specify how services
897
- # should be grouped based on various attributes and source keys.
915
+ # An array of grouping attribute definitions that specify the rules
916
+ # for organizing services into groups.
898
917
  # @return [Array<Types::GroupingAttributeDefinition>]
899
918
  #
900
919
  # @!attribute [rw] updated_at
901
- # The timestamp when this grouping configuration was last updated.
902
- # When used in a raw HTTP Query API, it is formatted as epoch time in
903
- # seconds.
920
+ # The timestamp when the grouping configuration was last updated,
921
+ # expressed as the number of milliseconds since January 1, 1970,
922
+ # 00:00:00 UTC.
904
923
  # @return [Time]
905
924
  #
906
925
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/GroupingConfiguration AWS API Documentation
@@ -945,69 +964,38 @@ module Aws::ApplicationSignals
945
964
  end
946
965
 
947
966
  # @!attribute [rw] start_time
948
- # The start of the time period to retrieve audit findings for. When
949
- # used in a raw HTTP Query API, it is formatted as epoch time in
950
- # seconds. For example, `1698778057`
967
+ # The start time for the audit findings query. Only findings created
968
+ # on or after this time will be included in the results. Specify the
969
+ # time as the number of milliseconds since January 1, 1970, 00:00:00
970
+ # UTC.
951
971
  # @return [Time]
952
972
  #
953
973
  # @!attribute [rw] end_time
954
- # The end of the time period to retrieve audit findings for. When used
955
- # in a raw HTTP Query API, it is formatted as epoch time in seconds.
956
- # For example, `1698778057`
974
+ # The end time for the audit findings query. Only findings created
975
+ # before this time will be included in the results. Specify the time
976
+ # as the number of milliseconds since January 1, 1970, 00:00:00 UTC.
957
977
  # @return [Time]
958
978
  #
959
979
  # @!attribute [rw] auditors
960
- # A list of auditor names to filter the findings by. Only findings
961
- # generated by the specified auditors will be returned.
962
- #
963
- # The following auditors are available for configuration:
964
- #
965
- # * `slo` - SloAuditor: Identifies SLO violations and detects breached
966
- # thresholds during the Assessment phase.
967
- #
968
- # * `operation_metric` - OperationMetricAuditor: Detects anomalies in
969
- # service operation metrics from Application Signals RED metrics
970
- # during the Assessment phase
971
- #
972
- # * `service_quota` - ServiceQuotaAuditor: Monitors resource
973
- # utilization against service quotas during the Assessment phase
974
- #
975
- # * `trace` - TraceAuditor: Performs deep-dive analysis of distributed
976
- # traces, correlating traces with breached SLOs or abnormal RED
977
- # metrics during the Analysis phase
978
- #
979
- # * `dependency_metric` - CriticalPathAuditor: Analyzes service
980
- # dependency impacts and maps dependency relationships from
981
- # Application Signals RED metrics during the Analysis phase
982
- #
983
- # * `top_contributor` - TopContributorAuditor: Identifies
984
- # infrastructure-level contributors to issues by analyzing EMF logs
985
- # of Application Signals RED metrics during the Analysis phase
986
- #
987
- # * `log` - LogAuditor: Extracts insights from application logs,
988
- # categorizing error types and ranking severity by frequency during
989
- # the Analysis phase
990
- #
991
- # <note markdown="1"> `InitAuditor` and `Summarizer` auditors are not configurable as they
992
- # are automatically triggered during the audit process.
993
- #
994
- # </note>
980
+ # An array of auditor names to filter the findings. Only findings
981
+ # generated by the specified auditors will be returned. When not
982
+ # specified, findings from all auditors are included except canary.
995
983
  # @return [Array<String>]
996
984
  #
997
985
  # @!attribute [rw] audit_targets
998
- # A list of audit targets to filter the findings by. You can specify
999
- # services, SLOs, or service operations to limit the audit findings to
1000
- # specific entities.
986
+ # An array of audit target specifications to filter the findings. Only
987
+ # findings related to the specified targets (such as specific
988
+ # services, SLOs, operations or canary) will be returned.
1001
989
  # @return [Array<Types::AuditTarget>]
1002
990
  #
1003
991
  # @!attribute [rw] next_token
1004
- # Include this value, if it was returned by the previous operation, to
1005
- # get the next set of audit findings.
992
+ # The token for the next set of results. Use this token to retrieve
993
+ # additional pages of audit findings when the result set is large.
1006
994
  # @return [String]
1007
995
  #
1008
996
  # @!attribute [rw] max_results
1009
- # The maximum number of audit findings to return in one operation. If
1010
- # you omit this parameter, the default of 10 is used.
997
+ # The maximum number of audit findings to return in a single request.
998
+ # Valid range is 1 to 100. If not specified, defaults to 50.
1011
999
  # @return [Integer]
1012
1000
  #
1013
1001
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListAuditFindingsInput AWS API Documentation
@@ -1024,14 +1012,15 @@ module Aws::ApplicationSignals
1024
1012
  end
1025
1013
 
1026
1014
  # @!attribute [rw] audit_findings
1027
- # An array of structures, where each structure contains information
1028
- # about one audit finding, including the auditor results, severity,
1029
- # and associated metric and dependency graphs.
1015
+ # An array of audit findings that match the specified criteria. Each
1016
+ # finding includes details about the issue, affected resources, and
1017
+ # auditor results.
1030
1018
  # @return [Array<Types::AuditFinding>]
1031
1019
  #
1032
1020
  # @!attribute [rw] next_token
1033
- # Include this value in your next use of this API to get the next set
1034
- # of audit findings.
1021
+ # The token to use for retrieving the next page of results. This value
1022
+ # is present only if there are more results available than were
1023
+ # returned in the current response.
1035
1024
  # @return [String]
1036
1025
  #
1037
1026
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListAuditFindingsOutput AWS API Documentation
@@ -1044,8 +1033,9 @@ module Aws::ApplicationSignals
1044
1033
  end
1045
1034
 
1046
1035
  # @!attribute [rw] next_token
1047
- # Include this value, if it was returned by the previous operation, to
1048
- # get the next set of grouping attribute definitions.
1036
+ # The token for the next set of results. Use this token to retrieve
1037
+ # additional pages of grouping attribute definitions when the result
1038
+ # set is large.
1049
1039
  # @return [String]
1050
1040
  #
1051
1041
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListGroupingAttributeDefinitionsInput AWS API Documentation
@@ -1057,20 +1047,20 @@ module Aws::ApplicationSignals
1057
1047
  end
1058
1048
 
1059
1049
  # @!attribute [rw] grouping_attribute_definitions
1060
- # An array of structures, where each structure contains information
1061
- # about one grouping attribute definition, including the grouping
1062
- # name, source keys, and default values.
1050
+ # An array of available grouping attribute definitions that can be
1051
+ # used to create grouping configurations.
1063
1052
  # @return [Array<Types::GroupingAttributeDefinition>]
1064
1053
  #
1065
1054
  # @!attribute [rw] updated_at
1066
- # The timestamp when the grouping configuration was last updated. When
1067
- # used in a raw HTTP Query API, it is formatted as epoch time in
1068
- # seconds.
1055
+ # The timestamp when the grouping attribute definitions were last
1056
+ # updated. Expressed as the number of milliseconds since January 1,
1057
+ # 1970, 00:00:00 UTC.
1069
1058
  # @return [Time]
1070
1059
  #
1071
1060
  # @!attribute [rw] next_token
1072
- # Include this value in your next use of this API to get the next set
1073
- # of grouping attribute definitions.
1061
+ # The token to use for retrieving the next page of results. This value
1062
+ # is present only if there are more results available than were
1063
+ # returned in the current response.
1074
1064
  # @return [String]
1075
1065
  #
1076
1066
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListGroupingAttributeDefinitionsOutput AWS API Documentation
@@ -1541,41 +1531,44 @@ module Aws::ApplicationSignals
1541
1531
  end
1542
1532
 
1543
1533
  # @!attribute [rw] start_time
1544
- # The start of the time period to retrieve service state information
1545
- # for. When used in a raw HTTP Query API, it is formatted as epoch
1546
- # time in seconds. For example, `1698778057`.
1534
+ # The start time for the service states query. Only service states
1535
+ # from this time onward will be included. Specify the time as the
1536
+ # number of milliseconds since January 1, 1970, 00:00:00 UTC.
1547
1537
  # @return [Time]
1548
1538
  #
1549
1539
  # @!attribute [rw] end_time
1550
- # The end of the time period to retrieve service state information
1551
- # for. When used in a raw HTTP Query API, it is formatted as epoch
1552
- # time in seconds. For example, `1698778057`.
1540
+ # The end time for the service states query. Only service states
1541
+ # before this time will be included. Specify the time as the number of
1542
+ # milliseconds since January 1, 1970, 00:00:00 UTC.
1553
1543
  # @return [Time]
1554
1544
  #
1555
1545
  # @!attribute [rw] max_results
1556
- # The maximum number of service states to return in one operation. If
1557
- # you omit this parameter, the default of 20 is used.
1546
+ # The maximum number of service states to return in a single request.
1547
+ # Valid range is 1 to 100. If not specified, defaults to 50.
1558
1548
  # @return [Integer]
1559
1549
  #
1560
1550
  # @!attribute [rw] next_token
1561
- # Include this value, if it was returned by the previous operation, to
1562
- # get the next set of service states.
1551
+ # The token for the next set of results. Use this token to retrieve
1552
+ # additional pages of service states when the result set is large.
1563
1553
  # @return [String]
1564
1554
  #
1565
1555
  # @!attribute [rw] include_linked_accounts
1566
- # If you are using this operation in a monitoring account, specify
1567
- # `true` to include service states from source accounts in the
1568
- # returned data.
1556
+ # Specifies whether to include service states from linked AWS accounts
1557
+ # in the results. Set to `true` to include linked accounts, or `false`
1558
+ # to only include the current account. Defaults to `false`.
1569
1559
  # @return [Boolean]
1570
1560
  #
1571
1561
  # @!attribute [rw] aws_account_id
1572
- # The Amazon Web Services account ID to filter service states by. Use
1573
- # this to limit results to services from a specific account.
1562
+ # The AWS account ID to filter service states. If specified, only
1563
+ # service states from this account will be returned. If not specified,
1564
+ # service states from the current account (and linked accounts if
1565
+ # enabled) are returned.
1574
1566
  # @return [String]
1575
1567
  #
1576
1568
  # @!attribute [rw] attribute_filters
1577
- # A list of attribute filters to narrow down the services. You can
1578
- # filter by platform, environment, or other service attributes.
1569
+ # An array of attribute filters to narrow down the service states
1570
+ # returned. Each filter specifies an attribute name and the values to
1571
+ # match against.
1579
1572
  # @return [Array<Types::AttributeFilter>]
1580
1573
  #
1581
1574
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListServiceStatesInput AWS API Documentation
@@ -1593,26 +1586,25 @@ module Aws::ApplicationSignals
1593
1586
  end
1594
1587
 
1595
1588
  # @!attribute [rw] start_time
1596
- # The start of the time period that the returned information applies
1597
- # to. When used in a raw HTTP Query API, it is formatted as epoch time
1598
- # in seconds. For example, `1698778057`.
1589
+ # The start time of the query range, expressed as the number of
1590
+ # milliseconds since January 1, 1970, 00:00:00 UTC.
1599
1591
  # @return [Time]
1600
1592
  #
1601
1593
  # @!attribute [rw] end_time
1602
- # The end of the time period that the returned information applies to.
1603
- # When used in a raw HTTP Query API, it is formatted as epoch time in
1604
- # seconds. For example, `1698778057`.
1594
+ # The end time of the query range, expressed as the number of
1595
+ # milliseconds since January 1, 1970, 00:00:00 UTC.
1605
1596
  # @return [Time]
1606
1597
  #
1607
1598
  # @!attribute [rw] service_states
1608
- # An array of structures, where each structure contains information
1609
- # about the state of one service, including its latest change events
1610
- # such as deployments.
1599
+ # An array of service state objects that match the specified criteria.
1600
+ # Each service state includes current status, recent change events,
1601
+ # and service metadata.
1611
1602
  # @return [Array<Types::ServiceState>]
1612
1603
  #
1613
1604
  # @!attribute [rw] next_token
1614
- # Include this value in your next use of this API to get the next set
1615
- # of service states.
1605
+ # The token to use for retrieving the next page of results. This value
1606
+ # is present only if there are more results available than were
1607
+ # returned in the current response.
1616
1608
  # @return [String]
1617
1609
  #
1618
1610
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ListServiceStatesOutput AWS API Documentation
@@ -1920,23 +1912,23 @@ module Aws::ApplicationSignals
1920
1912
  include Aws::Structure
1921
1913
  end
1922
1914
 
1923
- # A structure that contains metric data queries and time range
1924
- # information that provides context for audit findings through relevant
1925
- # performance metrics.
1915
+ # Represents a graph of metric data over time, showing performance
1916
+ # trends and patterns for monitored resources.
1926
1917
  #
1927
1918
  # @!attribute [rw] metric_data_queries
1928
- # An array of metric data queries that define the metrics to be
1929
- # retrieved and analyzed as part of the audit finding context.
1919
+ # An array of metric data queries that define what metrics to display
1920
+ # in the graph. Each query specifies the metric source, aggregation,
1921
+ # and time range.
1930
1922
  # @return [Array<Types::MetricDataQuery>]
1931
1923
  #
1932
1924
  # @!attribute [rw] start_time
1933
- # The start time for the metric data included in this graph. When used
1934
- # in a raw HTTP Query API, it is formatted as epoch time in seconds.
1925
+ # The start time for the metric data displayed in the graph, expressed
1926
+ # as the number of milliseconds since January 1, 1970, 00:00:00 UTC.
1935
1927
  # @return [Time]
1936
1928
  #
1937
1929
  # @!attribute [rw] end_time
1938
- # The end time for the metric data included in this graph. When used
1939
- # in a raw HTTP Query API, it is formatted as epoch time in seconds.
1930
+ # The end time for the metric data displayed in the graph, expressed
1931
+ # as the number of milliseconds since January 1, 1970, 00:00:00 UTC.
1940
1932
  # @return [Time]
1941
1933
  #
1942
1934
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/MetricGraph AWS API Documentation
@@ -2081,39 +2073,41 @@ module Aws::ApplicationSignals
2081
2073
  class Unknown < MonitoredRequestCountMetricDataQueries; end
2082
2074
  end
2083
2075
 
2084
- # A structure that represents a node in a dependency graph, containing
2085
- # information about a service, resource, or other entity and its
2086
- # characteristics.
2076
+ # Represents a node in a dependency graph, typically corresponding to a
2077
+ # service or component in your application architecture.
2087
2078
  #
2088
2079
  # @!attribute [rw] key_attributes
2089
- # The key attributes that identify this node, including Type, Name,
2090
- # and Environment information.
2080
+ # A map of key attributes that identify and describe the node, such as
2081
+ # service name, environment, and other metadata.
2091
2082
  # @return [Hash<String,String>]
2092
2083
  #
2093
2084
  # @!attribute [rw] name
2094
- # The name of the entity represented by this node.
2085
+ # The display name of the node, typically the service or component
2086
+ # name.
2095
2087
  # @return [String]
2096
2088
  #
2097
2089
  # @!attribute [rw] node_id
2098
- # A unique identifier for this node within the dependency graph.
2090
+ # A unique identifier for the node within the dependency graph.
2099
2091
  # @return [String]
2100
2092
  #
2101
2093
  # @!attribute [rw] operation
2102
- # The operation associated with this node, if applicable.
2094
+ # The specific operation or endpoint within the service that this node
2095
+ # represents, if applicable.
2103
2096
  # @return [String]
2104
2097
  #
2105
2098
  # @!attribute [rw] type
2106
- # The type of entity represented by this node, such as `Service` or
2107
- # `Resource`.
2099
+ # The type of node, such as "Service", "Database", "Queue", or
2100
+ # "External".
2108
2101
  # @return [String]
2109
2102
  #
2110
2103
  # @!attribute [rw] duration
2111
- # The duration or processing time associated with this node, if
2112
- # applicable.
2104
+ # The typical response time or processing duration for this node,
2105
+ # measured in milliseconds.
2113
2106
  # @return [Float]
2114
2107
  #
2115
2108
  # @!attribute [rw] status
2116
- # The status of the entity represented by this node.
2109
+ # The current health status of the node, such as "Healthy",
2110
+ # "Warning", or "Critical".
2117
2111
  # @return [String]
2118
2112
  #
2119
2113
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/Node AWS API Documentation
@@ -2132,9 +2126,8 @@ module Aws::ApplicationSignals
2132
2126
 
2133
2127
  # @!attribute [rw] grouping_attribute_definitions
2134
2128
  # An array of grouping attribute definitions that specify how services
2135
- # should be grouped. Each definition includes a friendly name, source
2136
- # keys to derive the grouping value from, and an optional default
2137
- # value.
2129
+ # should be grouped. Each definition includes the grouping name,
2130
+ # source keys, and default values.
2138
2131
  # @return [Array<Types::GroupingAttributeDefinition>]
2139
2132
  #
2140
2133
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/PutGroupingConfigurationInput AWS API Documentation
@@ -2146,9 +2139,8 @@ module Aws::ApplicationSignals
2146
2139
  end
2147
2140
 
2148
2141
  # @!attribute [rw] grouping_configuration
2149
- # A structure containing the updated grouping configuration, including
2150
- # all grouping attribute definitions and the timestamp when it was
2151
- # last updated.
2142
+ # The created or updated grouping configuration, including all
2143
+ # attribute definitions and metadata such as the update timestamp.
2152
2144
  # @return [Types::GroupingConfiguration]
2153
2145
  #
2154
2146
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/PutGroupingConfigurationOutput AWS API Documentation
@@ -2500,7 +2492,7 @@ module Aws::ApplicationSignals
2500
2492
  #
2501
2493
  # @!attribute [rw] service_groups
2502
2494
  # An array of service groups that this service belongs to, based on
2503
- # the configured grouping attributes.
2495
+ # the configured grouping rules.
2504
2496
  # @return [Array<Types::ServiceGroup>]
2505
2497
  #
2506
2498
  # @!attribute [rw] metric_references
@@ -2635,24 +2627,24 @@ module Aws::ApplicationSignals
2635
2627
  include Aws::Structure
2636
2628
  end
2637
2629
 
2638
- # A structure that contains identifying information for a service
2639
- # entity.
2630
+ # Represents a service entity that is monitored by Application Signals.
2640
2631
  #
2641
2632
  # @!attribute [rw] type
2642
- # The type of the service entity.
2633
+ # The type of service, such as "WebService", "Database",
2634
+ # "Queue", or "Function".
2643
2635
  # @return [String]
2644
2636
  #
2645
2637
  # @!attribute [rw] name
2646
- # The name of the service.
2638
+ # The name of the service as identified by Application Signals.
2647
2639
  # @return [String]
2648
2640
  #
2649
2641
  # @!attribute [rw] environment
2650
- # The environment where the service is deployed.
2642
+ # The environment where the service is deployed, such as
2643
+ # "Production", "Staging", or "Development".
2651
2644
  # @return [String]
2652
2645
  #
2653
2646
  # @!attribute [rw] aws_account_id
2654
- # The Amazon Web Services account ID where the service is located.
2655
- # Provide this value only for cross-account access.
2647
+ # The AWS account ID where the service is deployed.
2656
2648
  # @return [String]
2657
2649
  #
2658
2650
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceEntity AWS API Documentation
@@ -2666,27 +2658,26 @@ module Aws::ApplicationSignals
2666
2658
  include Aws::Structure
2667
2659
  end
2668
2660
 
2669
- # A structure that represents a logical grouping of services based on
2670
- # shared attributes such as business unit, environment, or entry point.
2661
+ # Represents a logical grouping of services based on shared attributes
2662
+ # or characteristics.
2671
2663
  #
2672
2664
  # @!attribute [rw] group_name
2673
- # The name of the grouping attribute, such as `BusinessUnit` or
2674
- # `Environment`.
2665
+ # The name of the group, such as "Environment", "Team", or
2666
+ # "Application".
2675
2667
  # @return [String]
2676
2668
  #
2677
2669
  # @!attribute [rw] group_value
2678
- # The value of the grouping attribute for this service, such as
2679
- # `Payments` or `Production`.
2670
+ # The specific value for this group, such as "Production",
2671
+ # "TeamA", or "WebApp".
2680
2672
  # @return [String]
2681
2673
  #
2682
2674
  # @!attribute [rw] group_source
2683
- # The source of the grouping attribute, such as `TAG`, `OTEL`, or
2684
- # `DEFAULT`.
2675
+ # The source of the grouping information, such as "Tag",
2676
+ # "Attribute", or "Manual".
2685
2677
  # @return [String]
2686
2678
  #
2687
2679
  # @!attribute [rw] group_identifier
2688
- # A unique identifier for this grouping attribute value, used for
2689
- # filtering and API operations.
2680
+ # A unique identifier for the group within the grouping configuration.
2690
2681
  # @return [String]
2691
2682
  #
2692
2683
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceGroup AWS API Documentation
@@ -2856,8 +2847,8 @@ module Aws::ApplicationSignals
2856
2847
  # @return [String]
2857
2848
  #
2858
2849
  # @!attribute [rw] metric_name
2859
- # The name of the CloudWatch metric to use for the SLO, when using a
2860
- # custom metric rather than Application Signals standard metrics.
2850
+ # The name of the CloudWatch metric used as a service level indicator
2851
+ # (SLI) for measuring service performance.
2861
2852
  # @return [String]
2862
2853
  #
2863
2854
  # @!attribute [rw] statistic
@@ -3147,16 +3138,15 @@ module Aws::ApplicationSignals
3147
3138
  include Aws::Structure
3148
3139
  end
3149
3140
 
3150
- # A structure that contains identifying information for a service level
3151
- # objective entity.
3141
+ # Represents a Service Level Objective (SLO) entity that can be audited
3142
+ # for compliance and performance.
3152
3143
  #
3153
3144
  # @!attribute [rw] slo_name
3154
- # The name of the service level objective.
3145
+ # The name of the Service Level Objective.
3155
3146
  # @return [String]
3156
3147
  #
3157
3148
  # @!attribute [rw] slo_arn
3158
- # The ARN of the service level objective. The SLO must be provided
3159
- # with ARN for cross-account access.
3149
+ # The Amazon Resource Name (ARN) of the Service Level Objective.
3160
3150
  # @return [String]
3161
3151
  #
3162
3152
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceLevelObjectiveEntity AWS API Documentation
@@ -3271,19 +3261,20 @@ module Aws::ApplicationSignals
3271
3261
  include Aws::Structure
3272
3262
  end
3273
3263
 
3274
- # A structure that contains identifying information for a service
3275
- # operation entity.
3264
+ # Represents a specific operation within a service that can be monitored
3265
+ # and audited independently.
3276
3266
  #
3277
3267
  # @!attribute [rw] service
3278
3268
  # The service entity that contains this operation.
3279
3269
  # @return [Types::ServiceEntity]
3280
3270
  #
3281
3271
  # @!attribute [rw] operation
3282
- # The name of the operation.
3272
+ # The name of the specific operation within the service.
3283
3273
  # @return [String]
3284
3274
  #
3285
3275
  # @!attribute [rw] metric_type
3286
- # The type of metric associated with this service operation.
3276
+ # The type of metric associated with this service operation, such as
3277
+ # "Latency", "ErrorRate", or "Throughput".
3287
3278
  # @return [String]
3288
3279
  #
3289
3280
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceOperationEntity AWS API Documentation
@@ -3309,24 +3300,21 @@ module Aws::ApplicationSignals
3309
3300
  include Aws::Structure
3310
3301
  end
3311
3302
 
3312
- # A structure that contains information about the current state of a
3313
- # service, including its latest change events such as deployments and
3314
- # other state-changing activities.
3303
+ # Represents the current state and health information for a service
3304
+ # monitored by Application Signals.
3315
3305
  #
3316
3306
  # @!attribute [rw] attribute_filters
3317
3307
  # The attribute filters that were applied when retrieving this service
3318
- # state information.
3308
+ # state.
3319
3309
  # @return [Array<Types::AttributeFilter>]
3320
3310
  #
3321
3311
  # @!attribute [rw] service
3322
- # The key attributes that identify this service, including Type, Name,
3323
- # and Environment information.
3312
+ # The service entity information for this service state.
3324
3313
  # @return [Hash<String,String>]
3325
3314
  #
3326
3315
  # @!attribute [rw] latest_change_events
3327
- # An array containing the most recent change events for this service,
3328
- # such as deployments, with information about when they occurred and
3329
- # who initiated them.
3316
+ # An array of the most recent change events that may have affected
3317
+ # this service, such as deployments or configuration changes.
3330
3318
  # @return [Array<Types::ChangeEvent>]
3331
3319
  #
3332
3320
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceState AWS API Documentation
@@ -3424,8 +3412,8 @@ module Aws::ApplicationSignals
3424
3412
  # @return [Array<Types::MetricReference>]
3425
3413
  #
3426
3414
  # @!attribute [rw] service_groups
3427
- # An array of service groups that this service belongs to, based on
3428
- # the configured grouping attributes.
3415
+ # An array of service groups that this service belongs to, providing a
3416
+ # summary view of the service's organizational context.
3429
3417
  # @return [Array<Types::ServiceGroup>]
3430
3418
  #
3431
3419
  # @see http://docs.aws.amazon.com/goto/WebAPI/application-signals-2024-04-15/ServiceSummary AWS API Documentation