@aws-sdk/client-application-signals 3.936.0 → 3.937.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.
- package/README.md +8 -0
- package/dist-cjs/index.js +95 -4
- package/dist-es/ApplicationSignals.js +2 -0
- package/dist-es/commands/ListEntityEventsCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/enums.js +5 -0
- package/dist-es/pagination/ListEntityEventsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +73 -4
- package/dist-types/ApplicationSignals.d.ts +7 -0
- package/dist-types/ApplicationSignalsClient.d.ts +3 -2
- package/dist-types/commands/DeleteGroupingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/ListAuditFindingsCommand.d.ts +7 -1
- package/dist-types/commands/ListEntityEventsCommand.d.ts +102 -0
- package/dist-types/commands/ListGroupingAttributeDefinitionsCommand.d.ts +3 -1
- package/dist-types/commands/ListServiceStatesCommand.d.ts +2 -2
- package/dist-types/commands/PutGroupingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/StartDiscoveryCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +13 -0
- package/dist-types/models/models_0.d.ts +228 -143
- package/dist-types/pagination/ListEntityEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +5 -0
- package/dist-types/ts3.4/ApplicationSignals.d.ts +17 -0
- package/dist-types/ts3.4/ApplicationSignalsClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/ListEntityEventsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +30 -10
- package/dist-types/ts3.4/pagination/ListEntityEventsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +5 -0
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ChangeEventType, ConnectionType, DurationUnit, EvaluationType, MetricSourceType, ServiceLevelIndicatorComparisonOperator, ServiceLevelIndicatorMetricType, ServiceLevelObjectiveBudgetStatus, Severity, StandardUnit } from "./enums";
|
|
1
|
+
import { ChangeEventType, ConnectionType, DetailLevel, DurationUnit, EvaluationType, MetricSourceType, ServiceLevelIndicatorComparisonOperator, ServiceLevelIndicatorMetricType, ServiceLevelObjectiveBudgetStatus, Severity, StandardUnit } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* @public
|
|
4
4
|
*/
|
|
@@ -669,27 +669,27 @@ export interface MetricReference {
|
|
|
669
669
|
AccountId?: string | undefined;
|
|
670
670
|
}
|
|
671
671
|
/**
|
|
672
|
-
* <p>
|
|
672
|
+
* <p>A structure that represents a logical grouping of services based on shared attributes such as business unit, environment, or entry point.</p>
|
|
673
673
|
* @public
|
|
674
674
|
*/
|
|
675
675
|
export interface ServiceGroup {
|
|
676
676
|
/**
|
|
677
|
-
* <p>The name of the
|
|
677
|
+
* <p>The name of the grouping attribute, such as <code>BusinessUnit</code> or <code>Environment</code>.</p>
|
|
678
678
|
* @public
|
|
679
679
|
*/
|
|
680
680
|
GroupName: string | undefined;
|
|
681
681
|
/**
|
|
682
|
-
* <p>The
|
|
682
|
+
* <p>The value of the grouping attribute for this service, such as <code>Payments</code> or <code>Production</code>.</p>
|
|
683
683
|
* @public
|
|
684
684
|
*/
|
|
685
685
|
GroupValue: string | undefined;
|
|
686
686
|
/**
|
|
687
|
-
* <p>The source of the grouping
|
|
687
|
+
* <p>The source of the grouping attribute, such as <code>TAG</code>, <code>OTEL</code>, or <code>DEFAULT</code>.</p>
|
|
688
688
|
* @public
|
|
689
689
|
*/
|
|
690
690
|
GroupSource: string | undefined;
|
|
691
691
|
/**
|
|
692
|
-
* <p>A unique identifier for
|
|
692
|
+
* <p>A unique identifier for this grouping attribute value, used for filtering and API operations.</p>
|
|
693
693
|
* @public
|
|
694
694
|
*/
|
|
695
695
|
GroupIdentifier: string | undefined;
|
|
@@ -710,7 +710,7 @@ export interface Service {
|
|
|
710
710
|
*/
|
|
711
711
|
AttributeMaps?: Record<string, string>[] | undefined;
|
|
712
712
|
/**
|
|
713
|
-
* <p>An array of service groups that this service belongs to, based on the configured grouping
|
|
713
|
+
* <p>An array of service groups that this service belongs to, based on the configured grouping attributes.</p>
|
|
714
714
|
* @public
|
|
715
715
|
*/
|
|
716
716
|
ServiceGroups?: ServiceGroup[] | undefined;
|
|
@@ -751,7 +751,7 @@ export interface GetServiceOutput {
|
|
|
751
751
|
LogGroupReferences?: Record<string, string>[] | undefined;
|
|
752
752
|
}
|
|
753
753
|
/**
|
|
754
|
-
* <p>
|
|
754
|
+
* <p>A structure that contains identifying information for a CloudWatch Synthetics canary entity used in audit targeting.</p>
|
|
755
755
|
* @public
|
|
756
756
|
*/
|
|
757
757
|
export interface CanaryEntity {
|
|
@@ -762,33 +762,33 @@ export interface CanaryEntity {
|
|
|
762
762
|
CanaryName: string | undefined;
|
|
763
763
|
}
|
|
764
764
|
/**
|
|
765
|
-
* <p>
|
|
765
|
+
* <p>A structure that contains identifying information for a service entity.</p>
|
|
766
766
|
* @public
|
|
767
767
|
*/
|
|
768
768
|
export interface ServiceEntity {
|
|
769
769
|
/**
|
|
770
|
-
* <p>The type of service
|
|
770
|
+
* <p>The type of the service entity.</p>
|
|
771
771
|
* @public
|
|
772
772
|
*/
|
|
773
773
|
Type?: string | undefined;
|
|
774
774
|
/**
|
|
775
|
-
* <p>The name of the service
|
|
775
|
+
* <p>The name of the service.</p>
|
|
776
776
|
* @public
|
|
777
777
|
*/
|
|
778
778
|
Name?: string | undefined;
|
|
779
779
|
/**
|
|
780
|
-
* <p>The environment where the service is deployed
|
|
780
|
+
* <p>The environment where the service is deployed.</p>
|
|
781
781
|
* @public
|
|
782
782
|
*/
|
|
783
783
|
Environment?: string | undefined;
|
|
784
784
|
/**
|
|
785
|
-
* <p>The
|
|
785
|
+
* <p>The Amazon Web Services account ID where the service is located. Provide this value only for cross-account access.</p>
|
|
786
786
|
* @public
|
|
787
787
|
*/
|
|
788
788
|
AwsAccountId?: string | undefined;
|
|
789
789
|
}
|
|
790
790
|
/**
|
|
791
|
-
* <p>
|
|
791
|
+
* <p>A structure that contains identifying information for a service operation entity.</p>
|
|
792
792
|
* @public
|
|
793
793
|
*/
|
|
794
794
|
export interface ServiceOperationEntity {
|
|
@@ -798,34 +798,34 @@ export interface ServiceOperationEntity {
|
|
|
798
798
|
*/
|
|
799
799
|
Service?: ServiceEntity | undefined;
|
|
800
800
|
/**
|
|
801
|
-
* <p>The name of the
|
|
801
|
+
* <p>The name of the operation.</p>
|
|
802
802
|
* @public
|
|
803
803
|
*/
|
|
804
804
|
Operation?: string | undefined;
|
|
805
805
|
/**
|
|
806
|
-
* <p>The type of metric associated with this service operation
|
|
806
|
+
* <p>The type of metric associated with this service operation.</p>
|
|
807
807
|
* @public
|
|
808
808
|
*/
|
|
809
809
|
MetricType?: string | undefined;
|
|
810
810
|
}
|
|
811
811
|
/**
|
|
812
|
-
* <p>
|
|
812
|
+
* <p>A structure that contains identifying information for a service level objective entity.</p>
|
|
813
813
|
* @public
|
|
814
814
|
*/
|
|
815
815
|
export interface ServiceLevelObjectiveEntity {
|
|
816
816
|
/**
|
|
817
|
-
* <p>The name of the
|
|
817
|
+
* <p>The name of the service level objective.</p>
|
|
818
818
|
* @public
|
|
819
819
|
*/
|
|
820
820
|
SloName?: string | undefined;
|
|
821
821
|
/**
|
|
822
|
-
* <p>The
|
|
822
|
+
* <p>The ARN of the service level objective. The SLO must be provided with ARN for cross-account access.</p>
|
|
823
823
|
* @public
|
|
824
824
|
*/
|
|
825
825
|
SloArn?: string | undefined;
|
|
826
826
|
}
|
|
827
827
|
/**
|
|
828
|
-
* <p>A union
|
|
828
|
+
* <p>A union structure that contains the specific entity information for different types of audit targets.</p>
|
|
829
829
|
* @public
|
|
830
830
|
*/
|
|
831
831
|
export type AuditTargetEntity = AuditTargetEntity.CanaryMember | AuditTargetEntity.ServiceMember | AuditTargetEntity.ServiceOperationMember | AuditTargetEntity.SloMember | AuditTargetEntity.$UnknownMember;
|
|
@@ -845,7 +845,7 @@ export declare namespace AuditTargetEntity {
|
|
|
845
845
|
$unknown?: never;
|
|
846
846
|
}
|
|
847
847
|
/**
|
|
848
|
-
* <p>
|
|
848
|
+
* <p>SLO entity information when the audit target is a service level objective.</p>
|
|
849
849
|
* @public
|
|
850
850
|
*/
|
|
851
851
|
interface SloMember {
|
|
@@ -856,7 +856,7 @@ export declare namespace AuditTargetEntity {
|
|
|
856
856
|
$unknown?: never;
|
|
857
857
|
}
|
|
858
858
|
/**
|
|
859
|
-
* <p>Service operation entity information when the audit target is a specific operation
|
|
859
|
+
* <p>Service operation entity information when the audit target is a specific service operation.</p>
|
|
860
860
|
* @public
|
|
861
861
|
*/
|
|
862
862
|
interface ServiceOperationMember {
|
|
@@ -900,17 +900,17 @@ export declare namespace AuditTargetEntity {
|
|
|
900
900
|
}
|
|
901
901
|
}
|
|
902
902
|
/**
|
|
903
|
-
* <p>
|
|
903
|
+
* <p>A structure that specifies the target entity for audit analysis, such as a <code>service</code>, <code>SLO</code>, <code>service_operation</code>, or <code>canary</code>.</p>
|
|
904
904
|
* @public
|
|
905
905
|
*/
|
|
906
906
|
export interface AuditTarget {
|
|
907
907
|
/**
|
|
908
|
-
* <p>The type of
|
|
908
|
+
* <p>The type of entity being audited, such as <code>service</code>, <code>SLO</code>, <code>service_operation</code>, or <code>canary</code>. </p>
|
|
909
909
|
* @public
|
|
910
910
|
*/
|
|
911
911
|
Type: string | undefined;
|
|
912
912
|
/**
|
|
913
|
-
* <p>The specific data
|
|
913
|
+
* <p>The specific data identifying the audit target entity.</p>
|
|
914
914
|
* @public
|
|
915
915
|
*/
|
|
916
916
|
Data: AuditTargetEntity | undefined;
|
|
@@ -920,193 +920,203 @@ export interface AuditTarget {
|
|
|
920
920
|
*/
|
|
921
921
|
export interface ListAuditFindingsInput {
|
|
922
922
|
/**
|
|
923
|
-
* <p>The start time
|
|
923
|
+
* <p>The start of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code> </p>
|
|
924
924
|
* @public
|
|
925
925
|
*/
|
|
926
926
|
StartTime: Date | undefined;
|
|
927
927
|
/**
|
|
928
|
-
* <p>The end time
|
|
928
|
+
* <p>The end of the time period to retrieve audit findings for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code> </p>
|
|
929
929
|
* @public
|
|
930
930
|
*/
|
|
931
931
|
EndTime: Date | undefined;
|
|
932
932
|
/**
|
|
933
|
-
* <p>
|
|
933
|
+
* <p>A list of auditor names to filter the findings by. Only findings generated by the specified auditors will be returned.</p> <p>The following auditors are available for configuration:</p> <ul> <li> <p> <code>slo</code> - SloAuditor: Identifies SLO violations and detects breached thresholds during the Assessment phase.</p> </li> <li> <p> <code>operation_metric</code> - OperationMetricAuditor: Detects anomalies in service operation metrics from Application Signals RED metrics during the Assessment phase</p> <note> <p>Anomaly detection is not supported for sparse metrics (those missing more than 80% of datapoints within the given time period).</p> </note> </li> <li> <p> <code>service_quota</code> - ServiceQuotaAuditor: Monitors resource utilization against service quotas during the Assessment phase</p> </li> <li> <p> <code>trace</code> - TraceAuditor: Performs deep-dive analysis of distributed traces, correlating traces with breached SLOs or abnormal RED metrics during the Analysis phase</p> </li> <li> <p> <code>dependency_metric</code> - CriticalPathAuditor: Analyzes service dependency impacts and maps dependency relationships from Application Signals RED metrics during the Analysis phase</p> </li> <li> <p> <code>top_contributor</code> - TopContributorAuditor: Identifies infrastructure-level contributors to issues by analyzing EMF logs of Application Signals RED metrics during the Analysis phase</p> </li> <li> <p> <code>log</code> - LogAuditor: Extracts insights from application logs, categorizing error types and ranking severity by frequency during the Analysis phase</p> </li> </ul> <note> <p> <code>InitAuditor</code> and <code>Summarizer</code> auditors are not configurable as they are automatically triggered during the audit process.</p> </note>
|
|
934
934
|
* @public
|
|
935
935
|
*/
|
|
936
936
|
Auditors?: string[] | undefined;
|
|
937
937
|
/**
|
|
938
|
-
* <p>
|
|
938
|
+
* <p>A list of audit targets to filter the findings by. You can specify services, SLOs, or service operations to limit the audit findings to specific entities.</p>
|
|
939
939
|
* @public
|
|
940
940
|
*/
|
|
941
941
|
AuditTargets: AuditTarget[] | undefined;
|
|
942
942
|
/**
|
|
943
|
-
* <p>The
|
|
943
|
+
* <p>The level of details of the audit findings. Supported values: <code>BRIEF</code>, <code>DETAILED</code>.</p>
|
|
944
|
+
* @public
|
|
945
|
+
*/
|
|
946
|
+
DetailLevel?: DetailLevel | undefined;
|
|
947
|
+
/**
|
|
948
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of audit findings.</p>
|
|
944
949
|
* @public
|
|
945
950
|
*/
|
|
946
951
|
NextToken?: string | undefined;
|
|
947
952
|
/**
|
|
948
|
-
* <p>The maximum number of audit findings to return in
|
|
953
|
+
* <p>The maximum number of audit findings to return in one operation. If you omit this parameter, the default of 10 is used.</p>
|
|
949
954
|
* @public
|
|
950
955
|
*/
|
|
951
956
|
MaxResults?: number | undefined;
|
|
952
957
|
}
|
|
953
958
|
/**
|
|
954
|
-
* <p>
|
|
959
|
+
* <p>A structure that contains the result of an automated audit analysis, including the auditor name, description of findings, additional data, and severity level.</p>
|
|
955
960
|
* @public
|
|
956
961
|
*/
|
|
957
962
|
export interface AuditorResult {
|
|
958
963
|
/**
|
|
959
|
-
* <p>The name
|
|
964
|
+
* <p>The name of the auditor algorithm that generated this result.</p>
|
|
960
965
|
* @public
|
|
961
966
|
*/
|
|
962
967
|
Auditor?: string | undefined;
|
|
963
968
|
/**
|
|
964
|
-
* <p>A detailed description of
|
|
969
|
+
* <p>A detailed description of the audit finding, explaining what was observed and potential implications.</p>
|
|
965
970
|
* @public
|
|
966
971
|
*/
|
|
967
972
|
Description?: string | undefined;
|
|
968
973
|
/**
|
|
969
|
-
* <p>
|
|
974
|
+
* <p>This is a string-to-string map. It contains additional data about the result of an automated audit analysis.</p>
|
|
975
|
+
* @public
|
|
976
|
+
*/
|
|
977
|
+
Data?: Record<string, string> | undefined;
|
|
978
|
+
/**
|
|
979
|
+
* <p>The severity level of this audit finding, indicating the importance and potential impact of the issue.</p>
|
|
970
980
|
* @public
|
|
971
981
|
*/
|
|
972
982
|
Severity?: Severity | undefined;
|
|
973
983
|
}
|
|
974
984
|
/**
|
|
975
|
-
* <p>
|
|
985
|
+
* <p>A structure that represents a connection between two nodes in a dependency graph, showing the relationship and characteristics of the connection.</p>
|
|
976
986
|
* @public
|
|
977
987
|
*/
|
|
978
988
|
export interface Edge {
|
|
979
989
|
/**
|
|
980
|
-
* <p>The identifier of the source node in
|
|
990
|
+
* <p>The identifier of the source node in this edge connection.</p>
|
|
981
991
|
* @public
|
|
982
992
|
*/
|
|
983
993
|
SourceNodeId?: string | undefined;
|
|
984
994
|
/**
|
|
985
|
-
* <p>The identifier of the destination node in
|
|
995
|
+
* <p>The identifier of the destination node in this edge connection.</p>
|
|
986
996
|
* @public
|
|
987
997
|
*/
|
|
988
998
|
DestinationNodeId?: string | undefined;
|
|
989
999
|
/**
|
|
990
|
-
* <p>The
|
|
1000
|
+
* <p>The duration or latency associated with this connection, if applicable.</p>
|
|
991
1001
|
* @public
|
|
992
1002
|
*/
|
|
993
1003
|
Duration?: number | undefined;
|
|
994
1004
|
/**
|
|
995
|
-
* <p>The type of connection between the nodes,
|
|
1005
|
+
* <p>The type of connection between the nodes, indicating the nature of the relationship.</p>
|
|
996
1006
|
* @public
|
|
997
1007
|
*/
|
|
998
1008
|
ConnectionType?: ConnectionType | undefined;
|
|
999
1009
|
}
|
|
1000
1010
|
/**
|
|
1001
|
-
* <p>
|
|
1011
|
+
* <p>A structure that represents a node in a dependency graph, containing information about a service, resource, or other entity and its characteristics.</p>
|
|
1002
1012
|
* @public
|
|
1003
1013
|
*/
|
|
1004
1014
|
export interface Node {
|
|
1005
1015
|
/**
|
|
1006
|
-
* <p>
|
|
1016
|
+
* <p>The key attributes that identify this node, including Type, Name, and Environment information.</p>
|
|
1007
1017
|
* @public
|
|
1008
1018
|
*/
|
|
1009
1019
|
KeyAttributes: Record<string, string> | undefined;
|
|
1010
1020
|
/**
|
|
1011
|
-
* <p>The
|
|
1021
|
+
* <p>The name of the entity represented by this node.</p>
|
|
1012
1022
|
* @public
|
|
1013
1023
|
*/
|
|
1014
1024
|
Name: string | undefined;
|
|
1015
1025
|
/**
|
|
1016
|
-
* <p>A unique identifier for
|
|
1026
|
+
* <p>A unique identifier for this node within the dependency graph.</p>
|
|
1017
1027
|
* @public
|
|
1018
1028
|
*/
|
|
1019
1029
|
NodeId: string | undefined;
|
|
1020
1030
|
/**
|
|
1021
|
-
* <p>The
|
|
1031
|
+
* <p>The operation associated with this node, if applicable.</p>
|
|
1022
1032
|
* @public
|
|
1023
1033
|
*/
|
|
1024
1034
|
Operation?: string | undefined;
|
|
1025
1035
|
/**
|
|
1026
|
-
* <p>The type of node, such as
|
|
1036
|
+
* <p>The type of entity represented by this node, such as <code>Service</code> or <code>Resource</code>.</p>
|
|
1027
1037
|
* @public
|
|
1028
1038
|
*/
|
|
1029
1039
|
Type?: string | undefined;
|
|
1030
1040
|
/**
|
|
1031
|
-
* <p>The
|
|
1041
|
+
* <p>The duration or processing time associated with this node, if applicable.</p>
|
|
1032
1042
|
* @public
|
|
1033
1043
|
*/
|
|
1034
1044
|
Duration?: number | undefined;
|
|
1035
1045
|
/**
|
|
1036
|
-
* <p>The
|
|
1046
|
+
* <p>The status of the entity represented by this node.</p>
|
|
1037
1047
|
* @public
|
|
1038
1048
|
*/
|
|
1039
1049
|
Status?: string | undefined;
|
|
1040
1050
|
}
|
|
1041
1051
|
/**
|
|
1042
|
-
* <p>
|
|
1052
|
+
* <p>A structure that represents the dependency relationships relevant to an audit finding, containing nodes and edges that show how services and resources are connected.</p>
|
|
1043
1053
|
* @public
|
|
1044
1054
|
*/
|
|
1045
1055
|
export interface DependencyGraph {
|
|
1046
1056
|
/**
|
|
1047
|
-
* <p>An array of nodes
|
|
1057
|
+
* <p>An array of nodes representing the services, resources, or other entities in the dependency graph.</p>
|
|
1048
1058
|
* @public
|
|
1049
1059
|
*/
|
|
1050
1060
|
Nodes?: Node[] | undefined;
|
|
1051
1061
|
/**
|
|
1052
|
-
* <p>An array of edges
|
|
1062
|
+
* <p>An array of edges representing the connections and relationships between the nodes in the dependency graph.</p>
|
|
1053
1063
|
* @public
|
|
1054
1064
|
*/
|
|
1055
1065
|
Edges?: Edge[] | undefined;
|
|
1056
1066
|
}
|
|
1057
1067
|
/**
|
|
1058
|
-
* <p>
|
|
1068
|
+
* <p>A structure that contains metric data queries and time range information that provides context for audit findings through relevant performance metrics.</p>
|
|
1059
1069
|
* @public
|
|
1060
1070
|
*/
|
|
1061
1071
|
export interface MetricGraph {
|
|
1062
1072
|
/**
|
|
1063
|
-
* <p>An array of metric data queries that define
|
|
1073
|
+
* <p>An array of metric data queries that define the metrics to be retrieved and analyzed as part of the audit finding context.</p>
|
|
1064
1074
|
* @public
|
|
1065
1075
|
*/
|
|
1066
1076
|
MetricDataQueries?: MetricDataQuery[] | undefined;
|
|
1067
1077
|
/**
|
|
1068
|
-
* <p>The start time for the metric data
|
|
1078
|
+
* <p>The start time for the metric data included in this graph. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1069
1079
|
* @public
|
|
1070
1080
|
*/
|
|
1071
1081
|
StartTime?: Date | undefined;
|
|
1072
1082
|
/**
|
|
1073
|
-
* <p>The end time for the metric data
|
|
1083
|
+
* <p>The end time for the metric data included in this graph. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1074
1084
|
* @public
|
|
1075
1085
|
*/
|
|
1076
1086
|
EndTime?: Date | undefined;
|
|
1077
1087
|
}
|
|
1078
1088
|
/**
|
|
1079
|
-
* <p>
|
|
1089
|
+
* <p>A structure that contains information about an audit finding, which represents an automated analysis result about service behavior, performance issues, or potential problems identified through heuristic algorithms.</p>
|
|
1080
1090
|
* @public
|
|
1081
1091
|
*/
|
|
1082
1092
|
export interface AuditFinding {
|
|
1083
1093
|
/**
|
|
1084
|
-
* <p>
|
|
1094
|
+
* <p>The key attributes that identify the service or entity this audit finding relates to. This is a string-to-string map that includes fields like Type, Name, and Environment.</p>
|
|
1085
1095
|
* @public
|
|
1086
1096
|
*/
|
|
1087
1097
|
KeyAttributes: Record<string, string> | undefined;
|
|
1088
1098
|
/**
|
|
1089
|
-
* <p>An array of results
|
|
1099
|
+
* <p>An array of auditor results that contain the specific findings, descriptions, and severity levels identified by different auditing algorithms.</p>
|
|
1090
1100
|
* @public
|
|
1091
1101
|
*/
|
|
1092
1102
|
AuditorResults?: AuditorResult[] | undefined;
|
|
1093
1103
|
/**
|
|
1094
|
-
* <p>The
|
|
1104
|
+
* <p>The name of the operation associated with this audit finding, if the finding is specific to a particular service operation.</p>
|
|
1095
1105
|
* @public
|
|
1096
1106
|
*/
|
|
1097
1107
|
Operation?: string | undefined;
|
|
1098
1108
|
/**
|
|
1099
|
-
* <p>A metric
|
|
1109
|
+
* <p>A structure containing metric data queries and time range information that provides context for the audit finding through relevant performance metrics.</p>
|
|
1100
1110
|
* @public
|
|
1101
1111
|
*/
|
|
1102
1112
|
MetricGraph?: MetricGraph | undefined;
|
|
1103
1113
|
/**
|
|
1104
|
-
* <p>A
|
|
1114
|
+
* <p>A structure containing nodes and edges that represent the dependency relationships relevant to this audit finding, helping to understand the context and potential impact.</p>
|
|
1105
1115
|
* @public
|
|
1106
1116
|
*/
|
|
1107
1117
|
DependencyGraph?: DependencyGraph | undefined;
|
|
1108
1118
|
/**
|
|
1109
|
-
* <p>The type
|
|
1119
|
+
* <p>The type of audit finding.</p>
|
|
1110
1120
|
* @public
|
|
1111
1121
|
*/
|
|
1112
1122
|
Type?: string | undefined;
|
|
@@ -1116,12 +1126,123 @@ export interface AuditFinding {
|
|
|
1116
1126
|
*/
|
|
1117
1127
|
export interface ListAuditFindingsOutput {
|
|
1118
1128
|
/**
|
|
1119
|
-
* <p>
|
|
1129
|
+
* <p>The start of the time period that the returned audit findings apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code> </p>
|
|
1130
|
+
* @public
|
|
1131
|
+
*/
|
|
1132
|
+
StartTime?: Date | undefined;
|
|
1133
|
+
/**
|
|
1134
|
+
* <p>The end of the time period that the returned audit findings apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code> </p>
|
|
1135
|
+
* @public
|
|
1136
|
+
*/
|
|
1137
|
+
EndTime?: Date | undefined;
|
|
1138
|
+
/**
|
|
1139
|
+
* <p>An array of structures, where each structure contains information about one audit finding, including the auditor results, severity, and associated metric and dependency graphs.</p>
|
|
1120
1140
|
* @public
|
|
1121
1141
|
*/
|
|
1122
1142
|
AuditFindings: AuditFinding[] | undefined;
|
|
1123
1143
|
/**
|
|
1124
|
-
* <p>
|
|
1144
|
+
* <p>Include this value in your next use of this API to get the next set of audit findings.</p>
|
|
1145
|
+
* @public
|
|
1146
|
+
*/
|
|
1147
|
+
NextToken?: string | undefined;
|
|
1148
|
+
}
|
|
1149
|
+
/**
|
|
1150
|
+
* @public
|
|
1151
|
+
*/
|
|
1152
|
+
export interface ListEntityEventsInput {
|
|
1153
|
+
/**
|
|
1154
|
+
* <p>The entity for which to retrieve change events. This specifies the service, resource, or other entity whose event history you want to examine.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> <li> <p> <code>AwsAccountId</code> specifies the account where this object is in.</p> </li> </ul> <p>Below is an example of a service.</p> <p> <code>\{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" \}</code> </p> <p>Below is an example of a resource.</p> <p> <code>\{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" \}</code> </p>
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
Entity: Record<string, string> | undefined;
|
|
1158
|
+
/**
|
|
1159
|
+
* <p>The start of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: <code>1698778057</code> </p>
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
StartTime: Date | undefined;
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>The end of the time period to retrieve change events for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: <code>1698778057</code> </p>
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
EndTime: Date | undefined;
|
|
1168
|
+
/**
|
|
1169
|
+
* <p>The maximum number of change events to return in one operation. If you omit this parameter, the default of 50 is used.</p>
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
MaxResults?: number | undefined;
|
|
1173
|
+
/**
|
|
1174
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of change events.</p>
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
NextToken?: string | undefined;
|
|
1178
|
+
}
|
|
1179
|
+
/**
|
|
1180
|
+
* <p>A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change.</p>
|
|
1181
|
+
* @public
|
|
1182
|
+
*/
|
|
1183
|
+
export interface ChangeEvent {
|
|
1184
|
+
/**
|
|
1185
|
+
* <p>The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1186
|
+
* @public
|
|
1187
|
+
*/
|
|
1188
|
+
Timestamp: Date | undefined;
|
|
1189
|
+
/**
|
|
1190
|
+
* <p>The Amazon Web Services account ID where this change event occurred.</p>
|
|
1191
|
+
* @public
|
|
1192
|
+
*/
|
|
1193
|
+
AccountId: string | undefined;
|
|
1194
|
+
/**
|
|
1195
|
+
* <p>The Amazon Web Services region where this change event occurred.</p>
|
|
1196
|
+
* @public
|
|
1197
|
+
*/
|
|
1198
|
+
Region: string | undefined;
|
|
1199
|
+
/**
|
|
1200
|
+
* <p>The entity (service or resource) that was affected by this change event, including its key attributes.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> <li> <p> <code>AwsAccountId</code> specifies the account where this object is in.</p> </li> </ul> <p>Below is an example of a service.</p> <p> <code>\{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" \}</code> </p> <p>Below is an example of a resource.</p> <p> <code>\{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" \}</code> </p>
|
|
1201
|
+
* @public
|
|
1202
|
+
*/
|
|
1203
|
+
Entity: Record<string, string> | undefined;
|
|
1204
|
+
/**
|
|
1205
|
+
* <p>The type of change event that occurred, such as <code>DEPLOYMENT</code>.</p>
|
|
1206
|
+
* @public
|
|
1207
|
+
*/
|
|
1208
|
+
ChangeEventType: ChangeEventType | undefined;
|
|
1209
|
+
/**
|
|
1210
|
+
* <p>A unique identifier for this change event. For CloudTrail-based events, this is the CloudTrail event id. For other events, this will be <code>Unknown</code>.</p>
|
|
1211
|
+
* @public
|
|
1212
|
+
*/
|
|
1213
|
+
EventId: string | undefined;
|
|
1214
|
+
/**
|
|
1215
|
+
* <p>The name of the user who initiated this change event, if available.</p>
|
|
1216
|
+
* @public
|
|
1217
|
+
*/
|
|
1218
|
+
UserName?: string | undefined;
|
|
1219
|
+
/**
|
|
1220
|
+
* <p>The name or description of this change event.</p>
|
|
1221
|
+
* @public
|
|
1222
|
+
*/
|
|
1223
|
+
EventName?: string | undefined;
|
|
1224
|
+
}
|
|
1225
|
+
/**
|
|
1226
|
+
* @public
|
|
1227
|
+
*/
|
|
1228
|
+
export interface ListEntityEventsOutput {
|
|
1229
|
+
/**
|
|
1230
|
+
* <p>The start of the time period that the returned change events apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: <code>1698778057</code> </p>
|
|
1231
|
+
* @public
|
|
1232
|
+
*/
|
|
1233
|
+
StartTime: Date | undefined;
|
|
1234
|
+
/**
|
|
1235
|
+
* <p>The end of the time period that the returned change events apply to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example: <code>1698778057</code> </p>
|
|
1236
|
+
* @public
|
|
1237
|
+
*/
|
|
1238
|
+
EndTime: Date | undefined;
|
|
1239
|
+
/**
|
|
1240
|
+
* <p>An array of structures, where each structure contains information about one change event that occurred for the specified entity during the requested time period.</p>
|
|
1241
|
+
* @public
|
|
1242
|
+
*/
|
|
1243
|
+
ChangeEvents: ChangeEvent[] | undefined;
|
|
1244
|
+
/**
|
|
1245
|
+
* <p>Include this value in your next use of this API to get the next set of change events.</p>
|
|
1125
1246
|
* @public
|
|
1126
1247
|
*/
|
|
1127
1248
|
NextToken?: string | undefined;
|
|
@@ -1131,28 +1252,38 @@ export interface ListAuditFindingsOutput {
|
|
|
1131
1252
|
*/
|
|
1132
1253
|
export interface ListGroupingAttributeDefinitionsInput {
|
|
1133
1254
|
/**
|
|
1134
|
-
* <p>
|
|
1255
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of grouping attribute definitions.</p>
|
|
1135
1256
|
* @public
|
|
1136
1257
|
*/
|
|
1137
1258
|
NextToken?: string | undefined;
|
|
1259
|
+
/**
|
|
1260
|
+
* <p>The Amazon Web Services account ID to retrieve grouping attribute definitions for. Use this when accessing grouping configurations from a different account in cross-account monitoring scenarios.</p>
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
AwsAccountId?: string | undefined;
|
|
1264
|
+
/**
|
|
1265
|
+
* <p>If you are using this operation in a monitoring account, specify <code>true</code> to include grouping attributes from source accounts in the returned data.</p>
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
IncludeLinkedAccounts?: boolean | undefined;
|
|
1138
1269
|
}
|
|
1139
1270
|
/**
|
|
1140
|
-
* <p>
|
|
1271
|
+
* <p>A structure that defines how services should be grouped based on specific attributes. This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.</p>
|
|
1141
1272
|
* @public
|
|
1142
1273
|
*/
|
|
1143
1274
|
export interface GroupingAttributeDefinition {
|
|
1144
1275
|
/**
|
|
1145
|
-
* <p>The name
|
|
1276
|
+
* <p>The friendly name for this grouping attribute, such as <code>BusinessUnit</code> or <code>Environment</code>. This name is used to identify the grouping in the console and APIs.</p>
|
|
1146
1277
|
* @public
|
|
1147
1278
|
*/
|
|
1148
1279
|
GroupingName: string | undefined;
|
|
1149
1280
|
/**
|
|
1150
|
-
* <p>An array of source
|
|
1281
|
+
* <p>An array of source keys used to derive the grouping attribute value from telemetry data, Amazon Web Services tags, or other sources. For example, ["business_unit", "team"] would look for values in those fields.</p>
|
|
1151
1282
|
* @public
|
|
1152
1283
|
*/
|
|
1153
1284
|
GroupingSourceKeys?: string[] | undefined;
|
|
1154
1285
|
/**
|
|
1155
|
-
* <p>The default value to use for grouping when
|
|
1286
|
+
* <p>The default value to use for this grouping attribute when no value can be derived from the source keys. This ensures all services have a grouping value even if the source data is missing.</p>
|
|
1156
1287
|
* @public
|
|
1157
1288
|
*/
|
|
1158
1289
|
DefaultGroupingValue?: string | undefined;
|
|
@@ -1162,17 +1293,17 @@ export interface GroupingAttributeDefinition {
|
|
|
1162
1293
|
*/
|
|
1163
1294
|
export interface ListGroupingAttributeDefinitionsOutput {
|
|
1164
1295
|
/**
|
|
1165
|
-
* <p>An array of
|
|
1296
|
+
* <p>An array of structures, where each structure contains information about one grouping attribute definition, including the grouping name, source keys, and default values.</p>
|
|
1166
1297
|
* @public
|
|
1167
1298
|
*/
|
|
1168
1299
|
GroupingAttributeDefinitions: GroupingAttributeDefinition[] | undefined;
|
|
1169
1300
|
/**
|
|
1170
|
-
* <p>The timestamp when the grouping
|
|
1301
|
+
* <p>The timestamp when the grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1171
1302
|
* @public
|
|
1172
1303
|
*/
|
|
1173
1304
|
UpdatedAt?: Date | undefined;
|
|
1174
1305
|
/**
|
|
1175
|
-
* <p>
|
|
1306
|
+
* <p>Include this value in your next use of this API to get the next set of grouping attribute definitions.</p>
|
|
1176
1307
|
* @public
|
|
1177
1308
|
*/
|
|
1178
1309
|
NextToken?: string | undefined;
|
|
@@ -1501,7 +1632,7 @@ export interface ServiceSummary {
|
|
|
1501
1632
|
*/
|
|
1502
1633
|
MetricReferences: MetricReference[] | undefined;
|
|
1503
1634
|
/**
|
|
1504
|
-
* <p>An array of service groups that this service belongs to,
|
|
1635
|
+
* <p>An array of service groups that this service belongs to, based on the configured grouping attributes.</p>
|
|
1505
1636
|
* @public
|
|
1506
1637
|
*/
|
|
1507
1638
|
ServiceGroups?: ServiceGroup[] | undefined;
|
|
@@ -1532,17 +1663,17 @@ export interface ListServicesOutput {
|
|
|
1532
1663
|
NextToken?: string | undefined;
|
|
1533
1664
|
}
|
|
1534
1665
|
/**
|
|
1535
|
-
* <p>
|
|
1666
|
+
* <p>A structure that defines a filter for narrowing down results based on specific attribute values. This can be used to filter services by platform, environment, or other service characteristics.</p>
|
|
1536
1667
|
* @public
|
|
1537
1668
|
*/
|
|
1538
1669
|
export interface AttributeFilter {
|
|
1539
1670
|
/**
|
|
1540
|
-
* <p>The name of the attribute to filter
|
|
1671
|
+
* <p>The name of the attribute to filter by, such as <code>Platform</code>, <code>Environment</code>, or <code>BusinessUnit</code>.</p>
|
|
1541
1672
|
* @public
|
|
1542
1673
|
*/
|
|
1543
1674
|
AttributeFilterName: string | undefined;
|
|
1544
1675
|
/**
|
|
1545
|
-
* <p>An array of values to match
|
|
1676
|
+
* <p>An array of values to match for the specified attribute. Services that have any of these values for the attribute will be included in the results.</p>
|
|
1546
1677
|
* @public
|
|
1547
1678
|
*/
|
|
1548
1679
|
AttributeFilterValues: string[] | undefined;
|
|
@@ -1552,104 +1683,58 @@ export interface AttributeFilter {
|
|
|
1552
1683
|
*/
|
|
1553
1684
|
export interface ListServiceStatesInput {
|
|
1554
1685
|
/**
|
|
1555
|
-
* <p>The start
|
|
1686
|
+
* <p>The start of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p>
|
|
1556
1687
|
* @public
|
|
1557
1688
|
*/
|
|
1558
1689
|
StartTime: Date | undefined;
|
|
1559
1690
|
/**
|
|
1560
|
-
* <p>The end time
|
|
1691
|
+
* <p>The end of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p>
|
|
1561
1692
|
* @public
|
|
1562
1693
|
*/
|
|
1563
1694
|
EndTime: Date | undefined;
|
|
1564
1695
|
/**
|
|
1565
|
-
* <p>The maximum number of service states to return in
|
|
1696
|
+
* <p>The maximum number of service states to return in one operation. If you omit this parameter, the default of 20 is used.</p>
|
|
1566
1697
|
* @public
|
|
1567
1698
|
*/
|
|
1568
1699
|
MaxResults?: number | undefined;
|
|
1569
1700
|
/**
|
|
1570
|
-
* <p>
|
|
1701
|
+
* <p>Include this value, if it was returned by the previous operation, to get the next set of service states.</p>
|
|
1571
1702
|
* @public
|
|
1572
1703
|
*/
|
|
1573
1704
|
NextToken?: string | undefined;
|
|
1574
1705
|
/**
|
|
1575
|
-
* <p>
|
|
1706
|
+
* <p>If you are using this operation in a monitoring account, specify <code>true</code> to include service states from source accounts in the returned data.</p>
|
|
1576
1707
|
* @public
|
|
1577
1708
|
*/
|
|
1578
1709
|
IncludeLinkedAccounts?: boolean | undefined;
|
|
1579
1710
|
/**
|
|
1580
|
-
* <p>The
|
|
1711
|
+
* <p>The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.</p>
|
|
1581
1712
|
* @public
|
|
1582
1713
|
*/
|
|
1583
1714
|
AwsAccountId?: string | undefined;
|
|
1584
1715
|
/**
|
|
1585
|
-
* <p>
|
|
1716
|
+
* <p>A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.</p>
|
|
1586
1717
|
* @public
|
|
1587
1718
|
*/
|
|
1588
1719
|
AttributeFilters?: AttributeFilter[] | undefined;
|
|
1589
1720
|
}
|
|
1590
1721
|
/**
|
|
1591
|
-
* <p>
|
|
1592
|
-
* @public
|
|
1593
|
-
*/
|
|
1594
|
-
export interface ChangeEvent {
|
|
1595
|
-
/**
|
|
1596
|
-
* <p>The timestamp when the change event occurred, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.</p>
|
|
1597
|
-
* @public
|
|
1598
|
-
*/
|
|
1599
|
-
Timestamp: Date | undefined;
|
|
1600
|
-
/**
|
|
1601
|
-
* <p>The AWS account ID where the change event occurred.</p>
|
|
1602
|
-
* @public
|
|
1603
|
-
*/
|
|
1604
|
-
AccountId: string | undefined;
|
|
1605
|
-
/**
|
|
1606
|
-
* <p>The AWS region where the change event occurred.</p>
|
|
1607
|
-
* @public
|
|
1608
|
-
*/
|
|
1609
|
-
Region: string | undefined;
|
|
1610
|
-
/**
|
|
1611
|
-
* <p>The entity or resource that was changed, such as a service, deployment, or configuration.</p>
|
|
1612
|
-
* @public
|
|
1613
|
-
*/
|
|
1614
|
-
Entity: Record<string, string> | undefined;
|
|
1615
|
-
/**
|
|
1616
|
-
* <p>The type of change that occurred, such as "Deployment", "Configuration", or "Infrastructure".</p>
|
|
1617
|
-
* @public
|
|
1618
|
-
*/
|
|
1619
|
-
ChangeEventType: ChangeEventType | undefined;
|
|
1620
|
-
/**
|
|
1621
|
-
* <p>A unique identifier for the change event.</p>
|
|
1622
|
-
* @public
|
|
1623
|
-
*/
|
|
1624
|
-
EventId: string | undefined;
|
|
1625
|
-
/**
|
|
1626
|
-
* <p>The name of the user or system that initiated the change event.</p>
|
|
1627
|
-
* @public
|
|
1628
|
-
*/
|
|
1629
|
-
UserName?: string | undefined;
|
|
1630
|
-
/**
|
|
1631
|
-
* <p>A descriptive name for the change event that provides context about what changed.</p>
|
|
1632
|
-
* @public
|
|
1633
|
-
*/
|
|
1634
|
-
EventName?: string | undefined;
|
|
1635
|
-
}
|
|
1636
|
-
/**
|
|
1637
|
-
* <p>Represents the current state and health information for a service monitored by Application Signals.</p>
|
|
1722
|
+
* <p>A structure that contains information about the current state of a service, including its latest change events such as deployments and other state-changing activities.</p>
|
|
1638
1723
|
* @public
|
|
1639
1724
|
*/
|
|
1640
1725
|
export interface ServiceState {
|
|
1641
1726
|
/**
|
|
1642
|
-
* <p>The attribute filters that were applied when retrieving this service state.</p>
|
|
1727
|
+
* <p>The attribute filters that were applied when retrieving this service state information.</p>
|
|
1643
1728
|
* @public
|
|
1644
1729
|
*/
|
|
1645
1730
|
AttributeFilters?: AttributeFilter[] | undefined;
|
|
1646
1731
|
/**
|
|
1647
|
-
* <p>The
|
|
1732
|
+
* <p>The key attributes that identify this service, including Type, Name, and Environment information.</p>
|
|
1648
1733
|
* @public
|
|
1649
1734
|
*/
|
|
1650
1735
|
Service: Record<string, string> | undefined;
|
|
1651
1736
|
/**
|
|
1652
|
-
* <p>An array
|
|
1737
|
+
* <p>An array containing the most recent change events for this service, such as deployments, with information about when they occurred and who initiated them.</p>
|
|
1653
1738
|
* @public
|
|
1654
1739
|
*/
|
|
1655
1740
|
LatestChangeEvents: ChangeEvent[] | undefined;
|
|
@@ -1659,22 +1744,22 @@ export interface ServiceState {
|
|
|
1659
1744
|
*/
|
|
1660
1745
|
export interface ListServiceStatesOutput {
|
|
1661
1746
|
/**
|
|
1662
|
-
* <p>The start time
|
|
1747
|
+
* <p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p>
|
|
1663
1748
|
* @public
|
|
1664
1749
|
*/
|
|
1665
1750
|
StartTime: Date | undefined;
|
|
1666
1751
|
/**
|
|
1667
|
-
* <p>The end time
|
|
1752
|
+
* <p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, <code>1698778057</code>.</p>
|
|
1668
1753
|
* @public
|
|
1669
1754
|
*/
|
|
1670
1755
|
EndTime: Date | undefined;
|
|
1671
1756
|
/**
|
|
1672
|
-
* <p>An array of
|
|
1757
|
+
* <p>An array of structures, where each structure contains information about the state of one service, including its latest change events such as deployments.</p>
|
|
1673
1758
|
* @public
|
|
1674
1759
|
*/
|
|
1675
1760
|
ServiceStates: ServiceState[] | undefined;
|
|
1676
1761
|
/**
|
|
1677
|
-
* <p>
|
|
1762
|
+
* <p>Include this value in your next use of this API to get the next set of service states.</p>
|
|
1678
1763
|
* @public
|
|
1679
1764
|
*/
|
|
1680
1765
|
NextToken?: string | undefined;
|
|
@@ -1720,23 +1805,23 @@ export interface ListTagsForResourceResponse {
|
|
|
1720
1805
|
*/
|
|
1721
1806
|
export interface PutGroupingConfigurationInput {
|
|
1722
1807
|
/**
|
|
1723
|
-
* <p>An array of grouping attribute definitions that specify how services should be grouped. Each definition includes
|
|
1808
|
+
* <p>An array of grouping attribute definitions that specify how services should be grouped. Each definition includes a friendly name, source keys to derive the grouping value from, and an optional default value.</p>
|
|
1724
1809
|
* @public
|
|
1725
1810
|
*/
|
|
1726
1811
|
GroupingAttributeDefinitions: GroupingAttributeDefinition[] | undefined;
|
|
1727
1812
|
}
|
|
1728
1813
|
/**
|
|
1729
|
-
* <p>
|
|
1814
|
+
* <p>A structure that contains the complete grouping configuration for an account, including all defined grouping attributes and metadata about when it was last updated.</p>
|
|
1730
1815
|
* @public
|
|
1731
1816
|
*/
|
|
1732
1817
|
export interface GroupingConfiguration {
|
|
1733
1818
|
/**
|
|
1734
|
-
* <p>An array of grouping attribute definitions that specify
|
|
1819
|
+
* <p>An array of grouping attribute definitions that specify how services should be grouped based on various attributes and source keys.</p>
|
|
1735
1820
|
* @public
|
|
1736
1821
|
*/
|
|
1737
1822
|
GroupingAttributeDefinitions: GroupingAttributeDefinition[] | undefined;
|
|
1738
1823
|
/**
|
|
1739
|
-
* <p>The timestamp when
|
|
1824
|
+
* <p>The timestamp when this grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.</p>
|
|
1740
1825
|
* @public
|
|
1741
1826
|
*/
|
|
1742
1827
|
UpdatedAt: Date | undefined;
|
|
@@ -1746,7 +1831,7 @@ export interface GroupingConfiguration {
|
|
|
1746
1831
|
*/
|
|
1747
1832
|
export interface PutGroupingConfigurationOutput {
|
|
1748
1833
|
/**
|
|
1749
|
-
* <p>
|
|
1834
|
+
* <p>A structure containing the updated grouping configuration, including all grouping attribute definitions and the timestamp when it was last updated.</p>
|
|
1750
1835
|
* @public
|
|
1751
1836
|
*/
|
|
1752
1837
|
GroupingConfiguration: GroupingConfiguration | undefined;
|
|
@@ -1840,7 +1925,7 @@ export interface ServiceLevelIndicatorMetricConfig {
|
|
|
1840
1925
|
*/
|
|
1841
1926
|
MetricType?: ServiceLevelIndicatorMetricType | undefined;
|
|
1842
1927
|
/**
|
|
1843
|
-
* <p>The name of the CloudWatch metric
|
|
1928
|
+
* <p>The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.</p>
|
|
1844
1929
|
* @public
|
|
1845
1930
|
*/
|
|
1846
1931
|
MetricName?: string | undefined;
|