Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Amazon CodeGuru Profiler can respond with.

Structs§

AgentConfiguration

The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data.

AgentOrchestrationConfig

Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group.

AggregatedProfileTime

Specifies the aggregation period and aggregation start time for an aggregated profile. An aggregated profile is used to collect posted agent profiles during an aggregation period. There are three possible aggregation periods (1 day, 1 hour, or 5 minutes).

Anomaly

Details about an anomaly in a specific metric of application profile. The anomaly is detected using analysis of the metric data over a period of time.

AnomalyInstance

The specific duration in which the metric is flagged as anomalous.

Channel

Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.

FindingsReportSummary

Information about potential recommendations that might be created from the analysis of profiling data.

FrameMetric

The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.

FrameMetricDatum

Information about a frame metric and its values.

Match

The part of a profile that contains a recommendation found during analysis.

Metric

Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame.

NotificationConfiguration

The configuration for notifications stored for each profiling group. This includes up to to two channels and a list of event publishers associated with each channel.

Pattern

A set of rules used to make a recommendation during an analysis.

ProfileTime

Contains the start time of a profile.

ProfilingGroupDescription

Contains information about a profiling group.

ProfilingStatus

Profiling status includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

Recommendation

A potential improvement that was found from analyzing the profiling data.

TimestampStructure

A data type that contains a Timestamp object. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

UserFeedback

Feedback that can be submitted for each instance of an anomaly by the user. Feedback is be used for improvements in generating recommendations for the application.

Enums§

ActionGroup
When writing a match expression against ActionGroup, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AgentParameterField
When writing a match expression against AgentParameterField, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AggregationPeriod
When writing a match expression against AggregationPeriod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ComputePlatform
When writing a match expression against ComputePlatform, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EventPublisher
When writing a match expression against EventPublisher, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FeedbackType
When writing a match expression against FeedbackType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MetadataField
When writing a match expression against MetadataField, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MetricType
When writing a match expression against MetricType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
OrderBy
When writing a match expression against OrderBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.