| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CodeGuruProfiler
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- GetRecommendations
- AddNotificationChannels
- DescribeProfilingGroup
- PutPermission
- ListTagsForResource
- RemovePermission
- SubmitFeedback
- CreateProfilingGroup
- RemoveNotificationChannel
- UpdateProfilingGroup
- DeleteProfilingGroup
- ListFindingsReports
- ListProfileTimes (Paginated)
- PostAgentProfile
- GetProfile
- ListProfilingGroups
- TagResource
- GetNotificationConfiguration
- BatchGetFrameMetricData
- UntagResource
- GetFindingsReportAccountSummary
- GetPolicy
- ConfigureAgent
- Types
- ActionGroup
- AgentParameterField
- AggregationPeriod
- ComputePlatform
- EventPublisher
- FeedbackType
- MetadataField
- MetricType
- OrderBy
- AgentConfiguration
- AgentOrchestrationConfig
- AggregatedProfileTime
- Anomaly
- AnomalyInstance
- Channel
- FindingsReportSummary
- FrameMetric
- FrameMetricDatum
- Match
- Metric
- NotificationConfiguration
- Pattern
- ProfileTime
- ProfilingGroupDescription
- ProfilingStatus
- Recommendation
- TimestampStructure
- UserFeedback
Description
Derived from API version 2019-07-18 of the AWS service descriptions, licensed under Apache 2.0.
This section provides documentation for the Amazon CodeGuru Profiler API operations.
Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks.
Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization.
Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages and Python. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages and Python.
For more information, see What is Amazon CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide.
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data GetRecommendations = GetRecommendations' (Maybe Text) POSIX Text POSIX
- newGetRecommendations :: UTCTime -> Text -> UTCTime -> GetRecommendations
- data GetRecommendationsResponse = GetRecommendationsResponse' Int [Anomaly] POSIX POSIX Text [Recommendation]
- newGetRecommendationsResponse :: Int -> UTCTime -> UTCTime -> Text -> GetRecommendationsResponse
- data AddNotificationChannels = AddNotificationChannels' (NonEmpty Channel) Text
- newAddNotificationChannels :: NonEmpty Channel -> Text -> AddNotificationChannels
- data AddNotificationChannelsResponse = AddNotificationChannelsResponse' (Maybe NotificationConfiguration) Int
- newAddNotificationChannelsResponse :: Int -> AddNotificationChannelsResponse
- data DescribeProfilingGroup = DescribeProfilingGroup' Text
- newDescribeProfilingGroup :: Text -> DescribeProfilingGroup
- data DescribeProfilingGroupResponse = DescribeProfilingGroupResponse' Int ProfilingGroupDescription
- newDescribeProfilingGroupResponse :: Int -> ProfilingGroupDescription -> DescribeProfilingGroupResponse
- data PutPermission = PutPermission' (Maybe Text) ActionGroup (NonEmpty Text) Text
- newPutPermission :: ActionGroup -> NonEmpty Text -> Text -> PutPermission
- data PutPermissionResponse = PutPermissionResponse' Int Text Text
- newPutPermissionResponse :: Int -> Text -> Text -> PutPermissionResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data RemovePermission = RemovePermission' ActionGroup Text Text
- newRemovePermission :: ActionGroup -> Text -> Text -> RemovePermission
- data RemovePermissionResponse = RemovePermissionResponse' Int Text Text
- newRemovePermissionResponse :: Int -> Text -> Text -> RemovePermissionResponse
- data SubmitFeedback = SubmitFeedback' (Maybe Text) Text Text FeedbackType
- newSubmitFeedback :: Text -> Text -> FeedbackType -> SubmitFeedback
- data SubmitFeedbackResponse = SubmitFeedbackResponse' Int
- newSubmitFeedbackResponse :: Int -> SubmitFeedbackResponse
- data CreateProfilingGroup = CreateProfilingGroup' (Maybe ComputePlatform) (Maybe AgentOrchestrationConfig) (Maybe (HashMap Text Text)) Text Text
- newCreateProfilingGroup :: Text -> Text -> CreateProfilingGroup
- data CreateProfilingGroupResponse = CreateProfilingGroupResponse' Int ProfilingGroupDescription
- newCreateProfilingGroupResponse :: Int -> ProfilingGroupDescription -> CreateProfilingGroupResponse
- data RemoveNotificationChannel = RemoveNotificationChannel' Text Text
- newRemoveNotificationChannel :: Text -> Text -> RemoveNotificationChannel
- data RemoveNotificationChannelResponse = RemoveNotificationChannelResponse' (Maybe NotificationConfiguration) Int
- newRemoveNotificationChannelResponse :: Int -> RemoveNotificationChannelResponse
- data UpdateProfilingGroup = UpdateProfilingGroup' AgentOrchestrationConfig Text
- newUpdateProfilingGroup :: AgentOrchestrationConfig -> Text -> UpdateProfilingGroup
- data UpdateProfilingGroupResponse = UpdateProfilingGroupResponse' Int ProfilingGroupDescription
- newUpdateProfilingGroupResponse :: Int -> ProfilingGroupDescription -> UpdateProfilingGroupResponse
- data DeleteProfilingGroup = DeleteProfilingGroup' Text
- newDeleteProfilingGroup :: Text -> DeleteProfilingGroup
- data DeleteProfilingGroupResponse = DeleteProfilingGroupResponse' Int
- newDeleteProfilingGroupResponse :: Int -> DeleteProfilingGroupResponse
- data ListFindingsReports = ListFindingsReports' (Maybe Text) (Maybe Bool) (Maybe Natural) POSIX Text POSIX
- newListFindingsReports :: UTCTime -> Text -> UTCTime -> ListFindingsReports
- data ListFindingsReportsResponse = ListFindingsReportsResponse' (Maybe Text) Int [FindingsReportSummary]
- newListFindingsReportsResponse :: Int -> ListFindingsReportsResponse
- data ListProfileTimes = ListProfileTimes' (Maybe OrderBy) (Maybe Text) (Maybe Natural) POSIX AggregationPeriod Text POSIX
- newListProfileTimes :: UTCTime -> AggregationPeriod -> Text -> UTCTime -> ListProfileTimes
- data ListProfileTimesResponse = ListProfileTimesResponse' (Maybe Text) Int [ProfileTime]
- newListProfileTimesResponse :: Int -> ListProfileTimesResponse
- data PostAgentProfile = PostAgentProfile' (Maybe Text) ByteString Text Text
- newPostAgentProfile :: ByteString -> Text -> Text -> PostAgentProfile
- data PostAgentProfileResponse = PostAgentProfileResponse' Int
- newPostAgentProfileResponse :: Int -> PostAgentProfileResponse
- data GetProfile = GetProfile' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) Text
- newGetProfile :: Text -> GetProfile
- data GetProfileResponse = GetProfileResponse' (Maybe Text) Int Text ByteString
- newGetProfileResponse :: Int -> Text -> ByteString -> GetProfileResponse
- data ListProfilingGroups = ListProfilingGroups' (Maybe Bool) (Maybe Text) (Maybe Natural)
- newListProfilingGroups :: ListProfilingGroups
- data ListProfilingGroupsResponse = ListProfilingGroupsResponse' (Maybe Text) (Maybe [ProfilingGroupDescription]) Int [Text]
- newListProfilingGroupsResponse :: Int -> ListProfilingGroupsResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data GetNotificationConfiguration = GetNotificationConfiguration' Text
- newGetNotificationConfiguration :: Text -> GetNotificationConfiguration
- data GetNotificationConfigurationResponse = GetNotificationConfigurationResponse' Int NotificationConfiguration
- newGetNotificationConfigurationResponse :: Int -> NotificationConfiguration -> GetNotificationConfigurationResponse
- data BatchGetFrameMetricData = BatchGetFrameMetricData' (Maybe AggregationPeriod) (Maybe [FrameMetric]) (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text
- newBatchGetFrameMetricData :: Text -> BatchGetFrameMetricData
- data BatchGetFrameMetricDataResponse = BatchGetFrameMetricDataResponse' Int POSIX [TimestampStructure] [FrameMetricDatum] AggregationPeriod POSIX (HashMap Text [TimestampStructure])
- newBatchGetFrameMetricDataResponse :: Int -> UTCTime -> AggregationPeriod -> UTCTime -> BatchGetFrameMetricDataResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data GetFindingsReportAccountSummary = GetFindingsReportAccountSummary' (Maybe Text) (Maybe Bool) (Maybe Natural)
- newGetFindingsReportAccountSummary :: GetFindingsReportAccountSummary
- data GetFindingsReportAccountSummaryResponse = GetFindingsReportAccountSummaryResponse' (Maybe Text) Int [FindingsReportSummary]
- newGetFindingsReportAccountSummaryResponse :: Int -> GetFindingsReportAccountSummaryResponse
- data GetPolicy = GetPolicy' Text
- newGetPolicy :: Text -> GetPolicy
- data GetPolicyResponse = GetPolicyResponse' Int Text Text
- newGetPolicyResponse :: Int -> Text -> Text -> GetPolicyResponse
- data ConfigureAgent = ConfigureAgent' (Maybe Text) (Maybe (HashMap MetadataField Text)) Text
- newConfigureAgent :: Text -> ConfigureAgent
- data ConfigureAgentResponse = ConfigureAgentResponse' Int AgentConfiguration
- newConfigureAgentResponse :: Int -> AgentConfiguration -> ConfigureAgentResponse
- newtype ActionGroup where
- ActionGroup' { }
- pattern ActionGroup_AgentPermissions :: ActionGroup
- newtype AgentParameterField where
- AgentParameterField' { }
- pattern AgentParameterField_MaxStackDepth :: AgentParameterField
- pattern AgentParameterField_MemoryUsageLimitPercent :: AgentParameterField
- pattern AgentParameterField_MinimumTimeForReportingInMilliseconds :: AgentParameterField
- pattern AgentParameterField_ReportingIntervalInMilliseconds :: AgentParameterField
- pattern AgentParameterField_SamplingIntervalInMilliseconds :: AgentParameterField
- newtype AggregationPeriod where
- AggregationPeriod' { }
- pattern AggregationPeriod_P1D :: AggregationPeriod
- pattern AggregationPeriod_PT1H :: AggregationPeriod
- pattern AggregationPeriod_PT5M :: AggregationPeriod
- newtype ComputePlatform where
- ComputePlatform' { }
- pattern ComputePlatform_AWSLambda :: ComputePlatform
- pattern ComputePlatform_Default :: ComputePlatform
- newtype EventPublisher where
- EventPublisher' { }
- pattern EventPublisher_AnomalyDetection :: EventPublisher
- newtype FeedbackType where
- FeedbackType' { }
- pattern FeedbackType_Negative :: FeedbackType
- pattern FeedbackType_Positive :: FeedbackType
- newtype MetadataField where
- MetadataField' { }
- pattern MetadataField_AgentId :: MetadataField
- pattern MetadataField_AwsRequestId :: MetadataField
- pattern MetadataField_ComputePlatform :: MetadataField
- pattern MetadataField_ExecutionEnvironment :: MetadataField
- pattern MetadataField_LambdaFunctionArn :: MetadataField
- pattern MetadataField_LambdaMemoryLimitInMB :: MetadataField
- pattern MetadataField_LambdaPreviousExecutionTimeInMilliseconds :: MetadataField
- pattern MetadataField_LambdaRemainingTimeInMilliseconds :: MetadataField
- pattern MetadataField_LambdaTimeGapBetweenInvokesInMilliseconds :: MetadataField
- newtype MetricType where
- MetricType' { }
- pattern MetricType_AggregatedRelativeTotalTime :: MetricType
- newtype OrderBy where
- OrderBy' {
- fromOrderBy :: Text
- pattern OrderBy_TimestampAscending :: OrderBy
- pattern OrderBy_TimestampDescending :: OrderBy
- OrderBy' {
- data AgentConfiguration = AgentConfiguration' (Maybe (HashMap AgentParameterField Text)) Int Bool
- newAgentConfiguration :: Int -> Bool -> AgentConfiguration
- data AgentOrchestrationConfig = AgentOrchestrationConfig' Bool
- newAgentOrchestrationConfig :: Bool -> AgentOrchestrationConfig
- data AggregatedProfileTime = AggregatedProfileTime' (Maybe AggregationPeriod) (Maybe POSIX)
- newAggregatedProfileTime :: AggregatedProfileTime
- data Anomaly = Anomaly' [AnomalyInstance] Metric Text
- newAnomaly :: Metric -> Text -> Anomaly
- data AnomalyInstance = AnomalyInstance' (Maybe POSIX) (Maybe UserFeedback) Text POSIX
- newAnomalyInstance :: Text -> UTCTime -> AnomalyInstance
- data Channel = Channel' (Maybe Text) (NonEmpty EventPublisher) Text
- newChannel :: NonEmpty EventPublisher -> Text -> Channel
- data FindingsReportSummary = FindingsReportSummary' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Int)
- newFindingsReportSummary :: FindingsReportSummary
- data FrameMetric = FrameMetric' Text [Text] MetricType
- newFrameMetric :: Text -> MetricType -> FrameMetric
- data FrameMetricDatum = FrameMetricDatum' FrameMetric [Double]
- newFrameMetricDatum :: FrameMetric -> FrameMetricDatum
- data Match = Match' (Maybe Double) (Maybe Text) (Maybe Int)
- newMatch :: Match
- data Metric = Metric' Text [Text] MetricType
- newMetric :: Text -> MetricType -> Metric
- data NotificationConfiguration = NotificationConfiguration' (Maybe (NonEmpty Channel))
- newNotificationConfiguration :: NotificationConfiguration
- data Pattern = Pattern' (Maybe Double) (Maybe [[Text]]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPattern :: Pattern
- data ProfileTime = ProfileTime' (Maybe POSIX)
- newProfileTime :: ProfileTime
- data ProfilingGroupDescription = ProfilingGroupDescription' (Maybe ComputePlatform) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ProfilingStatus) (Maybe POSIX) (Maybe AgentOrchestrationConfig) (Maybe (HashMap Text Text))
- newProfilingGroupDescription :: ProfilingGroupDescription
- data ProfilingStatus = ProfilingStatus' (Maybe POSIX) (Maybe POSIX) (Maybe AggregatedProfileTime)
- newProfilingStatus :: ProfilingStatus
- data Recommendation = Recommendation' Int Double POSIX Pattern POSIX [Match]
- newRecommendation :: Int -> Double -> UTCTime -> Pattern -> UTCTime -> Recommendation
- data TimestampStructure = TimestampStructure' POSIX
- newTimestampStructure :: UTCTime -> TimestampStructure
- data UserFeedback = UserFeedback' FeedbackType
- newUserFeedback :: FeedbackType -> UserFeedback
Service Configuration
defaultService :: Service Source #
API version 2019-07-18 of the Amazon CodeGuru Profiler SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CodeGuruProfiler.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The parameter is not valid.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The server encountered an internal error and is unable to complete the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource specified in the request does not exist.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetRecommendations
data GetRecommendations Source #
The structure representing the GetRecommendationsRequest.
See: newGetRecommendations smart constructor.
Instances
newGetRecommendations Source #
Arguments
| :: UTCTime | |
| -> Text | |
| -> UTCTime | |
| -> GetRecommendations |
Create a value of GetRecommendations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locale:GetRecommendations', getRecommendations_locale - The language used to provide analysis. Specify using a string that is
one of the following BCP 47 language codes.
de-DE- German, Germanyen-GB- English, United Kingdomen-US- English, United Stateses-ES- Spanish, Spainfr-FR- French, Franceit-IT- Italian, Italyja-JP- Japanese, Japanko-KR- Korean, Republic of Koreapt-BR- Portugese, Brazilzh-CN- Chinese, Chinazh-TW- Chinese, Taiwan
$sel:endTime:GetRecommendations', getRecommendations_endTime - The start time of the profile to get analysis data about. You must
specify startTime and endTime. 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.
$sel:profilingGroupName:GetRecommendations', getRecommendations_profilingGroupName - The name of the profiling group to get analysis data about.
$sel:startTime:GetRecommendations', getRecommendations_startTime - The end time of the profile to get analysis data about. You must specify
startTime and endTime. 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.
data GetRecommendationsResponse Source #
The structure representing the GetRecommendationsResponse.
See: newGetRecommendationsResponse smart constructor.
Constructors
| GetRecommendationsResponse' Int [Anomaly] POSIX POSIX Text [Recommendation] |
Instances
newGetRecommendationsResponse Source #
Arguments
| :: Int | |
| -> UTCTime | |
| -> UTCTime | |
| -> Text | |
| -> GetRecommendationsResponse |
Create a value of GetRecommendationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetRecommendationsResponse', getRecommendationsResponse_httpStatus - The response's http status code.
$sel:anomalies:GetRecommendationsResponse', getRecommendationsResponse_anomalies - The list of anomalies that the analysis has found for this profile.
$sel:profileEndTime:GetRecommendationsResponse', getRecommendationsResponse_profileEndTime - The end time of the profile the analysis data is about. 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.
$sel:profileStartTime:GetRecommendationsResponse', getRecommendationsResponse_profileStartTime - The start time of the profile the analysis data is about. 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.
$sel:profilingGroupName:GetRecommendations', getRecommendationsResponse_profilingGroupName - The name of the profiling group the analysis data is about.
$sel:recommendations:GetRecommendationsResponse', getRecommendationsResponse_recommendations - The list of recommendations that the analysis found for this profile.
AddNotificationChannels
data AddNotificationChannels Source #
The structure representing the AddNotificationChannelsRequest.
See: newAddNotificationChannels smart constructor.
Constructors
| AddNotificationChannels' (NonEmpty Channel) Text |
Instances
newAddNotificationChannels Source #
Arguments
| :: NonEmpty Channel | |
| -> Text | |
| -> AddNotificationChannels |
Create a value of AddNotificationChannels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:AddNotificationChannels', addNotificationChannels_channels - One or 2 channels to report to when anomalies are detected.
$sel:profilingGroupName:AddNotificationChannels', addNotificationChannels_profilingGroupName - The name of the profiling group that we are setting up notifications
for.
data AddNotificationChannelsResponse Source #
The structure representing the AddNotificationChannelsResponse.
See: newAddNotificationChannelsResponse smart constructor.
Constructors
| AddNotificationChannelsResponse' (Maybe NotificationConfiguration) Int |
Instances
newAddNotificationChannelsResponse Source #
Create a value of AddNotificationChannelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notificationConfiguration:AddNotificationChannelsResponse', addNotificationChannelsResponse_notificationConfiguration - The new notification configuration for this profiling group.
$sel:httpStatus:AddNotificationChannelsResponse', addNotificationChannelsResponse_httpStatus - The response's http status code.
DescribeProfilingGroup
data DescribeProfilingGroup Source #
The structure representing the describeProfilingGroupRequest.
See: newDescribeProfilingGroup smart constructor.
Constructors
| DescribeProfilingGroup' Text |
Instances
newDescribeProfilingGroup Source #
Create a value of DescribeProfilingGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profilingGroupName:DescribeProfilingGroup', describeProfilingGroup_profilingGroupName - The name of the profiling group to get information about.
data DescribeProfilingGroupResponse Source #
The structure representing the describeProfilingGroupResponse.
See: newDescribeProfilingGroupResponse smart constructor.
Instances
newDescribeProfilingGroupResponse Source #
Arguments
| :: Int | |
| -> ProfilingGroupDescription | |
| -> DescribeProfilingGroupResponse |
Create a value of DescribeProfilingGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeProfilingGroupResponse', describeProfilingGroupResponse_httpStatus - The response's http status code.
$sel:profilingGroup:DescribeProfilingGroupResponse', describeProfilingGroupResponse_profilingGroup - The returned
ProfilingGroupDescription
object that contains information about the requested profiling group.
PutPermission
data PutPermission Source #
The structure representing the putPermissionRequest.
See: newPutPermission smart constructor.
Constructors
| PutPermission' (Maybe Text) ActionGroup (NonEmpty Text) Text |
Instances
Arguments
| :: ActionGroup | |
| -> NonEmpty Text | |
| -> Text | |
| -> PutPermission |
Create a value of PutPermission with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:revisionId:PutPermission', putPermission_revisionId - A universally unique identifier (UUID) for the revision of the policy
you are adding to the profiling group. Do not specify this when you add
permissions to a profiling group for the first time. If a policy already
exists on the profiling group, you must specify the revisionId.
$sel:actionGroup:PutPermission', putPermission_actionGroup - Specifies an action group that contains permissions to add to a
profiling group resource. One action group is supported,
agentPermissions, which grants permission to perform actions required
by the profiling agent, ConfigureAgent and PostAgentProfile
permissions.
$sel:principals:PutPermission', putPermission_principals - A list ARNs for the roles and users you want to grant access to the
profiling group. Wildcards are not are supported in the ARNs.
$sel:profilingGroupName:PutPermission', putPermission_profilingGroupName - The name of the profiling group to grant access to.
data PutPermissionResponse Source #
The structure representing the putPermissionResponse.
See: newPutPermissionResponse smart constructor.
Constructors
| PutPermissionResponse' Int Text Text |
Instances
newPutPermissionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> PutPermissionResponse |
Create a value of PutPermissionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutPermissionResponse', putPermissionResponse_httpStatus - The response's http status code.
$sel:policy:PutPermissionResponse', putPermissionResponse_policy - The JSON-formatted resource-based policy on the profiling group that
includes the added permissions.
$sel:revisionId:PutPermission', putPermissionResponse_revisionId - A universally unique identifier (UUID) for the revision of the
resource-based policy that includes the added permissions. The
JSON-formatted policy is in the policy element of the response.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the resource that contains the tags to
return.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The list of tags assigned to the specified resource. This is the list of
tags returned in the response.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
RemovePermission
data RemovePermission Source #
The structure representing the <code>removePermissionRequest</code>.</p>
See: newRemovePermission smart constructor.
Constructors
| RemovePermission' ActionGroup Text Text |
Instances
Arguments
| :: ActionGroup | |
| -> Text | |
| -> Text | |
| -> RemovePermission |
Create a value of RemovePermission with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionGroup:RemovePermission', removePermission_actionGroup - Specifies an action group that contains the permissions to remove from a
profiling group's resource-based policy. One action group is supported,
agentPermissions, which grants ConfigureAgent and PostAgentProfile
permissions.
$sel:profilingGroupName:RemovePermission', removePermission_profilingGroupName - The name of the profiling group.
$sel:revisionId:RemovePermission', removePermission_revisionId - A universally unique identifier (UUID) for the revision of the
resource-based policy from which you want to remove permissions.
data RemovePermissionResponse Source #
The structure representing the removePermissionResponse.
See: newRemovePermissionResponse smart constructor.
Constructors
| RemovePermissionResponse' Int Text Text |
Instances
newRemovePermissionResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> RemovePermissionResponse |
Create a value of RemovePermissionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RemovePermissionResponse', removePermissionResponse_httpStatus - The response's http status code.
$sel:policy:RemovePermissionResponse', removePermissionResponse_policy - The JSON-formatted resource-based policy on the profiling group after
the specified permissions were removed.
$sel:revisionId:RemovePermission', removePermissionResponse_revisionId - A universally unique identifier (UUID) for the revision of the
resource-based policy after the specified permissions were removed. The
updated JSON-formatted policy is in the policy element of the
response.
SubmitFeedback
data SubmitFeedback Source #
The structure representing the SubmitFeedbackRequest.
See: newSubmitFeedback smart constructor.
Constructors
| SubmitFeedback' (Maybe Text) Text Text FeedbackType |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> FeedbackType | |
| -> SubmitFeedback |
Create a value of SubmitFeedback with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comment:SubmitFeedback', submitFeedback_comment - Optional feedback about this anomaly.
$sel:anomalyInstanceId:SubmitFeedback', submitFeedback_anomalyInstanceId - The universally unique identifier (UUID) of the
AnomalyInstance
object that is included in the analysis data.
$sel:profilingGroupName:SubmitFeedback', submitFeedback_profilingGroupName - The name of the profiling group that is associated with the analysis
data.
$sel:type':SubmitFeedback', submitFeedback_type - The feedback tpye. Thee are two valid values, Positive and Negative.
data SubmitFeedbackResponse Source #
The structure representing the SubmitFeedbackResponse.
See: newSubmitFeedbackResponse smart constructor.
Constructors
| SubmitFeedbackResponse' Int |
Instances
newSubmitFeedbackResponse Source #
Create a value of SubmitFeedbackResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:SubmitFeedbackResponse', submitFeedbackResponse_httpStatus - The response's http status code.
CreateProfilingGroup
data CreateProfilingGroup Source #
The structure representing the createProfiliingGroupRequest.
See: newCreateProfilingGroup smart constructor.
Constructors
| CreateProfilingGroup' (Maybe ComputePlatform) (Maybe AgentOrchestrationConfig) (Maybe (HashMap Text Text)) Text Text |
Instances
newCreateProfilingGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateProfilingGroup |
Create a value of CreateProfilingGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computePlatform:CreateProfilingGroup', createProfilingGroup_computePlatform - The compute platform of the profiling group. Use AWSLambda if your
application runs on AWS Lambda. Use Default if your application runs
on a compute platform that is not AWS Lambda, such an Amazon EC2
instance, an on-premises server, or a different platform. If not
specified, Default is used.
$sel:agentOrchestrationConfig:CreateProfilingGroup', createProfilingGroup_agentOrchestrationConfig - Specifies whether profiling is enabled or disabled for the created
profiling group.
$sel:tags:CreateProfilingGroup', createProfilingGroup_tags - A list of tags to add to the created profiling group.
$sel:clientToken:CreateProfilingGroup', createProfilingGroup_clientToken - Amazon CodeGuru Profiler uses this universally unique identifier (UUID)
to prevent the accidental creation of duplicate profiling groups if
there are failures and retries.
$sel:profilingGroupName:CreateProfilingGroup', createProfilingGroup_profilingGroupName - The name of the profiling group to create.
data CreateProfilingGroupResponse Source #
The structure representing the createProfilingGroupResponse.
See: newCreateProfilingGroupResponse smart constructor.
Instances
newCreateProfilingGroupResponse Source #
Arguments
| :: Int | |
| -> ProfilingGroupDescription | |
| -> CreateProfilingGroupResponse |
Create a value of CreateProfilingGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateProfilingGroupResponse', createProfilingGroupResponse_httpStatus - The response's http status code.
$sel:profilingGroup:CreateProfilingGroupResponse', createProfilingGroupResponse_profilingGroup - The returned
ProfilingGroupDescription
object that contains information about the created profiling group.
RemoveNotificationChannel
data RemoveNotificationChannel Source #
The structure representing the RemoveNotificationChannelRequest.
See: newRemoveNotificationChannel smart constructor.
Constructors
| RemoveNotificationChannel' Text Text |
Instances
newRemoveNotificationChannel Source #
Arguments
| :: Text | |
| -> Text | |
| -> RemoveNotificationChannel |
Create a value of RemoveNotificationChannel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channelId:RemoveNotificationChannel', removeNotificationChannel_channelId - The id of the channel that we want to stop receiving notifications.
$sel:profilingGroupName:RemoveNotificationChannel', removeNotificationChannel_profilingGroupName - The name of the profiling group we want to change notification
configuration for.
data RemoveNotificationChannelResponse Source #
The structure representing the RemoveNotificationChannelResponse.
See: newRemoveNotificationChannelResponse smart constructor.
Constructors
| RemoveNotificationChannelResponse' (Maybe NotificationConfiguration) Int |
Instances
newRemoveNotificationChannelResponse Source #
Arguments
| :: Int | |
| -> RemoveNotificationChannelResponse |
Create a value of RemoveNotificationChannelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notificationConfiguration:RemoveNotificationChannelResponse', removeNotificationChannelResponse_notificationConfiguration - The new notification configuration for this profiling group.
$sel:httpStatus:RemoveNotificationChannelResponse', removeNotificationChannelResponse_httpStatus - The response's http status code.
UpdateProfilingGroup
data UpdateProfilingGroup Source #
The structure representing the updateProfilingGroupRequest.
See: newUpdateProfilingGroup smart constructor.
Constructors
| UpdateProfilingGroup' AgentOrchestrationConfig Text |
Instances
newUpdateProfilingGroup Source #
Arguments
| :: AgentOrchestrationConfig | |
| -> Text | |
| -> UpdateProfilingGroup |
Create a value of UpdateProfilingGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentOrchestrationConfig:UpdateProfilingGroup', updateProfilingGroup_agentOrchestrationConfig - Specifies whether profiling is enabled or disabled for a profiling
group.
$sel:profilingGroupName:UpdateProfilingGroup', updateProfilingGroup_profilingGroupName - The name of the profiling group to update.
data UpdateProfilingGroupResponse Source #
The structure representing the updateProfilingGroupResponse.
See: newUpdateProfilingGroupResponse smart constructor.
Instances
newUpdateProfilingGroupResponse Source #
Arguments
| :: Int | |
| -> ProfilingGroupDescription | |
| -> UpdateProfilingGroupResponse |
Create a value of UpdateProfilingGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateProfilingGroupResponse', updateProfilingGroupResponse_httpStatus - The response's http status code.
$sel:profilingGroup:UpdateProfilingGroupResponse', updateProfilingGroupResponse_profilingGroup - A
ProfilingGroupDescription
that contains information about the returned updated profiling group.
DeleteProfilingGroup
data DeleteProfilingGroup Source #
The structure representing the deleteProfilingGroupRequest.
See: newDeleteProfilingGroup smart constructor.
Constructors
| DeleteProfilingGroup' Text |
Instances
newDeleteProfilingGroup Source #
Create a value of DeleteProfilingGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profilingGroupName:DeleteProfilingGroup', deleteProfilingGroup_profilingGroupName - The name of the profiling group to delete.
data DeleteProfilingGroupResponse Source #
The structure representing the deleteProfilingGroupResponse.
See: newDeleteProfilingGroupResponse smart constructor.
Constructors
| DeleteProfilingGroupResponse' Int |
Instances
newDeleteProfilingGroupResponse Source #
Create a value of DeleteProfilingGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteProfilingGroupResponse', deleteProfilingGroupResponse_httpStatus - The response's http status code.
ListFindingsReports
data ListFindingsReports Source #
The structure representing the ListFindingsReportsRequest.
See: newListFindingsReports smart constructor.
Instances
newListFindingsReports Source #
Arguments
| :: UTCTime | |
| -> Text | |
| -> UTCTime | |
| -> ListFindingsReports |
Create a value of ListFindingsReports with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListFindingsReports', listFindingsReports_nextToken - The nextToken value returned from a previous paginated
ListFindingsReportsRequest request where maxResults was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:dailyReportsOnly:ListFindingsReports', listFindingsReports_dailyReportsOnly - A Boolean value indicating whether to only return reports from daily
profiles. If set to True, only analysis data from daily profiles is
returned. If set to False, analysis data is returned from smaller time
windows (for example, one hour).
$sel:maxResults:ListFindingsReports', listFindingsReports_maxResults - The maximum number of report results returned by ListFindingsReports
in paginated output. When this parameter is used, ListFindingsReports
only returns maxResults results in a single page along with a
nextToken response element. The remaining results of the initial
request can be seen by sending another ListFindingsReports request
with the returned nextToken value.
$sel:endTime:ListFindingsReports', listFindingsReports_endTime - The end time of the profile to get analysis data about. You must specify
startTime and endTime. 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.
$sel:profilingGroupName:ListFindingsReports', listFindingsReports_profilingGroupName - The name of the profiling group from which to search for analysis data.
$sel:startTime:ListFindingsReports', listFindingsReports_startTime - The start time of the profile to get analysis data about. You must
specify startTime and endTime. 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.
data ListFindingsReportsResponse Source #
The structure representing the ListFindingsReportsResponse.
See: newListFindingsReportsResponse smart constructor.
Constructors
| ListFindingsReportsResponse' (Maybe Text) Int [FindingsReportSummary] |
Instances
newListFindingsReportsResponse Source #
Create a value of ListFindingsReportsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListFindingsReports', listFindingsReportsResponse_nextToken - The nextToken value to include in a future ListFindingsReports
request. When the results of a ListFindingsReports request exceed
maxResults, this value can be used to retrieve the next page of
results. This value is null when there are no more results to return.
$sel:httpStatus:ListFindingsReportsResponse', listFindingsReportsResponse_httpStatus - The response's http status code.
$sel:findingsReportSummaries:ListFindingsReportsResponse', listFindingsReportsResponse_findingsReportSummaries - The list of analysis results summaries.
ListProfileTimes (Paginated)
data ListProfileTimes Source #
The structure representing the listProfileTimesRequest.
See: newListProfileTimes smart constructor.
Constructors
| ListProfileTimes' (Maybe OrderBy) (Maybe Text) (Maybe Natural) POSIX AggregationPeriod Text POSIX |
Instances
Arguments
| :: UTCTime | |
| -> AggregationPeriod | |
| -> Text | |
| -> UTCTime | |
| -> ListProfileTimes |
Create a value of ListProfileTimes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:orderBy:ListProfileTimes', listProfileTimes_orderBy - The order (ascending or descending by start time of the profile) to use
when listing profiles. Defaults to TIMESTAMP_DESCENDING.
$sel:nextToken:ListProfileTimes', listProfileTimes_nextToken - The nextToken value returned from a previous paginated
ListProfileTimes request where maxResults was used and the results
exceeded the value of that parameter. Pagination continues from the end
of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:maxResults:ListProfileTimes', listProfileTimes_maxResults - The maximum number of profile time results returned by
ListProfileTimes in paginated output. When this parameter is used,
ListProfileTimes only returns maxResults results in a single page
with a nextToken response element. The remaining results of the
initial request can be seen by sending another ListProfileTimes
request with the returned nextToken value.
$sel:endTime:ListProfileTimes', listProfileTimes_endTime - The end time of the time range from which to list the profiles.
$sel:period:ListProfileTimes', listProfileTimes_period - The aggregation period. This specifies the period during which an
aggregation profile collects posted agent profiles for a profiling
group. There are 3 valid values.
P1D— 1 dayPT1H— 1 hourPT5M— 5 minutes
$sel:profilingGroupName:ListProfileTimes', listProfileTimes_profilingGroupName - The name of the profiling group.
$sel:startTime:ListProfileTimes', listProfileTimes_startTime - The start time of the time range from which to list the profiles.
data ListProfileTimesResponse Source #
The structure representing the listProfileTimesResponse.
See: newListProfileTimesResponse smart constructor.
Constructors
| ListProfileTimesResponse' (Maybe Text) Int [ProfileTime] |
Instances
newListProfileTimesResponse Source #
Create a value of ListProfileTimesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListProfileTimes', listProfileTimesResponse_nextToken - The nextToken value to include in a future ListProfileTimes request.
When the results of a ListProfileTimes request exceed maxResults,
this value can be used to retrieve the next page of results. This value
is null when there are no more results to return.
$sel:httpStatus:ListProfileTimesResponse', listProfileTimesResponse_httpStatus - The response's http status code.
$sel:profileTimes:ListProfileTimesResponse', listProfileTimesResponse_profileTimes - The list of start times of the available profiles for the aggregation
period in the specified time range.
PostAgentProfile
data PostAgentProfile Source #
The structure representing the postAgentProfileRequest.
See: newPostAgentProfile smart constructor.
Constructors
| PostAgentProfile' (Maybe Text) ByteString Text Text |
Instances
Arguments
| :: ByteString | |
| -> Text | |
| -> Text | |
| -> PostAgentProfile |
Create a value of PostAgentProfile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileToken:PostAgentProfile', postAgentProfile_profileToken - Amazon CodeGuru Profiler uses this universally unique identifier (UUID)
to prevent the accidental submission of duplicate profiling data if
there are failures and retries.
$sel:agentProfile:PostAgentProfile', postAgentProfile_agentProfile - The submitted profiling data.
$sel:contentType:PostAgentProfile', postAgentProfile_contentType - The format of the submitted profiling data. The format maps to the
Accept and Content-Type headers of the HTTP request. You can specify
one of the following: or the default .
<ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
$sel:profilingGroupName:PostAgentProfile', postAgentProfile_profilingGroupName - The name of the profiling group with the aggregated profile that
receives the submitted profiling data.
data PostAgentProfileResponse Source #
The structure representing the postAgentProfileResponse.
See: newPostAgentProfileResponse smart constructor.
Constructors
| PostAgentProfileResponse' Int |
Instances
newPostAgentProfileResponse Source #
Create a value of PostAgentProfileResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PostAgentProfileResponse', postAgentProfileResponse_httpStatus - The response's http status code.
GetProfile
data GetProfile Source #
The structure representing the getProfileRequest.
See: newGetProfile smart constructor.
Instances
Arguments
| :: Text | |
| -> GetProfile |
Create a value of GetProfile with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startTime:GetProfile', getProfile_startTime - The start time of the profile to get. Specify 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.
<p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
$sel:period:GetProfile', getProfile_period - Used with startTime or endTime to specify the time range for the
returned aggregated profile. Specify using the ISO 8601 format. For
example, P1DT1H1M1S.
<p> To get the latest aggregated profile, specify only <code>period</code>. </p>
$sel:accept:GetProfile', getProfile_accept - The format of the returned profiling data. The format maps to the
Accept and Content-Type headers of the HTTP request. You can specify
one of the following: or the default .
<ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
$sel:endTime:GetProfile', getProfile_endTime - The end time of the requested profile. Specify 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.
If you specify endTime, then you must also specify period or
startTime, but not both.
$sel:maxDepth:GetProfile', getProfile_maxDepth - The maximum depth of the stacks in the code that is represented in the
aggregated profile. For example, if CodeGuru Profiler finds a method
A, which calls method B, which calls method C, which calls method
D, then the depth is 4. If the maxDepth is set to 2, then the
aggregated profile contains representations of methods A and B.
$sel:profilingGroupName:GetProfile', getProfile_profilingGroupName - The name of the profiling group to get.
data GetProfileResponse Source #
The structure representing the getProfileResponse.
See: newGetProfileResponse smart constructor.
Constructors
| GetProfileResponse' (Maybe Text) Int Text ByteString |
Instances
newGetProfileResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> ByteString | |
| -> GetProfileResponse |
Create a value of GetProfileResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentEncoding:GetProfileResponse', getProfileResponse_contentEncoding - The content encoding of the profile.
$sel:httpStatus:GetProfileResponse', getProfileResponse_httpStatus - The response's http status code.
$sel:contentType:GetProfileResponse', getProfileResponse_contentType - The content type of the profile in the payload. It is either
application/json or the default application/x-amzn-ion.
$sel:profile:GetProfileResponse', getProfileResponse_profile - Information about the profile.
ListProfilingGroups
data ListProfilingGroups Source #
The structure representing the listProfilingGroupsRequest.
See: newListProfilingGroups smart constructor.
Instances
newListProfilingGroups :: ListProfilingGroups Source #
Create a value of ListProfilingGroups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeDescription:ListProfilingGroups', listProfilingGroups_includeDescription - A Boolean value indicating whether to include a description. If
true, then a list of
ProfilingGroupDescription
objects that contain detailed information about profiling groups is
returned. If false, then a list of profiling group names is returned.
$sel:nextToken:ListProfilingGroups', listProfilingGroups_nextToken - The nextToken value returned from a previous paginated
ListProfilingGroups request where maxResults was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:maxResults:ListProfilingGroups', listProfilingGroups_maxResults - The maximum number of profiling groups results returned by
ListProfilingGroups in paginated output. When this parameter is used,
ListProfilingGroups only returns maxResults results in a single page
along with a nextToken response element. The remaining results of the
initial request can be seen by sending another ListProfilingGroups
request with the returned nextToken value.
data ListProfilingGroupsResponse Source #
The structure representing the listProfilingGroupsResponse.
See: newListProfilingGroupsResponse smart constructor.
Constructors
| ListProfilingGroupsResponse' (Maybe Text) (Maybe [ProfilingGroupDescription]) Int [Text] |
Instances
newListProfilingGroupsResponse Source #
Create a value of ListProfilingGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListProfilingGroups', listProfilingGroupsResponse_nextToken - The nextToken value to include in a future ListProfilingGroups
request. When the results of a ListProfilingGroups request exceed
maxResults, this value can be used to retrieve the next page of
results. This value is null when there are no more results to return.
$sel:profilingGroups:ListProfilingGroupsResponse', listProfilingGroupsResponse_profilingGroups - A returned list
ProfilingGroupDescription
objects. A list of
ProfilingGroupDescription
objects is returned only if includeDescription is true, otherwise a
list of profiling group names is returned.
$sel:httpStatus:ListProfilingGroupsResponse', listProfilingGroupsResponse_httpStatus - The response's http status code.
$sel:profilingGroupNames:ListProfilingGroupsResponse', listProfilingGroupsResponse_profilingGroupNames - A returned list of profiling group names. A list of the names is
returned only if includeDescription is false, otherwise a list of
ProfilingGroupDescription
objects is returned.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource that the tags are added
to.
$sel:tags:TagResource', tagResource_tags - The list of tags that are added to the specified resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
GetNotificationConfiguration
data GetNotificationConfiguration Source #
The structure representing the GetNotificationConfigurationRequest.
See: newGetNotificationConfiguration smart constructor.
Constructors
| GetNotificationConfiguration' Text |
Instances
newGetNotificationConfiguration Source #
Arguments
| :: Text | |
| -> GetNotificationConfiguration |
Create a value of GetNotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profilingGroupName:GetNotificationConfiguration', getNotificationConfiguration_profilingGroupName - The name of the profiling group we want to get the notification
configuration for.
data GetNotificationConfigurationResponse Source #
The structure representing the GetNotificationConfigurationResponse.
See: newGetNotificationConfigurationResponse smart constructor.
Instances
newGetNotificationConfigurationResponse Source #
Arguments
| :: Int | |
| -> NotificationConfiguration |
|
| -> GetNotificationConfigurationResponse |
Create a value of GetNotificationConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetNotificationConfigurationResponse', getNotificationConfigurationResponse_httpStatus - The response's http status code.
$sel:notificationConfiguration:GetNotificationConfigurationResponse', getNotificationConfigurationResponse_notificationConfiguration - The current notification configuration for this profiling group.
BatchGetFrameMetricData
data BatchGetFrameMetricData Source #
The structure representing the BatchGetFrameMetricDataRequest.
See: newBatchGetFrameMetricData smart constructor.
Constructors
| BatchGetFrameMetricData' (Maybe AggregationPeriod) (Maybe [FrameMetric]) (Maybe POSIX) (Maybe Text) (Maybe POSIX) Text |
Instances
newBatchGetFrameMetricData Source #
Create a value of BatchGetFrameMetricData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetResolution:BatchGetFrameMetricData', batchGetFrameMetricData_targetResolution - The requested resolution of time steps for the returned time series of
values. If the requested target resolution is not available due to data
not being retained we provide a best effort result by falling back to
the most granular available resolution after the target resolution.
There are 3 valid values.
P1D— 1 dayPT1H— 1 hourPT5M— 5 minutes
$sel:frameMetrics:BatchGetFrameMetricData', batchGetFrameMetricData_frameMetrics - The details of the metrics that are used to request a time series of
values. The metric includes the name of the frame, the aggregation type
to calculate the metric value for the frame, and the thread states to
use to get the count for the metric value of the frame.
$sel:startTime:BatchGetFrameMetricData', batchGetFrameMetricData_startTime - The start time of the time period for the frame metrics used to return
the time series values. 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.
$sel:period:BatchGetFrameMetricData', batchGetFrameMetricData_period - The duration of the frame metrics used to return the time series values.
Specify using the ISO 8601 format. The maximum period duration is one
day (PT24H or P1D).
$sel:endTime:BatchGetFrameMetricData', batchGetFrameMetricData_endTime - The end time of the time period for the returned time series values.
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.
$sel:profilingGroupName:BatchGetFrameMetricData', batchGetFrameMetricData_profilingGroupName - The name of the profiling group associated with the the frame metrics
used to return the time series values.
data BatchGetFrameMetricDataResponse Source #
The structure representing the BatchGetFrameMetricDataResponse.
See: newBatchGetFrameMetricDataResponse smart constructor.
Constructors
| BatchGetFrameMetricDataResponse' Int POSIX [TimestampStructure] [FrameMetricDatum] AggregationPeriod POSIX (HashMap Text [TimestampStructure]) |
Instances
newBatchGetFrameMetricDataResponse Source #
Arguments
| :: Int | |
| -> UTCTime | |
| -> AggregationPeriod | |
| -> UTCTime | |
| -> BatchGetFrameMetricDataResponse |
Create a value of BatchGetFrameMetricDataResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:BatchGetFrameMetricDataResponse', batchGetFrameMetricDataResponse_httpStatus - The response's http status code.
$sel:endTime:BatchGetFrameMetricData', batchGetFrameMetricDataResponse_endTime - The end time of the time period for the returned time series values.
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.
$sel:endTimes:BatchGetFrameMetricDataResponse', batchGetFrameMetricDataResponse_endTimes - List of instances, or time steps, in the time series. For example, if
the period is one day (PT24H)), and the resolution is five minutes
(PT5M), then there are 288 endTimes in the list that are each five
minutes appart.
$sel:frameMetricData:BatchGetFrameMetricDataResponse', batchGetFrameMetricDataResponse_frameMetricData - Details of the metrics to request a time series of values. The metric
includes the name of the frame, the aggregation type to calculate the
metric value for the frame, and the thread states to use to get the
count for the metric value of the frame.
$sel:resolution:BatchGetFrameMetricDataResponse', batchGetFrameMetricDataResponse_resolution - Resolution or granularity of the profile data used to generate the time
series. This is the value used to jump through time steps in a time
series. There are 3 valid values.
P1D— 1 dayPT1H— 1 hourPT5M— 5 minutes
$sel:startTime:BatchGetFrameMetricData', batchGetFrameMetricDataResponse_startTime - The start time of the time period for the returned time series values.
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.
$sel:unprocessedEndTimes:BatchGetFrameMetricDataResponse', batchGetFrameMetricDataResponse_unprocessedEndTimes - List of instances which remained unprocessed. This will create a missing
time step in the list of end times.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the resource that contains the tags to
remove.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of tag keys. Existing tags of resources with keys in this list
are removed from the specified resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
GetFindingsReportAccountSummary
data GetFindingsReportAccountSummary Source #
The structure representing the GetFindingsReportAccountSummaryRequest.
See: newGetFindingsReportAccountSummary smart constructor.
Instances
newGetFindingsReportAccountSummary :: GetFindingsReportAccountSummary Source #
Create a value of GetFindingsReportAccountSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetFindingsReportAccountSummary', getFindingsReportAccountSummary_nextToken - The nextToken value returned from a previous paginated
GetFindingsReportAccountSummary request where maxResults was used
and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:dailyReportsOnly:GetFindingsReportAccountSummary', getFindingsReportAccountSummary_dailyReportsOnly - A Boolean value indicating whether to only return reports from daily
profiles. If set to True, only analysis data from daily profiles is
returned. If set to False, analysis data is returned from smaller time
windows (for example, one hour).
$sel:maxResults:GetFindingsReportAccountSummary', getFindingsReportAccountSummary_maxResults - The maximum number of results returned by
GetFindingsReportAccountSummary in paginated output. When this
parameter is used, GetFindingsReportAccountSummary only returns
maxResults results in a single page along with a nextToken response
element. The remaining results of the initial request can be seen by
sending another GetFindingsReportAccountSummary request with the
returned nextToken value.
data GetFindingsReportAccountSummaryResponse Source #
The structure representing the GetFindingsReportAccountSummaryResponse.
See: newGetFindingsReportAccountSummaryResponse smart constructor.
Constructors
| GetFindingsReportAccountSummaryResponse' (Maybe Text) Int [FindingsReportSummary] |
Instances
newGetFindingsReportAccountSummaryResponse Source #
Arguments
| :: Int | |
| -> GetFindingsReportAccountSummaryResponse |
Create a value of GetFindingsReportAccountSummaryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetFindingsReportAccountSummary', getFindingsReportAccountSummaryResponse_nextToken - The nextToken value to include in a future
GetFindingsReportAccountSummary request. When the results of a
GetFindingsReportAccountSummary request exceed maxResults, this
value can be used to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:httpStatus:GetFindingsReportAccountSummaryResponse', getFindingsReportAccountSummaryResponse_httpStatus - The response's http status code.
$sel:reportSummaries:GetFindingsReportAccountSummaryResponse', getFindingsReportAccountSummaryResponse_reportSummaries - The return list of
FindingsReportSummary
objects taht contain summaries of analysis results for all profiling
groups in your AWS account.
GetPolicy
The structure representing the getPolicyRequest.
See: newGetPolicy smart constructor.
Constructors
| GetPolicy' Text |
Instances
Create a value of GetPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profilingGroupName:GetPolicy', getPolicy_profilingGroupName - The name of the profiling group.
data GetPolicyResponse Source #
The structure representing the getPolicyResponse.
See: newGetPolicyResponse smart constructor.
Constructors
| GetPolicyResponse' Int Text Text |
Instances
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> GetPolicyResponse |
Create a value of GetPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetPolicyResponse', getPolicyResponse_httpStatus - The response's http status code.
$sel:policy:GetPolicyResponse', getPolicyResponse_policy - The JSON-formatted resource-based policy attached to the
ProfilingGroup.
$sel:revisionId:GetPolicyResponse', getPolicyResponse_revisionId - A unique identifier for the current revision of the returned policy.
ConfigureAgent
data ConfigureAgent Source #
The structure representing the configureAgentRequest.
See: newConfigureAgent smart constructor.
Constructors
| ConfigureAgent' (Maybe Text) (Maybe (HashMap MetadataField Text)) Text |
Instances
Arguments
| :: Text | |
| -> ConfigureAgent |
Create a value of ConfigureAgent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fleetInstanceId:ConfigureAgent', configureAgent_fleetInstanceId - A universally unique identifier (UUID) for a profiling instance. For
example, if the profiling instance is an Amazon EC2 instance, it is the
instance ID. If it is an AWS Fargate container, it is the container's
task ID.
$sel:metadata:ConfigureAgent', configureAgent_metadata - Metadata captured about the compute platform the agent is running on. It
includes information about sampling and reporting. The valid fields are:
COMPUTE_PLATFORM- The compute platform on which the agent is runningAGENT_ID- The ID for an agent instance.AWS_REQUEST_ID- The AWS request ID of a Lambda invocation.EXECUTION_ENVIRONMENT- The execution environment a Lambda function is running on.LAMBDA_FUNCTION_ARN- The Amazon Resource Name (ARN) that is used to invoke a Lambda function.LAMBDA_MEMORY_LIMIT_IN_MB- The memory allocated to a Lambda function.LAMBDA_REMAINING_TIME_IN_MILLISECONDS- The time in milliseconds before execution of a Lambda function times out.LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS- The time in milliseconds between two invocations of a Lambda function.LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS- The time in milliseconds for the previous Lambda invocation.
$sel:profilingGroupName:ConfigureAgent', configureAgent_profilingGroupName - The name of the profiling group for which the configured agent is
collecting profiling data.
data ConfigureAgentResponse Source #
The structure representing the configureAgentResponse.
See: newConfigureAgentResponse smart constructor.
Constructors
| ConfigureAgentResponse' Int AgentConfiguration |
Instances
newConfigureAgentResponse Source #
Arguments
| :: Int | |
| -> AgentConfiguration | |
| -> ConfigureAgentResponse |
Create a value of ConfigureAgentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ConfigureAgentResponse', configureAgentResponse_httpStatus - The response's http status code.
$sel:configuration:ConfigureAgentResponse', configureAgentResponse_configuration - An
AgentConfiguration
object that specifies if an agent profiles or not and for how long to
return profiling data.
Types
ActionGroup
newtype ActionGroup Source #
Constructors
| ActionGroup' | |
Fields | |
Bundled Patterns
| pattern ActionGroup_AgentPermissions :: ActionGroup |
Instances
AgentParameterField
newtype AgentParameterField Source #
Constructors
| AgentParameterField' | |
Fields | |
Bundled Patterns
Instances
AggregationPeriod
newtype AggregationPeriod Source #
Constructors
| AggregationPeriod' | |
Fields | |
Bundled Patterns
| pattern AggregationPeriod_P1D :: AggregationPeriod | |
| pattern AggregationPeriod_PT1H :: AggregationPeriod | |
| pattern AggregationPeriod_PT5M :: AggregationPeriod |
Instances
ComputePlatform
newtype ComputePlatform Source #
Constructors
| ComputePlatform' | |
Fields | |
Bundled Patterns
| pattern ComputePlatform_AWSLambda :: ComputePlatform | |
| pattern ComputePlatform_Default :: ComputePlatform |
Instances
EventPublisher
newtype EventPublisher Source #
Constructors
| EventPublisher' | |
Fields | |
Bundled Patterns
| pattern EventPublisher_AnomalyDetection :: EventPublisher |
Instances
FeedbackType
newtype FeedbackType Source #
Constructors
| FeedbackType' | |
Fields | |
Bundled Patterns
| pattern FeedbackType_Negative :: FeedbackType | |
| pattern FeedbackType_Positive :: FeedbackType |
Instances
MetadataField
newtype MetadataField Source #
Constructors
| MetadataField' | |
Fields | |
Bundled Patterns
| pattern MetadataField_AgentId :: MetadataField | |
| pattern MetadataField_AwsRequestId :: MetadataField | |
| pattern MetadataField_ComputePlatform :: MetadataField | |
| pattern MetadataField_ExecutionEnvironment :: MetadataField | |
| pattern MetadataField_LambdaFunctionArn :: MetadataField | |
| pattern MetadataField_LambdaMemoryLimitInMB :: MetadataField | |
| pattern MetadataField_LambdaPreviousExecutionTimeInMilliseconds :: MetadataField | |
| pattern MetadataField_LambdaRemainingTimeInMilliseconds :: MetadataField | |
| pattern MetadataField_LambdaTimeGapBetweenInvokesInMilliseconds :: MetadataField |
Instances
MetricType
newtype MetricType Source #
Constructors
| MetricType' | |
Fields | |
Bundled Patterns
| pattern MetricType_AggregatedRelativeTotalTime :: MetricType |
Instances
OrderBy
Constructors
| OrderBy' | |
Fields
| |
Bundled Patterns
| pattern OrderBy_TimestampAscending :: OrderBy | |
| pattern OrderBy_TimestampDescending :: OrderBy |
Instances
AgentConfiguration
data AgentConfiguration Source #
The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data.
See: newAgentConfiguration smart constructor.
Constructors
| AgentConfiguration' (Maybe (HashMap AgentParameterField Text)) Int Bool |
Instances
newAgentConfiguration Source #
Arguments
| :: Int | |
| -> Bool | |
| -> AgentConfiguration |
Create a value of AgentConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentParameters:AgentConfiguration', agentConfiguration_agentParameters - Parameters used by the profiler. The valid parameters are:
MaxStackDepth- The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a methodA, which calls methodB, which calls methodC, which calls methodD, then the depth is 4. If themaxDepthis set to 2, then the profiler evaluatesAandB.MemoryUsageLimitPercent- The percentage of memory that is used by the profiler.MinimumTimeForReportingInMilliseconds- The minimum time in milliseconds between sending reports.ReportingIntervalInMilliseconds- The reporting interval in milliseconds used to report profiles.SamplingIntervalInMilliseconds- The sampling interval in milliseconds that is used to profile samples.
$sel:periodInSeconds:AgentConfiguration', agentConfiguration_periodInSeconds - How long a profiling agent should send profiling data using
ConfigureAgent
. For example, if this is set to 300, the profiling agent calls
ConfigureAgent
every 5 minutes to submit the profiled data collected during that
period.
$sel:shouldProfile:AgentConfiguration', agentConfiguration_shouldProfile - A Boolean that specifies whether the profiling agent collects
profiling data or not. Set to true to enable profiling.
AgentOrchestrationConfig
data AgentOrchestrationConfig Source #
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.
See: newAgentOrchestrationConfig smart constructor.
Constructors
| AgentOrchestrationConfig' Bool |
Instances
newAgentOrchestrationConfig Source #
Create a value of AgentOrchestrationConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profilingEnabled:AgentOrchestrationConfig', agentOrchestrationConfig_profilingEnabled - A Boolean that specifies whether the profiling agent collects
profiling data or not. Set to true to enable profiling.
AggregatedProfileTime
data AggregatedProfileTime Source #
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).
See: newAggregatedProfileTime smart constructor.
Constructors
| AggregatedProfileTime' (Maybe AggregationPeriod) (Maybe POSIX) |
Instances
newAggregatedProfileTime :: AggregatedProfileTime Source #
Create a value of AggregatedProfileTime with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:period:AggregatedProfileTime', aggregatedProfileTime_period - The aggregation period. This indicates the period during which an
aggregation profile collects posted agent profiles for a profiling
group. Use one of three valid durations that are specified using the ISO
8601 format.
P1D— 1 dayPT1H— 1 hourPT5M— 5 minutes
$sel:start:AggregatedProfileTime', aggregatedProfileTime_start - The time that aggregation of posted agent profiles for a profiling group
starts. The aggregation profile contains profiles posted by the agent
starting at this time for an aggregation period specified by the
period property of the AggregatedProfileTime object.
Specify start 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.
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.
See: newAnomaly smart constructor.
Constructors
| Anomaly' [AnomalyInstance] Metric Text |
Instances
| Eq Anomaly Source # | |
| Read Anomaly Source # | |
| Show Anomaly Source # | |
| Generic Anomaly Source # | |
| NFData Anomaly Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Anomaly | |
| Hashable Anomaly Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Anomaly | |
| FromJSON Anomaly Source # | |
| type Rep Anomaly Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Anomaly type Rep Anomaly = D1 ('MetaData "Anomaly" "Amazonka.CodeGuruProfiler.Types.Anomaly" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "Anomaly'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AnomalyInstance]) :*: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Metric) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Anomaly with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instances:Anomaly', anomaly_instances - A list of the instances of the detected anomalies during the requested
period.
$sel:metric:Anomaly', anomaly_metric - Details about the metric that the analysis used when it detected the
anomaly. The metric includes the name of the frame that was analyzed
with the type and thread states used to derive the metric value for that
frame.
$sel:reason:Anomaly', anomaly_reason - The reason for which metric was flagged as anomalous.
AnomalyInstance
data AnomalyInstance Source #
The specific duration in which the metric is flagged as anomalous.
See: newAnomalyInstance smart constructor.
Constructors
| AnomalyInstance' (Maybe POSIX) (Maybe UserFeedback) Text POSIX |
Instances
Create a value of AnomalyInstance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:AnomalyInstance', anomalyInstance_endTime - The end time of the period during which the metric is flagged as
anomalous. 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.
$sel:userFeedback:AnomalyInstance', anomalyInstance_userFeedback - Feedback type on a specific instance of anomaly submitted by the user.
$sel:id:AnomalyInstance', anomalyInstance_id - The universally unique identifier (UUID) of an instance of an anomaly in
a metric.
$sel:startTime:AnomalyInstance', anomalyInstance_startTime - The start time of the period during which the metric is flagged as
anomalous. 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.
Channel
Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.
See: newChannel smart constructor.
Instances
| Eq Channel Source # | |
| Read Channel Source # | |
| Show Channel Source # | |
| Generic Channel Source # | |
| NFData Channel Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Channel | |
| Hashable Channel Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Channel | |
| ToJSON Channel Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Channel | |
| FromJSON Channel Source # | |
| type Rep Channel Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Channel type Rep Channel = D1 ('MetaData "Channel" "Amazonka.CodeGuruProfiler.Types.Channel" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "Channel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "eventPublishers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty EventPublisher)) :*: S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Channel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:Channel', channel_id - Unique identifier for each Channel in the notification configuration
of a Profiling Group. A random UUID for channelId is used when adding a
channel to the notification configuration if not specified in the
request.
$sel:eventPublishers:Channel', channel_eventPublishers - List of publishers for different type of events that may be detected in
an application from the profile. Anomaly detection is the only event
publisher in Profiler.
$sel:uri:Channel', channel_uri - Unique arn of the resource to be used for notifications. We support a
valid SNS topic arn as a channel uri.
FindingsReportSummary
data FindingsReportSummary Source #
Information about potential recommendations that might be created from the analysis of profiling data.
See: newFindingsReportSummary smart constructor.
Constructors
| FindingsReportSummary' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Int) |
Instances
newFindingsReportSummary :: FindingsReportSummary Source #
Create a value of FindingsReportSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:profileStartTime:FindingsReportSummary', findingsReportSummary_profileStartTime - The start time of the profile the analysis data is about. 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.
$sel:profileEndTime:FindingsReportSummary', findingsReportSummary_profileEndTime - The end time of the period during which the metric is flagged as
anomalous. 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.
$sel:id:FindingsReportSummary', findingsReportSummary_id - The universally unique identifier (UUID) of the recommendation report.
$sel:profilingGroupName:FindingsReportSummary', findingsReportSummary_profilingGroupName - The name of the profiling group that is associated with the analysis
data.
$sel:totalNumberOfFindings:FindingsReportSummary', findingsReportSummary_totalNumberOfFindings - The total number of different recommendations that were found by the
analysis.
FrameMetric
data FrameMetric Source #
The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.
See: newFrameMetric smart constructor.
Constructors
| FrameMetric' Text [Text] MetricType |
Instances
Create a value of FrameMetric with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:frameName:FrameMetric', frameMetric_frameName - Name of the method common across the multiple occurrences of a frame in
an application profile.
$sel:threadStates:FrameMetric', frameMetric_threadStates - List of application runtime thread states used to get the counts for a
frame a derive a metric value.
$sel:type':FrameMetric', frameMetric_type - A type of aggregation that specifies how a metric for a frame is
analyzed. The supported value AggregatedRelativeTotalTime is an
aggregation of the metric value for one frame that is calculated across
the occurrences of all frames in a profile.
FrameMetricDatum
data FrameMetricDatum Source #
Information about a frame metric and its values.
See: newFrameMetricDatum smart constructor.
Constructors
| FrameMetricDatum' FrameMetric [Double] |
Instances
Create a value of FrameMetricDatum with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:frameMetric:FrameMetricDatum', frameMetricDatum_frameMetric - Undocumented member.
$sel:values:FrameMetricDatum', frameMetricDatum_values - A list of values that are associated with a frame metric.
Match
The part of a profile that contains a recommendation found during analysis.
See: newMatch smart constructor.
Instances
| Eq Match Source # | |
| Read Match Source # | |
| Show Match Source # | |
| Generic Match Source # | |
| NFData Match Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Match | |
| Hashable Match Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Match | |
| FromJSON Match Source # | |
| type Rep Match Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Match type Rep Match = D1 ('MetaData "Match" "Amazonka.CodeGuruProfiler.Types.Match" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "Match'" 'PrefixI 'True) (S1 ('MetaSel ('Just "thresholdBreachValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "frameAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetFramesIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) | |
Create a value of Match with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:thresholdBreachValue:Match', match_thresholdBreachValue - The value in the profile data that exceeded the recommendation
threshold.
$sel:frameAddress:Match', match_frameAddress - The location in the profiling graph that contains a recommendation found
during analysis.
$sel:targetFramesIndex:Match', match_targetFramesIndex - The target frame that triggered a match.
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.
See: newMetric smart constructor.
Constructors
| Metric' Text [Text] MetricType |
Instances
| Eq Metric Source # | |
| Read Metric Source # | |
| Show Metric Source # | |
| Generic Metric Source # | |
| NFData Metric Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Metric | |
| Hashable Metric Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Metric | |
| FromJSON Metric Source # | |
| type Rep Metric Source # | |
Defined in Amazonka.CodeGuruProfiler.Types.Metric type Rep Metric = D1 ('MetaData "Metric" "Amazonka.CodeGuruProfiler.Types.Metric" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "Metric'" 'PrefixI 'True) (S1 ('MetaSel ('Just "frameName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "threadStates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricType)))) | |
Arguments
| :: Text | |
| -> MetricType | |
| -> Metric |
Create a value of Metric with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:frameName:Metric', metric_frameName - The name of the method that appears as a frame in any stack in a
profile.
$sel:threadStates:Metric', metric_threadStates - The list of application runtime thread states that is used to calculate
the metric value for the frame.
$sel:type':Metric', metric_type - A type that specifies how a metric for a frame is analyzed. The
supported value AggregatedRelativeTotalTime is an aggregation of the
metric value for one frame that is calculated across the occurences of
all frames in a profile.
NotificationConfiguration
data NotificationConfiguration Source #
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.
See: newNotificationConfiguration smart constructor.
Constructors
| NotificationConfiguration' (Maybe (NonEmpty Channel)) |
Instances
newNotificationConfiguration :: NotificationConfiguration Source #
Create a value of NotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channels:NotificationConfiguration', notificationConfiguration_channels - List of up to two channels to be used for sending notifications for
events detected from the application profile.
Pattern
A set of rules used to make a recommendation during an analysis.
See: newPattern smart constructor.
Constructors
| Pattern' (Maybe Double) (Maybe [[Text]]) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newPattern :: Pattern Source #
Create a value of Pattern with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:thresholdPercent:Pattern', pattern_thresholdPercent - The percentage of time an application spends in one method that triggers
a recommendation. The percentage of time is the same as the percentage
of the total gathered sample counts during analysis.
$sel:targetFrames:Pattern', pattern_targetFrames - A list of frame names that were searched during the analysis that
generated a recommendation.
$sel:countersToAggregate:Pattern', pattern_countersToAggregate - A list of the different counters used to determine if there is a match.
$sel:name:Pattern', pattern_name - The name for this pattern.
$sel:resolutionSteps:Pattern', pattern_resolutionSteps - A string that contains the steps recommended to address the potential
inefficiency.
$sel:id:Pattern', pattern_id - The universally unique identifier (UUID) of this pattern.
$sel:description:Pattern', pattern_description - The description of the recommendation. This explains a potential
inefficiency in a profiled application.
ProfileTime
data ProfileTime Source #
Contains the start time of a profile.
See: newProfileTime smart constructor.
Constructors
| ProfileTime' (Maybe POSIX) |
Instances
newProfileTime :: ProfileTime Source #
Create a value of ProfileTime with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:start:ProfileTime', profileTime_start - The start time of a profile. It 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.
ProfilingGroupDescription
data ProfilingGroupDescription Source #
Contains information about a profiling group.
See: newProfilingGroupDescription smart constructor.
Constructors
| ProfilingGroupDescription' (Maybe ComputePlatform) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ProfilingStatus) (Maybe POSIX) (Maybe AgentOrchestrationConfig) (Maybe (HashMap Text Text)) |
Instances
newProfilingGroupDescription :: ProfilingGroupDescription Source #
Create a value of ProfilingGroupDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:computePlatform:ProfilingGroupDescription', profilingGroupDescription_computePlatform - The compute platform of the profiling group. If it is set to
AWSLambda, then the profiled application runs on AWS Lambda. If it is
set to Default, then the profiled application runs on a compute
platform that is not AWS Lambda, such an Amazon EC2 instance, an
on-premises server, or a different platform. The default is Default.
$sel:arn:ProfilingGroupDescription', profilingGroupDescription_arn - The Amazon Resource Name (ARN) identifying the profiling group resource.
$sel:createdAt:ProfilingGroupDescription', profilingGroupDescription_createdAt - The time when the profiling group was created. Specify 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.
$sel:name:ProfilingGroupDescription', profilingGroupDescription_name - The name of the profiling group.
$sel:profilingStatus:ProfilingGroupDescription', profilingGroupDescription_profilingStatus - A
ProfilingStatus
object that 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.
$sel:updatedAt:ProfilingGroupDescription', profilingGroupDescription_updatedAt - The date and time when the profiling group was last updated. Specify
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.
$sel:agentOrchestrationConfig:ProfilingGroupDescription', profilingGroupDescription_agentOrchestrationConfig - An
AgentOrchestrationConfig
object that indicates if the profiling group is enabled for profiled or
not.
$sel:tags:ProfilingGroupDescription', profilingGroupDescription_tags - A list of the tags that belong to this profiling group.
ProfilingStatus
data ProfilingStatus Source #
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.
See: newProfilingStatus smart constructor.
Constructors
| ProfilingStatus' (Maybe POSIX) (Maybe POSIX) (Maybe AggregatedProfileTime) |
Instances
newProfilingStatus :: ProfilingStatus Source #
Create a value of ProfilingStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latestAgentOrchestratedAt:ProfilingStatus', profilingStatus_latestAgentOrchestratedAt - The date and time when the profiling agent most recently pinged back.
Specify 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.
$sel:latestAgentProfileReportedAt:ProfilingStatus', profilingStatus_latestAgentProfileReportedAt - The date and time when the most recent profile was received. Specify
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.
$sel:latestAggregatedProfile:ProfilingStatus', profilingStatus_latestAggregatedProfile - An
AggregatedProfileTime
object that contains the aggregation period and start time for an
aggregated profile.
Recommendation
data Recommendation Source #
A potential improvement that was found from analyzing the profiling data.
See: newRecommendation smart constructor.
Instances
Create a value of Recommendation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allMatchesCount:Recommendation', recommendation_allMatchesCount - How many different places in the profile graph triggered a match.
$sel:allMatchesSum:Recommendation', recommendation_allMatchesSum - How much of the total sample count is potentially affected.
$sel:endTime:Recommendation', recommendation_endTime - End time of the profile that was used by this analysis. 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.
$sel:pattern':Recommendation', recommendation_pattern - The pattern that analysis recognized in the profile to make this
recommendation.
$sel:startTime:Recommendation', recommendation_startTime - The start time of the profile that was used by this analysis. 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.
$sel:topMatches:Recommendation', recommendation_topMatches - List of the matches with most impact.
TimestampStructure
data TimestampStructure Source #
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.
See: newTimestampStructure smart constructor.
Constructors
| TimestampStructure' POSIX |
Instances
newTimestampStructure Source #
Arguments
| :: UTCTime | |
| -> TimestampStructure |
Create a value of TimestampStructure with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:TimestampStructure', timestampStructure_value - A Timestamp. 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
data UserFeedback Source #
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.
See: newUserFeedback smart constructor.
Constructors
| UserFeedback' FeedbackType |
Instances
Arguments
| :: FeedbackType | |
| -> UserFeedback |
Create a value of UserFeedback with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':UserFeedback', userFeedback_type - Optional Positive or Negative feedback submitted by the user about
whether the recommendation is useful or not.