| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.XRay.Types
Contents
- Service Configuration
- Errors
- EncryptionStatus
- EncryptionType
- InsightCategory
- InsightState
- SamplingStrategyName
- TimeRangeType
- Alias
- AnnotationValue
- AnomalousService
- AvailabilityZoneDetail
- BackendConnectionErrors
- Edge
- EdgeStatistics
- EncryptionConfig
- ErrorRootCause
- ErrorRootCauseEntity
- ErrorRootCauseService
- ErrorStatistics
- FaultRootCause
- FaultRootCauseEntity
- FaultRootCauseService
- FaultStatistics
- ForecastStatistics
- Group
- GroupSummary
- HistogramEntry
- Http
- Insight
- InsightEvent
- InsightImpactGraphEdge
- InsightImpactGraphService
- InsightSummary
- InsightsConfiguration
- InstanceIdDetail
- RequestImpactStatistics
- ResourceARNDetail
- ResourcePolicy
- ResponseTimeRootCause
- ResponseTimeRootCauseEntity
- ResponseTimeRootCauseService
- RootCauseException
- SamplingRule
- SamplingRuleRecord
- SamplingRuleUpdate
- SamplingStatisticSummary
- SamplingStatisticsDocument
- SamplingStrategy
- SamplingTargetDocument
- Segment
- ServiceId
- ServiceInfo
- ServiceStatistics
- Tag
- TelemetryRecord
- TimeSeriesServiceStatistics
- Trace
- TraceSummary
- TraceUser
- UnprocessedStatistics
- UnprocessedTraceSegment
- ValueWithServiceIds
Description
Synopsis
- defaultService :: Service
- _InvalidPolicyRevisionIdException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _LockoutPreventionException :: AsError a => Fold a ServiceError
- _MalformedPolicyDocumentException :: AsError a => Fold a ServiceError
- _PolicyCountLimitExceededException :: AsError a => Fold a ServiceError
- _PolicySizeLimitExceededException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _RuleLimitExceededException :: AsError a => Fold a ServiceError
- _ThrottledException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- newtype EncryptionStatus where
- EncryptionStatus' { }
- pattern EncryptionStatus_ACTIVE :: EncryptionStatus
- pattern EncryptionStatus_UPDATING :: EncryptionStatus
- newtype EncryptionType where
- EncryptionType' { }
- pattern EncryptionType_KMS :: EncryptionType
- pattern EncryptionType_NONE :: EncryptionType
- newtype InsightCategory where
- InsightCategory' { }
- pattern InsightCategory_FAULT :: InsightCategory
- newtype InsightState where
- InsightState' { }
- pattern InsightState_ACTIVE :: InsightState
- pattern InsightState_CLOSED :: InsightState
- newtype SamplingStrategyName where
- newtype TimeRangeType where
- TimeRangeType' { }
- pattern TimeRangeType_Event :: TimeRangeType
- pattern TimeRangeType_TraceId :: TimeRangeType
- data Alias = Alias' {}
- newAlias :: Alias
- alias_name :: Lens' Alias (Maybe Text)
- alias_names :: Lens' Alias (Maybe [Text])
- alias_type :: Lens' Alias (Maybe Text)
- data AnnotationValue = AnnotationValue' {}
- newAnnotationValue :: AnnotationValue
- annotationValue_booleanValue :: Lens' AnnotationValue (Maybe Bool)
- annotationValue_numberValue :: Lens' AnnotationValue (Maybe Double)
- annotationValue_stringValue :: Lens' AnnotationValue (Maybe Text)
- data AnomalousService = AnomalousService' {}
- newAnomalousService :: AnomalousService
- anomalousService_serviceId :: Lens' AnomalousService (Maybe ServiceId)
- data AvailabilityZoneDetail = AvailabilityZoneDetail' {}
- newAvailabilityZoneDetail :: AvailabilityZoneDetail
- availabilityZoneDetail_name :: Lens' AvailabilityZoneDetail (Maybe Text)
- data BackendConnectionErrors = BackendConnectionErrors' {}
- newBackendConnectionErrors :: BackendConnectionErrors
- backendConnectionErrors_connectionRefusedCount :: Lens' BackendConnectionErrors (Maybe Int)
- backendConnectionErrors_hTTPCode4XXCount :: Lens' BackendConnectionErrors (Maybe Int)
- backendConnectionErrors_hTTPCode5XXCount :: Lens' BackendConnectionErrors (Maybe Int)
- backendConnectionErrors_otherCount :: Lens' BackendConnectionErrors (Maybe Int)
- backendConnectionErrors_timeoutCount :: Lens' BackendConnectionErrors (Maybe Int)
- backendConnectionErrors_unknownHostCount :: Lens' BackendConnectionErrors (Maybe Int)
- data Edge = Edge' {}
- newEdge :: Edge
- edge_aliases :: Lens' Edge (Maybe [Alias])
- edge_edgeType :: Lens' Edge (Maybe Text)
- edge_endTime :: Lens' Edge (Maybe UTCTime)
- edge_receivedEventAgeHistogram :: Lens' Edge (Maybe [HistogramEntry])
- edge_referenceId :: Lens' Edge (Maybe Int)
- edge_responseTimeHistogram :: Lens' Edge (Maybe [HistogramEntry])
- edge_startTime :: Lens' Edge (Maybe UTCTime)
- edge_summaryStatistics :: Lens' Edge (Maybe EdgeStatistics)
- data EdgeStatistics = EdgeStatistics' {}
- newEdgeStatistics :: EdgeStatistics
- edgeStatistics_errorStatistics :: Lens' EdgeStatistics (Maybe ErrorStatistics)
- edgeStatistics_faultStatistics :: Lens' EdgeStatistics (Maybe FaultStatistics)
- edgeStatistics_okCount :: Lens' EdgeStatistics (Maybe Integer)
- edgeStatistics_totalCount :: Lens' EdgeStatistics (Maybe Integer)
- edgeStatistics_totalResponseTime :: Lens' EdgeStatistics (Maybe Double)
- data EncryptionConfig = EncryptionConfig' {}
- newEncryptionConfig :: EncryptionConfig
- encryptionConfig_keyId :: Lens' EncryptionConfig (Maybe Text)
- encryptionConfig_status :: Lens' EncryptionConfig (Maybe EncryptionStatus)
- encryptionConfig_type :: Lens' EncryptionConfig (Maybe EncryptionType)
- data ErrorRootCause = ErrorRootCause' {}
- newErrorRootCause :: ErrorRootCause
- errorRootCause_clientImpacting :: Lens' ErrorRootCause (Maybe Bool)
- errorRootCause_services :: Lens' ErrorRootCause (Maybe [ErrorRootCauseService])
- data ErrorRootCauseEntity = ErrorRootCauseEntity' {
- exceptions :: Maybe [RootCauseException]
- name :: Maybe Text
- remote :: Maybe Bool
- newErrorRootCauseEntity :: ErrorRootCauseEntity
- errorRootCauseEntity_exceptions :: Lens' ErrorRootCauseEntity (Maybe [RootCauseException])
- errorRootCauseEntity_name :: Lens' ErrorRootCauseEntity (Maybe Text)
- errorRootCauseEntity_remote :: Lens' ErrorRootCauseEntity (Maybe Bool)
- data ErrorRootCauseService = ErrorRootCauseService' {}
- newErrorRootCauseService :: ErrorRootCauseService
- errorRootCauseService_accountId :: Lens' ErrorRootCauseService (Maybe Text)
- errorRootCauseService_entityPath :: Lens' ErrorRootCauseService (Maybe [ErrorRootCauseEntity])
- errorRootCauseService_inferred :: Lens' ErrorRootCauseService (Maybe Bool)
- errorRootCauseService_name :: Lens' ErrorRootCauseService (Maybe Text)
- errorRootCauseService_names :: Lens' ErrorRootCauseService (Maybe [Text])
- errorRootCauseService_type :: Lens' ErrorRootCauseService (Maybe Text)
- data ErrorStatistics = ErrorStatistics' {}
- newErrorStatistics :: ErrorStatistics
- errorStatistics_otherCount :: Lens' ErrorStatistics (Maybe Integer)
- errorStatistics_throttleCount :: Lens' ErrorStatistics (Maybe Integer)
- errorStatistics_totalCount :: Lens' ErrorStatistics (Maybe Integer)
- data FaultRootCause = FaultRootCause' {}
- newFaultRootCause :: FaultRootCause
- faultRootCause_clientImpacting :: Lens' FaultRootCause (Maybe Bool)
- faultRootCause_services :: Lens' FaultRootCause (Maybe [FaultRootCauseService])
- data FaultRootCauseEntity = FaultRootCauseEntity' {
- exceptions :: Maybe [RootCauseException]
- name :: Maybe Text
- remote :: Maybe Bool
- newFaultRootCauseEntity :: FaultRootCauseEntity
- faultRootCauseEntity_exceptions :: Lens' FaultRootCauseEntity (Maybe [RootCauseException])
- faultRootCauseEntity_name :: Lens' FaultRootCauseEntity (Maybe Text)
- faultRootCauseEntity_remote :: Lens' FaultRootCauseEntity (Maybe Bool)
- data FaultRootCauseService = FaultRootCauseService' {}
- newFaultRootCauseService :: FaultRootCauseService
- faultRootCauseService_accountId :: Lens' FaultRootCauseService (Maybe Text)
- faultRootCauseService_entityPath :: Lens' FaultRootCauseService (Maybe [FaultRootCauseEntity])
- faultRootCauseService_inferred :: Lens' FaultRootCauseService (Maybe Bool)
- faultRootCauseService_name :: Lens' FaultRootCauseService (Maybe Text)
- faultRootCauseService_names :: Lens' FaultRootCauseService (Maybe [Text])
- faultRootCauseService_type :: Lens' FaultRootCauseService (Maybe Text)
- data FaultStatistics = FaultStatistics' {}
- newFaultStatistics :: FaultStatistics
- faultStatistics_otherCount :: Lens' FaultStatistics (Maybe Integer)
- faultStatistics_totalCount :: Lens' FaultStatistics (Maybe Integer)
- data ForecastStatistics = ForecastStatistics' {}
- newForecastStatistics :: ForecastStatistics
- forecastStatistics_faultCountHigh :: Lens' ForecastStatistics (Maybe Integer)
- forecastStatistics_faultCountLow :: Lens' ForecastStatistics (Maybe Integer)
- data Group = Group' {}
- newGroup :: Group
- group_filterExpression :: Lens' Group (Maybe Text)
- group_groupARN :: Lens' Group (Maybe Text)
- group_groupName :: Lens' Group (Maybe Text)
- group_insightsConfiguration :: Lens' Group (Maybe InsightsConfiguration)
- data GroupSummary = GroupSummary' {}
- newGroupSummary :: GroupSummary
- groupSummary_filterExpression :: Lens' GroupSummary (Maybe Text)
- groupSummary_groupARN :: Lens' GroupSummary (Maybe Text)
- groupSummary_groupName :: Lens' GroupSummary (Maybe Text)
- groupSummary_insightsConfiguration :: Lens' GroupSummary (Maybe InsightsConfiguration)
- data HistogramEntry = HistogramEntry' {}
- newHistogramEntry :: HistogramEntry
- histogramEntry_count :: Lens' HistogramEntry (Maybe Int)
- histogramEntry_value :: Lens' HistogramEntry (Maybe Double)
- data Http = Http' {}
- newHttp :: Http
- http_clientIp :: Lens' Http (Maybe Text)
- http_httpMethod :: Lens' Http (Maybe Text)
- http_httpStatus :: Lens' Http (Maybe Int)
- http_httpURL :: Lens' Http (Maybe Text)
- http_userAgent :: Lens' Http (Maybe Text)
- data Insight = Insight' {
- categories :: Maybe [InsightCategory]
- clientRequestImpactStatistics :: Maybe RequestImpactStatistics
- endTime :: Maybe POSIX
- groupARN :: Maybe Text
- groupName :: Maybe Text
- insightId :: Maybe Text
- rootCauseServiceId :: Maybe ServiceId
- rootCauseServiceRequestImpactStatistics :: Maybe RequestImpactStatistics
- startTime :: Maybe POSIX
- state :: Maybe InsightState
- summary :: Maybe Text
- topAnomalousServices :: Maybe [AnomalousService]
- newInsight :: Insight
- insight_categories :: Lens' Insight (Maybe [InsightCategory])
- insight_clientRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics)
- insight_endTime :: Lens' Insight (Maybe UTCTime)
- insight_groupARN :: Lens' Insight (Maybe Text)
- insight_groupName :: Lens' Insight (Maybe Text)
- insight_insightId :: Lens' Insight (Maybe Text)
- insight_rootCauseServiceId :: Lens' Insight (Maybe ServiceId)
- insight_rootCauseServiceRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics)
- insight_startTime :: Lens' Insight (Maybe UTCTime)
- insight_state :: Lens' Insight (Maybe InsightState)
- insight_summary :: Lens' Insight (Maybe Text)
- insight_topAnomalousServices :: Lens' Insight (Maybe [AnomalousService])
- data InsightEvent = InsightEvent' {}
- newInsightEvent :: InsightEvent
- insightEvent_clientRequestImpactStatistics :: Lens' InsightEvent (Maybe RequestImpactStatistics)
- insightEvent_eventTime :: Lens' InsightEvent (Maybe UTCTime)
- insightEvent_rootCauseServiceRequestImpactStatistics :: Lens' InsightEvent (Maybe RequestImpactStatistics)
- insightEvent_summary :: Lens' InsightEvent (Maybe Text)
- insightEvent_topAnomalousServices :: Lens' InsightEvent (Maybe [AnomalousService])
- data InsightImpactGraphEdge = InsightImpactGraphEdge' {
- referenceId :: Maybe Int
- newInsightImpactGraphEdge :: InsightImpactGraphEdge
- insightImpactGraphEdge_referenceId :: Lens' InsightImpactGraphEdge (Maybe Int)
- data InsightImpactGraphService = InsightImpactGraphService' {}
- newInsightImpactGraphService :: InsightImpactGraphService
- insightImpactGraphService_accountId :: Lens' InsightImpactGraphService (Maybe Text)
- insightImpactGraphService_edges :: Lens' InsightImpactGraphService (Maybe [InsightImpactGraphEdge])
- insightImpactGraphService_name :: Lens' InsightImpactGraphService (Maybe Text)
- insightImpactGraphService_names :: Lens' InsightImpactGraphService (Maybe [Text])
- insightImpactGraphService_referenceId :: Lens' InsightImpactGraphService (Maybe Int)
- insightImpactGraphService_type :: Lens' InsightImpactGraphService (Maybe Text)
- data InsightSummary = InsightSummary' {
- categories :: Maybe [InsightCategory]
- clientRequestImpactStatistics :: Maybe RequestImpactStatistics
- endTime :: Maybe POSIX
- groupARN :: Maybe Text
- groupName :: Maybe Text
- insightId :: Maybe Text
- lastUpdateTime :: Maybe POSIX
- rootCauseServiceId :: Maybe ServiceId
- rootCauseServiceRequestImpactStatistics :: Maybe RequestImpactStatistics
- startTime :: Maybe POSIX
- state :: Maybe InsightState
- summary :: Maybe Text
- topAnomalousServices :: Maybe [AnomalousService]
- newInsightSummary :: InsightSummary
- insightSummary_categories :: Lens' InsightSummary (Maybe [InsightCategory])
- insightSummary_clientRequestImpactStatistics :: Lens' InsightSummary (Maybe RequestImpactStatistics)
- insightSummary_endTime :: Lens' InsightSummary (Maybe UTCTime)
- insightSummary_groupARN :: Lens' InsightSummary (Maybe Text)
- insightSummary_groupName :: Lens' InsightSummary (Maybe Text)
- insightSummary_insightId :: Lens' InsightSummary (Maybe Text)
- insightSummary_lastUpdateTime :: Lens' InsightSummary (Maybe UTCTime)
- insightSummary_rootCauseServiceId :: Lens' InsightSummary (Maybe ServiceId)
- insightSummary_rootCauseServiceRequestImpactStatistics :: Lens' InsightSummary (Maybe RequestImpactStatistics)
- insightSummary_startTime :: Lens' InsightSummary (Maybe UTCTime)
- insightSummary_state :: Lens' InsightSummary (Maybe InsightState)
- insightSummary_summary :: Lens' InsightSummary (Maybe Text)
- insightSummary_topAnomalousServices :: Lens' InsightSummary (Maybe [AnomalousService])
- data InsightsConfiguration = InsightsConfiguration' {}
- newInsightsConfiguration :: InsightsConfiguration
- insightsConfiguration_insightsEnabled :: Lens' InsightsConfiguration (Maybe Bool)
- insightsConfiguration_notificationsEnabled :: Lens' InsightsConfiguration (Maybe Bool)
- data InstanceIdDetail = InstanceIdDetail' {}
- newInstanceIdDetail :: InstanceIdDetail
- instanceIdDetail_id :: Lens' InstanceIdDetail (Maybe Text)
- data RequestImpactStatistics = RequestImpactStatistics' {}
- newRequestImpactStatistics :: RequestImpactStatistics
- requestImpactStatistics_faultCount :: Lens' RequestImpactStatistics (Maybe Integer)
- requestImpactStatistics_okCount :: Lens' RequestImpactStatistics (Maybe Integer)
- requestImpactStatistics_totalCount :: Lens' RequestImpactStatistics (Maybe Integer)
- data ResourceARNDetail = ResourceARNDetail' {}
- newResourceARNDetail :: ResourceARNDetail
- resourceARNDetail_arn :: Lens' ResourceARNDetail (Maybe Text)
- data ResourcePolicy = ResourcePolicy' {}
- newResourcePolicy :: ResourcePolicy
- resourcePolicy_lastUpdatedTime :: Lens' ResourcePolicy (Maybe UTCTime)
- resourcePolicy_policyDocument :: Lens' ResourcePolicy (Maybe Text)
- resourcePolicy_policyName :: Lens' ResourcePolicy (Maybe Text)
- resourcePolicy_policyRevisionId :: Lens' ResourcePolicy (Maybe Text)
- data ResponseTimeRootCause = ResponseTimeRootCause' {}
- newResponseTimeRootCause :: ResponseTimeRootCause
- responseTimeRootCause_clientImpacting :: Lens' ResponseTimeRootCause (Maybe Bool)
- responseTimeRootCause_services :: Lens' ResponseTimeRootCause (Maybe [ResponseTimeRootCauseService])
- data ResponseTimeRootCauseEntity = ResponseTimeRootCauseEntity' {}
- newResponseTimeRootCauseEntity :: ResponseTimeRootCauseEntity
- responseTimeRootCauseEntity_coverage :: Lens' ResponseTimeRootCauseEntity (Maybe Double)
- responseTimeRootCauseEntity_name :: Lens' ResponseTimeRootCauseEntity (Maybe Text)
- responseTimeRootCauseEntity_remote :: Lens' ResponseTimeRootCauseEntity (Maybe Bool)
- data ResponseTimeRootCauseService = ResponseTimeRootCauseService' {}
- newResponseTimeRootCauseService :: ResponseTimeRootCauseService
- responseTimeRootCauseService_accountId :: Lens' ResponseTimeRootCauseService (Maybe Text)
- responseTimeRootCauseService_entityPath :: Lens' ResponseTimeRootCauseService (Maybe [ResponseTimeRootCauseEntity])
- responseTimeRootCauseService_inferred :: Lens' ResponseTimeRootCauseService (Maybe Bool)
- responseTimeRootCauseService_name :: Lens' ResponseTimeRootCauseService (Maybe Text)
- responseTimeRootCauseService_names :: Lens' ResponseTimeRootCauseService (Maybe [Text])
- responseTimeRootCauseService_type :: Lens' ResponseTimeRootCauseService (Maybe Text)
- data RootCauseException = RootCauseException' {}
- newRootCauseException :: RootCauseException
- rootCauseException_message :: Lens' RootCauseException (Maybe Text)
- rootCauseException_name :: Lens' RootCauseException (Maybe Text)
- data SamplingRule = SamplingRule' {}
- newSamplingRule :: Text -> Natural -> Double -> Natural -> Text -> Text -> Text -> Text -> Text -> Natural -> SamplingRule
- samplingRule_attributes :: Lens' SamplingRule (Maybe (HashMap Text Text))
- samplingRule_ruleARN :: Lens' SamplingRule (Maybe Text)
- samplingRule_ruleName :: Lens' SamplingRule (Maybe Text)
- samplingRule_resourceARN :: Lens' SamplingRule Text
- samplingRule_priority :: Lens' SamplingRule Natural
- samplingRule_fixedRate :: Lens' SamplingRule Double
- samplingRule_reservoirSize :: Lens' SamplingRule Natural
- samplingRule_serviceName :: Lens' SamplingRule Text
- samplingRule_serviceType :: Lens' SamplingRule Text
- samplingRule_host :: Lens' SamplingRule Text
- samplingRule_hTTPMethod :: Lens' SamplingRule Text
- samplingRule_uRLPath :: Lens' SamplingRule Text
- samplingRule_version :: Lens' SamplingRule Natural
- data SamplingRuleRecord = SamplingRuleRecord' {}
- newSamplingRuleRecord :: SamplingRuleRecord
- samplingRuleRecord_createdAt :: Lens' SamplingRuleRecord (Maybe UTCTime)
- samplingRuleRecord_modifiedAt :: Lens' SamplingRuleRecord (Maybe UTCTime)
- samplingRuleRecord_samplingRule :: Lens' SamplingRuleRecord (Maybe SamplingRule)
- data SamplingRuleUpdate = SamplingRuleUpdate' {}
- newSamplingRuleUpdate :: SamplingRuleUpdate
- samplingRuleUpdate_attributes :: Lens' SamplingRuleUpdate (Maybe (HashMap Text Text))
- samplingRuleUpdate_fixedRate :: Lens' SamplingRuleUpdate (Maybe Double)
- samplingRuleUpdate_hTTPMethod :: Lens' SamplingRuleUpdate (Maybe Text)
- samplingRuleUpdate_host :: Lens' SamplingRuleUpdate (Maybe Text)
- samplingRuleUpdate_priority :: Lens' SamplingRuleUpdate (Maybe Int)
- samplingRuleUpdate_reservoirSize :: Lens' SamplingRuleUpdate (Maybe Int)
- samplingRuleUpdate_resourceARN :: Lens' SamplingRuleUpdate (Maybe Text)
- samplingRuleUpdate_ruleARN :: Lens' SamplingRuleUpdate (Maybe Text)
- samplingRuleUpdate_ruleName :: Lens' SamplingRuleUpdate (Maybe Text)
- samplingRuleUpdate_serviceName :: Lens' SamplingRuleUpdate (Maybe Text)
- samplingRuleUpdate_serviceType :: Lens' SamplingRuleUpdate (Maybe Text)
- samplingRuleUpdate_uRLPath :: Lens' SamplingRuleUpdate (Maybe Text)
- data SamplingStatisticSummary = SamplingStatisticSummary' {
- borrowCount :: Maybe Int
- requestCount :: Maybe Int
- ruleName :: Maybe Text
- sampledCount :: Maybe Int
- timestamp :: Maybe POSIX
- newSamplingStatisticSummary :: SamplingStatisticSummary
- samplingStatisticSummary_borrowCount :: Lens' SamplingStatisticSummary (Maybe Int)
- samplingStatisticSummary_requestCount :: Lens' SamplingStatisticSummary (Maybe Int)
- samplingStatisticSummary_ruleName :: Lens' SamplingStatisticSummary (Maybe Text)
- samplingStatisticSummary_sampledCount :: Lens' SamplingStatisticSummary (Maybe Int)
- samplingStatisticSummary_timestamp :: Lens' SamplingStatisticSummary (Maybe UTCTime)
- data SamplingStatisticsDocument = SamplingStatisticsDocument' {
- borrowCount :: Maybe Natural
- ruleName :: Text
- clientID :: Text
- timestamp :: POSIX
- requestCount :: Natural
- sampledCount :: Natural
- newSamplingStatisticsDocument :: Text -> Text -> UTCTime -> Natural -> Natural -> SamplingStatisticsDocument
- samplingStatisticsDocument_borrowCount :: Lens' SamplingStatisticsDocument (Maybe Natural)
- samplingStatisticsDocument_ruleName :: Lens' SamplingStatisticsDocument Text
- samplingStatisticsDocument_clientID :: Lens' SamplingStatisticsDocument Text
- samplingStatisticsDocument_timestamp :: Lens' SamplingStatisticsDocument UTCTime
- samplingStatisticsDocument_requestCount :: Lens' SamplingStatisticsDocument Natural
- samplingStatisticsDocument_sampledCount :: Lens' SamplingStatisticsDocument Natural
- data SamplingStrategy = SamplingStrategy' {}
- newSamplingStrategy :: SamplingStrategy
- samplingStrategy_name :: Lens' SamplingStrategy (Maybe SamplingStrategyName)
- samplingStrategy_value :: Lens' SamplingStrategy (Maybe Double)
- data SamplingTargetDocument = SamplingTargetDocument' {}
- newSamplingTargetDocument :: SamplingTargetDocument
- samplingTargetDocument_fixedRate :: Lens' SamplingTargetDocument (Maybe Double)
- samplingTargetDocument_interval :: Lens' SamplingTargetDocument (Maybe Int)
- samplingTargetDocument_reservoirQuota :: Lens' SamplingTargetDocument (Maybe Int)
- samplingTargetDocument_reservoirQuotaTTL :: Lens' SamplingTargetDocument (Maybe UTCTime)
- samplingTargetDocument_ruleName :: Lens' SamplingTargetDocument (Maybe Text)
- data Segment = Segment' {}
- newSegment :: Segment
- segment_document :: Lens' Segment (Maybe Text)
- segment_id :: Lens' Segment (Maybe Text)
- data ServiceId = ServiceId' {}
- newServiceId :: ServiceId
- serviceId_accountId :: Lens' ServiceId (Maybe Text)
- serviceId_name :: Lens' ServiceId (Maybe Text)
- serviceId_names :: Lens' ServiceId (Maybe [Text])
- serviceId_type :: Lens' ServiceId (Maybe Text)
- data ServiceInfo = ServiceInfo' {
- accountId :: Maybe Text
- durationHistogram :: Maybe [HistogramEntry]
- edges :: Maybe [Edge]
- endTime :: Maybe POSIX
- name :: Maybe Text
- names :: Maybe [Text]
- referenceId :: Maybe Int
- responseTimeHistogram :: Maybe [HistogramEntry]
- root :: Maybe Bool
- startTime :: Maybe POSIX
- state :: Maybe Text
- summaryStatistics :: Maybe ServiceStatistics
- type' :: Maybe Text
- newServiceInfo :: ServiceInfo
- serviceInfo_accountId :: Lens' ServiceInfo (Maybe Text)
- serviceInfo_durationHistogram :: Lens' ServiceInfo (Maybe [HistogramEntry])
- serviceInfo_edges :: Lens' ServiceInfo (Maybe [Edge])
- serviceInfo_endTime :: Lens' ServiceInfo (Maybe UTCTime)
- serviceInfo_name :: Lens' ServiceInfo (Maybe Text)
- serviceInfo_names :: Lens' ServiceInfo (Maybe [Text])
- serviceInfo_referenceId :: Lens' ServiceInfo (Maybe Int)
- serviceInfo_responseTimeHistogram :: Lens' ServiceInfo (Maybe [HistogramEntry])
- serviceInfo_root :: Lens' ServiceInfo (Maybe Bool)
- serviceInfo_startTime :: Lens' ServiceInfo (Maybe UTCTime)
- serviceInfo_state :: Lens' ServiceInfo (Maybe Text)
- serviceInfo_summaryStatistics :: Lens' ServiceInfo (Maybe ServiceStatistics)
- serviceInfo_type :: Lens' ServiceInfo (Maybe Text)
- data ServiceStatistics = ServiceStatistics' {}
- newServiceStatistics :: ServiceStatistics
- serviceStatistics_errorStatistics :: Lens' ServiceStatistics (Maybe ErrorStatistics)
- serviceStatistics_faultStatistics :: Lens' ServiceStatistics (Maybe FaultStatistics)
- serviceStatistics_okCount :: Lens' ServiceStatistics (Maybe Integer)
- serviceStatistics_totalCount :: Lens' ServiceStatistics (Maybe Integer)
- serviceStatistics_totalResponseTime :: Lens' ServiceStatistics (Maybe Double)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TelemetryRecord = TelemetryRecord' {}
- newTelemetryRecord :: UTCTime -> TelemetryRecord
- telemetryRecord_backendConnectionErrors :: Lens' TelemetryRecord (Maybe BackendConnectionErrors)
- telemetryRecord_segmentsReceivedCount :: Lens' TelemetryRecord (Maybe Int)
- telemetryRecord_segmentsRejectedCount :: Lens' TelemetryRecord (Maybe Int)
- telemetryRecord_segmentsSentCount :: Lens' TelemetryRecord (Maybe Int)
- telemetryRecord_segmentsSpilloverCount :: Lens' TelemetryRecord (Maybe Int)
- telemetryRecord_timestamp :: Lens' TelemetryRecord UTCTime
- data TimeSeriesServiceStatistics = TimeSeriesServiceStatistics' {}
- newTimeSeriesServiceStatistics :: TimeSeriesServiceStatistics
- timeSeriesServiceStatistics_edgeSummaryStatistics :: Lens' TimeSeriesServiceStatistics (Maybe EdgeStatistics)
- timeSeriesServiceStatistics_responseTimeHistogram :: Lens' TimeSeriesServiceStatistics (Maybe [HistogramEntry])
- timeSeriesServiceStatistics_serviceForecastStatistics :: Lens' TimeSeriesServiceStatistics (Maybe ForecastStatistics)
- timeSeriesServiceStatistics_serviceSummaryStatistics :: Lens' TimeSeriesServiceStatistics (Maybe ServiceStatistics)
- timeSeriesServiceStatistics_timestamp :: Lens' TimeSeriesServiceStatistics (Maybe UTCTime)
- data Trace = Trace' {}
- newTrace :: Trace
- trace_duration :: Lens' Trace (Maybe Double)
- trace_id :: Lens' Trace (Maybe Text)
- trace_limitExceeded :: Lens' Trace (Maybe Bool)
- trace_segments :: Lens' Trace (Maybe [Segment])
- data TraceSummary = TraceSummary' {
- annotations :: Maybe (HashMap Text [ValueWithServiceIds])
- availabilityZones :: Maybe [AvailabilityZoneDetail]
- duration :: Maybe Double
- entryPoint :: Maybe ServiceId
- errorRootCauses :: Maybe [ErrorRootCause]
- faultRootCauses :: Maybe [FaultRootCause]
- hasError :: Maybe Bool
- hasFault :: Maybe Bool
- hasThrottle :: Maybe Bool
- http :: Maybe Http
- id :: Maybe Text
- instanceIds :: Maybe [InstanceIdDetail]
- isPartial :: Maybe Bool
- matchedEventTime :: Maybe POSIX
- resourceARNs :: Maybe [ResourceARNDetail]
- responseTime :: Maybe Double
- responseTimeRootCauses :: Maybe [ResponseTimeRootCause]
- revision :: Maybe Int
- serviceIds :: Maybe [ServiceId]
- users :: Maybe [TraceUser]
- newTraceSummary :: TraceSummary
- traceSummary_annotations :: Lens' TraceSummary (Maybe (HashMap Text [ValueWithServiceIds]))
- traceSummary_availabilityZones :: Lens' TraceSummary (Maybe [AvailabilityZoneDetail])
- traceSummary_duration :: Lens' TraceSummary (Maybe Double)
- traceSummary_entryPoint :: Lens' TraceSummary (Maybe ServiceId)
- traceSummary_errorRootCauses :: Lens' TraceSummary (Maybe [ErrorRootCause])
- traceSummary_faultRootCauses :: Lens' TraceSummary (Maybe [FaultRootCause])
- traceSummary_hasError :: Lens' TraceSummary (Maybe Bool)
- traceSummary_hasFault :: Lens' TraceSummary (Maybe Bool)
- traceSummary_hasThrottle :: Lens' TraceSummary (Maybe Bool)
- traceSummary_http :: Lens' TraceSummary (Maybe Http)
- traceSummary_id :: Lens' TraceSummary (Maybe Text)
- traceSummary_instanceIds :: Lens' TraceSummary (Maybe [InstanceIdDetail])
- traceSummary_isPartial :: Lens' TraceSummary (Maybe Bool)
- traceSummary_matchedEventTime :: Lens' TraceSummary (Maybe UTCTime)
- traceSummary_resourceARNs :: Lens' TraceSummary (Maybe [ResourceARNDetail])
- traceSummary_responseTime :: Lens' TraceSummary (Maybe Double)
- traceSummary_responseTimeRootCauses :: Lens' TraceSummary (Maybe [ResponseTimeRootCause])
- traceSummary_revision :: Lens' TraceSummary (Maybe Int)
- traceSummary_serviceIds :: Lens' TraceSummary (Maybe [ServiceId])
- traceSummary_users :: Lens' TraceSummary (Maybe [TraceUser])
- data TraceUser = TraceUser' {}
- newTraceUser :: TraceUser
- traceUser_serviceIds :: Lens' TraceUser (Maybe [ServiceId])
- traceUser_userName :: Lens' TraceUser (Maybe Text)
- data UnprocessedStatistics = UnprocessedStatistics' {}
- newUnprocessedStatistics :: UnprocessedStatistics
- unprocessedStatistics_errorCode :: Lens' UnprocessedStatistics (Maybe Text)
- unprocessedStatistics_message :: Lens' UnprocessedStatistics (Maybe Text)
- unprocessedStatistics_ruleName :: Lens' UnprocessedStatistics (Maybe Text)
- data UnprocessedTraceSegment = UnprocessedTraceSegment' {}
- newUnprocessedTraceSegment :: UnprocessedTraceSegment
- unprocessedTraceSegment_errorCode :: Lens' UnprocessedTraceSegment (Maybe Text)
- unprocessedTraceSegment_id :: Lens' UnprocessedTraceSegment (Maybe Text)
- unprocessedTraceSegment_message :: Lens' UnprocessedTraceSegment (Maybe Text)
- data ValueWithServiceIds = ValueWithServiceIds' {}
- newValueWithServiceIds :: ValueWithServiceIds
- valueWithServiceIds_annotationValue :: Lens' ValueWithServiceIds (Maybe AnnotationValue)
- valueWithServiceIds_serviceIds :: Lens' ValueWithServiceIds (Maybe [ServiceId])
Service Configuration
defaultService :: Service Source #
API version 2016-04-12 of the Amazon X-Ray SDK configuration.
Errors
_InvalidPolicyRevisionIdException :: AsError a => Fold a ServiceError Source #
A policy revision id was provided which does not match the latest policy
revision. This exception is also if a policy revision id of 0 is
provided via PutResourcePolicy and a policy with the same name already
exists.
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request is missing required parameters or has invalid parameters.
_LockoutPreventionException :: AsError a => Fold a ServiceError Source #
The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.
_MalformedPolicyDocumentException :: AsError a => Fold a ServiceError Source #
Invalid policy document provided in request.
_PolicyCountLimitExceededException :: AsError a => Fold a ServiceError Source #
Exceeded the maximum number of resource policies for a target Amazon Web Services account.
_PolicySizeLimitExceededException :: AsError a => Fold a ServiceError Source #
Exceeded the maximum size for a resource policy.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
_RuleLimitExceededException :: AsError a => Fold a ServiceError Source #
You have reached the maximum number of sampling rules.
_ThrottledException :: AsError a => Fold a ServiceError Source #
The request exceeds the maximum number of requests per second.
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
You have exceeded the maximum number of tags you can apply to this resource.
EncryptionStatus
newtype EncryptionStatus Source #
Constructors
| EncryptionStatus' | |
Fields | |
Bundled Patterns
| pattern EncryptionStatus_ACTIVE :: EncryptionStatus | |
| pattern EncryptionStatus_UPDATING :: EncryptionStatus |
Instances
EncryptionType
newtype EncryptionType Source #
Constructors
| EncryptionType' | |
Fields | |
Bundled Patterns
| pattern EncryptionType_KMS :: EncryptionType | |
| pattern EncryptionType_NONE :: EncryptionType |
Instances
InsightCategory
newtype InsightCategory Source #
Constructors
| InsightCategory' | |
Fields | |
Bundled Patterns
| pattern InsightCategory_FAULT :: InsightCategory |
Instances
InsightState
newtype InsightState Source #
Constructors
| InsightState' | |
Fields | |
Bundled Patterns
| pattern InsightState_ACTIVE :: InsightState | |
| pattern InsightState_CLOSED :: InsightState |
Instances
SamplingStrategyName
newtype SamplingStrategyName Source #
Constructors
| SamplingStrategyName' | |
Fields | |
Bundled Patterns
| pattern SamplingStrategyName_FixedRate :: SamplingStrategyName | |
| pattern SamplingStrategyName_PartialScan :: SamplingStrategyName |
Instances
TimeRangeType
newtype TimeRangeType Source #
Constructors
| TimeRangeType' | |
Fields | |
Bundled Patterns
| pattern TimeRangeType_Event :: TimeRangeType | |
| pattern TimeRangeType_TraceId :: TimeRangeType |
Instances
Alias
An alias for an edge.
See: newAlias smart constructor.
Constructors
| Alias' | |
Instances
| FromJSON Alias Source # | |
| Generic Alias Source # | |
| Read Alias Source # | |
| Show Alias Source # | |
| NFData Alias Source # | |
Defined in Amazonka.XRay.Types.Alias | |
| Eq Alias Source # | |
| Hashable Alias Source # | |
Defined in Amazonka.XRay.Types.Alias | |
| type Rep Alias Source # | |
Defined in Amazonka.XRay.Types.Alias type Rep Alias = D1 ('MetaData "Alias" "Amazonka.XRay.Types.Alias" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Alias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
Create a value of Alias 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:name:Alias', alias_name - The canonical name of the alias.
$sel:names:Alias', alias_names - A list of names for the alias, including the canonical name.
$sel:type':Alias', alias_type - The type of the alias.
alias_names :: Lens' Alias (Maybe [Text]) Source #
A list of names for the alias, including the canonical name.
AnnotationValue
data AnnotationValue Source #
Value of a segment annotation. Has one of three value types: Number, Boolean, or String.
See: newAnnotationValue smart constructor.
Constructors
| AnnotationValue' | |
Fields
| |
Instances
newAnnotationValue :: AnnotationValue Source #
Create a value of AnnotationValue 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:booleanValue:AnnotationValue', annotationValue_booleanValue - Value for a Boolean annotation.
$sel:numberValue:AnnotationValue', annotationValue_numberValue - Value for a Number annotation.
$sel:stringValue:AnnotationValue', annotationValue_stringValue - Value for a String annotation.
annotationValue_booleanValue :: Lens' AnnotationValue (Maybe Bool) Source #
Value for a Boolean annotation.
annotationValue_numberValue :: Lens' AnnotationValue (Maybe Double) Source #
Value for a Number annotation.
annotationValue_stringValue :: Lens' AnnotationValue (Maybe Text) Source #
Value for a String annotation.
AnomalousService
data AnomalousService Source #
The service within the service graph that has anomalously high fault rates.
See: newAnomalousService smart constructor.
Constructors
| AnomalousService' | |
Instances
newAnomalousService :: AnomalousService Source #
Create a value of AnomalousService 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:serviceId:AnomalousService', anomalousService_serviceId - Undocumented member.
anomalousService_serviceId :: Lens' AnomalousService (Maybe ServiceId) Source #
Undocumented member.
AvailabilityZoneDetail
data AvailabilityZoneDetail Source #
A list of Availability Zones corresponding to the segments in a trace.
See: newAvailabilityZoneDetail smart constructor.
Constructors
| AvailabilityZoneDetail' | |
Instances
newAvailabilityZoneDetail :: AvailabilityZoneDetail Source #
Create a value of AvailabilityZoneDetail 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:name:AvailabilityZoneDetail', availabilityZoneDetail_name - The name of a corresponding Availability Zone.
availabilityZoneDetail_name :: Lens' AvailabilityZoneDetail (Maybe Text) Source #
The name of a corresponding Availability Zone.
BackendConnectionErrors
data BackendConnectionErrors Source #
See: newBackendConnectionErrors smart constructor.
Constructors
| BackendConnectionErrors' | |
Fields
| |
Instances
newBackendConnectionErrors :: BackendConnectionErrors Source #
Create a value of BackendConnectionErrors 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:connectionRefusedCount:BackendConnectionErrors', backendConnectionErrors_connectionRefusedCount -
$sel:hTTPCode4XXCount:BackendConnectionErrors', backendConnectionErrors_hTTPCode4XXCount -
$sel:hTTPCode5XXCount:BackendConnectionErrors', backendConnectionErrors_hTTPCode5XXCount -
$sel:otherCount:BackendConnectionErrors', backendConnectionErrors_otherCount -
$sel:timeoutCount:BackendConnectionErrors', backendConnectionErrors_timeoutCount -
$sel:unknownHostCount:BackendConnectionErrors', backendConnectionErrors_unknownHostCount -
backendConnectionErrors_connectionRefusedCount :: Lens' BackendConnectionErrors (Maybe Int) Source #
Edge
Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.
See: newEdge smart constructor.
Constructors
| Edge' | |
Fields
| |
Instances
Create a value of Edge 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:aliases:Edge', edge_aliases - Aliases for the edge.
$sel:edgeType:Edge', edge_edgeType - Describes an asynchronous connection, with a value of link.
$sel:endTime:Edge', edge_endTime - The end time of the last segment on the edge.
$sel:receivedEventAgeHistogram:Edge', edge_receivedEventAgeHistogram - A histogram that maps the spread of event age when received by
consumers. Age is calculated each time an event is received. Only
populated when EdgeType is link.
$sel:referenceId:Edge', edge_referenceId - Identifier of the edge. Unique within a service map.
$sel:responseTimeHistogram:Edge', edge_responseTimeHistogram - A histogram that maps the spread of client response times on an edge.
Only populated for synchronous edges.
$sel:startTime:Edge', edge_startTime - The start time of the first segment on the edge.
$sel:summaryStatistics:Edge', edge_summaryStatistics - Response statistics for segments on the edge.
edge_edgeType :: Lens' Edge (Maybe Text) Source #
Describes an asynchronous connection, with a value of link.
edge_receivedEventAgeHistogram :: Lens' Edge (Maybe [HistogramEntry]) Source #
A histogram that maps the spread of event age when received by
consumers. Age is calculated each time an event is received. Only
populated when EdgeType is link.
edge_referenceId :: Lens' Edge (Maybe Int) Source #
Identifier of the edge. Unique within a service map.
edge_responseTimeHistogram :: Lens' Edge (Maybe [HistogramEntry]) Source #
A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.
edge_startTime :: Lens' Edge (Maybe UTCTime) Source #
The start time of the first segment on the edge.
edge_summaryStatistics :: Lens' Edge (Maybe EdgeStatistics) Source #
Response statistics for segments on the edge.
EdgeStatistics
data EdgeStatistics Source #
Response statistics for an edge.
See: newEdgeStatistics smart constructor.
Constructors
| EdgeStatistics' | |
Fields
| |
Instances
newEdgeStatistics :: EdgeStatistics Source #
Create a value of EdgeStatistics 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:errorStatistics:EdgeStatistics', edgeStatistics_errorStatistics - Information about requests that failed with a 4xx Client Error status
code.
$sel:faultStatistics:EdgeStatistics', edgeStatistics_faultStatistics - Information about requests that failed with a 5xx Server Error status
code.
$sel:okCount:EdgeStatistics', edgeStatistics_okCount - The number of requests that completed with a 2xx Success status code.
EdgeStatistics, edgeStatistics_totalCount - The total number of completed requests.
$sel:totalResponseTime:EdgeStatistics', edgeStatistics_totalResponseTime - The aggregate response time of completed requests.
edgeStatistics_errorStatistics :: Lens' EdgeStatistics (Maybe ErrorStatistics) Source #
Information about requests that failed with a 4xx Client Error status code.
edgeStatistics_faultStatistics :: Lens' EdgeStatistics (Maybe FaultStatistics) Source #
Information about requests that failed with a 5xx Server Error status code.
edgeStatistics_okCount :: Lens' EdgeStatistics (Maybe Integer) Source #
The number of requests that completed with a 2xx Success status code.
edgeStatistics_totalCount :: Lens' EdgeStatistics (Maybe Integer) Source #
The total number of completed requests.
edgeStatistics_totalResponseTime :: Lens' EdgeStatistics (Maybe Double) Source #
The aggregate response time of completed requests.
EncryptionConfig
data EncryptionConfig Source #
A configuration document that specifies encryption configuration settings.
See: newEncryptionConfig smart constructor.
Constructors
| EncryptionConfig' | |
Fields
| |
Instances
newEncryptionConfig :: EncryptionConfig Source #
Create a value of EncryptionConfig 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:keyId:EncryptionConfig', encryptionConfig_keyId - The ID of the KMS key used for encryption, if applicable.
$sel:status:EncryptionConfig', encryptionConfig_status - The encryption status. While the status is UPDATING, X-Ray may encrypt
data with a combination of the new and old settings.
$sel:type':EncryptionConfig', encryptionConfig_type - The type of encryption. Set to KMS for encryption with KMS keys. Set
to NONE for default encryption.
encryptionConfig_keyId :: Lens' EncryptionConfig (Maybe Text) Source #
The ID of the KMS key used for encryption, if applicable.
encryptionConfig_status :: Lens' EncryptionConfig (Maybe EncryptionStatus) Source #
The encryption status. While the status is UPDATING, X-Ray may encrypt
data with a combination of the new and old settings.
encryptionConfig_type :: Lens' EncryptionConfig (Maybe EncryptionType) Source #
The type of encryption. Set to KMS for encryption with KMS keys. Set
to NONE for default encryption.
ErrorRootCause
data ErrorRootCause Source #
The root cause of a trace summary error.
See: newErrorRootCause smart constructor.
Constructors
| ErrorRootCause' | |
Fields
| |
Instances
newErrorRootCause :: ErrorRootCause Source #
Create a value of ErrorRootCause 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:clientImpacting:ErrorRootCause', errorRootCause_clientImpacting - A flag that denotes that the root cause impacts the trace client.
$sel:services:ErrorRootCause', errorRootCause_services - A list of services corresponding to an error. A service identifies a
segment and it contains a name, account ID, type, and inferred flag.
errorRootCause_clientImpacting :: Lens' ErrorRootCause (Maybe Bool) Source #
A flag that denotes that the root cause impacts the trace client.
errorRootCause_services :: Lens' ErrorRootCause (Maybe [ErrorRootCauseService]) Source #
A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
ErrorRootCauseEntity
data ErrorRootCauseEntity Source #
A collection of segments and corresponding subsegments associated to a trace summary error.
See: newErrorRootCauseEntity smart constructor.
Constructors
| ErrorRootCauseEntity' | |
Fields
| |
Instances
newErrorRootCauseEntity :: ErrorRootCauseEntity Source #
Create a value of ErrorRootCauseEntity 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:exceptions:ErrorRootCauseEntity', errorRootCauseEntity_exceptions - The types and messages of the exceptions.
ErrorRootCauseEntity, errorRootCauseEntity_name - The name of the entity.
$sel:remote:ErrorRootCauseEntity', errorRootCauseEntity_remote - A flag that denotes a remote subsegment.
errorRootCauseEntity_exceptions :: Lens' ErrorRootCauseEntity (Maybe [RootCauseException]) Source #
The types and messages of the exceptions.
errorRootCauseEntity_name :: Lens' ErrorRootCauseEntity (Maybe Text) Source #
The name of the entity.
errorRootCauseEntity_remote :: Lens' ErrorRootCauseEntity (Maybe Bool) Source #
A flag that denotes a remote subsegment.
ErrorRootCauseService
data ErrorRootCauseService Source #
A collection of fields identifying the services in a trace summary error.
See: newErrorRootCauseService smart constructor.
Constructors
| ErrorRootCauseService' | |
Fields
| |
Instances
newErrorRootCauseService :: ErrorRootCauseService Source #
Create a value of ErrorRootCauseService 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:accountId:ErrorRootCauseService', errorRootCauseService_accountId - The account ID associated to the service.
$sel:entityPath:ErrorRootCauseService', errorRootCauseService_entityPath - The path of root cause entities found on the service.
$sel:inferred:ErrorRootCauseService', errorRootCauseService_inferred - A Boolean value indicating if the service is inferred from the trace.
ErrorRootCauseService, errorRootCauseService_name - The service name.
$sel:names:ErrorRootCauseService', errorRootCauseService_names - A collection of associated service names.
$sel:type':ErrorRootCauseService', errorRootCauseService_type - The type associated to the service.
errorRootCauseService_accountId :: Lens' ErrorRootCauseService (Maybe Text) Source #
The account ID associated to the service.
errorRootCauseService_entityPath :: Lens' ErrorRootCauseService (Maybe [ErrorRootCauseEntity]) Source #
The path of root cause entities found on the service.
errorRootCauseService_inferred :: Lens' ErrorRootCauseService (Maybe Bool) Source #
A Boolean value indicating if the service is inferred from the trace.
errorRootCauseService_name :: Lens' ErrorRootCauseService (Maybe Text) Source #
The service name.
errorRootCauseService_names :: Lens' ErrorRootCauseService (Maybe [Text]) Source #
A collection of associated service names.
errorRootCauseService_type :: Lens' ErrorRootCauseService (Maybe Text) Source #
The type associated to the service.
ErrorStatistics
data ErrorStatistics Source #
Information about requests that failed with a 4xx Client Error status code.
See: newErrorStatistics smart constructor.
Constructors
| ErrorStatistics' | |
Fields
| |
Instances
newErrorStatistics :: ErrorStatistics Source #
Create a value of ErrorStatistics 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:otherCount:ErrorStatistics', errorStatistics_otherCount - The number of requests that failed with untracked 4xx Client Error
status codes.
$sel:throttleCount:ErrorStatistics', errorStatistics_throttleCount - The number of requests that failed with a 419 throttling status code.
$sel:totalCount:ErrorStatistics', errorStatistics_totalCount - The total number of requests that failed with a 4xx Client Error status
code.
errorStatistics_otherCount :: Lens' ErrorStatistics (Maybe Integer) Source #
The number of requests that failed with untracked 4xx Client Error status codes.
errorStatistics_throttleCount :: Lens' ErrorStatistics (Maybe Integer) Source #
The number of requests that failed with a 419 throttling status code.
errorStatistics_totalCount :: Lens' ErrorStatistics (Maybe Integer) Source #
The total number of requests that failed with a 4xx Client Error status code.
FaultRootCause
data FaultRootCause Source #
The root cause information for a trace summary fault.
See: newFaultRootCause smart constructor.
Constructors
| FaultRootCause' | |
Fields
| |
Instances
newFaultRootCause :: FaultRootCause Source #
Create a value of FaultRootCause 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:clientImpacting:FaultRootCause', faultRootCause_clientImpacting - A flag that denotes that the root cause impacts the trace client.
$sel:services:FaultRootCause', faultRootCause_services - A list of corresponding services. A service identifies a segment and it
contains a name, account ID, type, and inferred flag.
faultRootCause_clientImpacting :: Lens' FaultRootCause (Maybe Bool) Source #
A flag that denotes that the root cause impacts the trace client.
faultRootCause_services :: Lens' FaultRootCause (Maybe [FaultRootCauseService]) Source #
A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.
FaultRootCauseEntity
data FaultRootCauseEntity Source #
A collection of segments and corresponding subsegments associated to a trace summary fault error.
See: newFaultRootCauseEntity smart constructor.
Constructors
| FaultRootCauseEntity' | |
Fields
| |
Instances
newFaultRootCauseEntity :: FaultRootCauseEntity Source #
Create a value of FaultRootCauseEntity 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:exceptions:FaultRootCauseEntity', faultRootCauseEntity_exceptions - The types and messages of the exceptions.
FaultRootCauseEntity, faultRootCauseEntity_name - The name of the entity.
$sel:remote:FaultRootCauseEntity', faultRootCauseEntity_remote - A flag that denotes a remote subsegment.
faultRootCauseEntity_exceptions :: Lens' FaultRootCauseEntity (Maybe [RootCauseException]) Source #
The types and messages of the exceptions.
faultRootCauseEntity_name :: Lens' FaultRootCauseEntity (Maybe Text) Source #
The name of the entity.
faultRootCauseEntity_remote :: Lens' FaultRootCauseEntity (Maybe Bool) Source #
A flag that denotes a remote subsegment.
FaultRootCauseService
data FaultRootCauseService Source #
A collection of fields identifying the services in a trace summary fault.
See: newFaultRootCauseService smart constructor.
Constructors
| FaultRootCauseService' | |
Fields
| |
Instances
newFaultRootCauseService :: FaultRootCauseService Source #
Create a value of FaultRootCauseService 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:accountId:FaultRootCauseService', faultRootCauseService_accountId - The account ID associated to the service.
$sel:entityPath:FaultRootCauseService', faultRootCauseService_entityPath - The path of root cause entities found on the service.
$sel:inferred:FaultRootCauseService', faultRootCauseService_inferred - A Boolean value indicating if the service is inferred from the trace.
FaultRootCauseService, faultRootCauseService_name - The service name.
$sel:names:FaultRootCauseService', faultRootCauseService_names - A collection of associated service names.
$sel:type':FaultRootCauseService', faultRootCauseService_type - The type associated to the service.
faultRootCauseService_accountId :: Lens' FaultRootCauseService (Maybe Text) Source #
The account ID associated to the service.
faultRootCauseService_entityPath :: Lens' FaultRootCauseService (Maybe [FaultRootCauseEntity]) Source #
The path of root cause entities found on the service.
faultRootCauseService_inferred :: Lens' FaultRootCauseService (Maybe Bool) Source #
A Boolean value indicating if the service is inferred from the trace.
faultRootCauseService_name :: Lens' FaultRootCauseService (Maybe Text) Source #
The service name.
faultRootCauseService_names :: Lens' FaultRootCauseService (Maybe [Text]) Source #
A collection of associated service names.
faultRootCauseService_type :: Lens' FaultRootCauseService (Maybe Text) Source #
The type associated to the service.
FaultStatistics
data FaultStatistics Source #
Information about requests that failed with a 5xx Server Error status code.
See: newFaultStatistics smart constructor.
Constructors
| FaultStatistics' | |
Fields
| |
Instances
newFaultStatistics :: FaultStatistics Source #
Create a value of FaultStatistics 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:otherCount:FaultStatistics', faultStatistics_otherCount - The number of requests that failed with untracked 5xx Server Error
status codes.
$sel:totalCount:FaultStatistics', faultStatistics_totalCount - The total number of requests that failed with a 5xx Server Error status
code.
faultStatistics_otherCount :: Lens' FaultStatistics (Maybe Integer) Source #
The number of requests that failed with untracked 5xx Server Error status codes.
faultStatistics_totalCount :: Lens' FaultStatistics (Maybe Integer) Source #
The total number of requests that failed with a 5xx Server Error status code.
ForecastStatistics
data ForecastStatistics Source #
The predicted high and low fault count. This is used to determine if a service has become anomalous and if an insight should be created.
See: newForecastStatistics smart constructor.
Constructors
| ForecastStatistics' | |
Fields
| |
Instances
newForecastStatistics :: ForecastStatistics Source #
Create a value of ForecastStatistics 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:faultCountHigh:ForecastStatistics', forecastStatistics_faultCountHigh - The upper limit of fault counts for a service.
$sel:faultCountLow:ForecastStatistics', forecastStatistics_faultCountLow - The lower limit of fault counts for a service.
forecastStatistics_faultCountHigh :: Lens' ForecastStatistics (Maybe Integer) Source #
The upper limit of fault counts for a service.
forecastStatistics_faultCountLow :: Lens' ForecastStatistics (Maybe Integer) Source #
The lower limit of fault counts for a service.
Group
Details and metadata for a group.
See: newGroup smart constructor.
Constructors
| Group' | |
Fields
| |
Instances
| FromJSON Group Source # | |
| Generic Group Source # | |
| Read Group Source # | |
| Show Group Source # | |
| NFData Group Source # | |
Defined in Amazonka.XRay.Types.Group | |
| Eq Group Source # | |
| Hashable Group Source # | |
Defined in Amazonka.XRay.Types.Group | |
| type Rep Group Source # | |
Defined in Amazonka.XRay.Types.Group type Rep Group = D1 ('MetaData "Group" "Amazonka.XRay.Types.Group" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Group'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "insightsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InsightsConfiguration))))) | |
Create a value of Group 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:filterExpression:Group', group_filterExpression - The filter expression defining the parameters to include traces.
$sel:groupARN:Group', group_groupARN - The Amazon Resource Name (ARN) of the group generated based on the
GroupName.
$sel:groupName:Group', group_groupName - The unique case-sensitive name of the group.
$sel:insightsConfiguration:Group', group_insightsConfiguration - The structure containing configurations related to insights.
- The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
group_filterExpression :: Lens' Group (Maybe Text) Source #
The filter expression defining the parameters to include traces.
group_groupARN :: Lens' Group (Maybe Text) Source #
The Amazon Resource Name (ARN) of the group generated based on the GroupName.
group_insightsConfiguration :: Lens' Group (Maybe InsightsConfiguration) Source #
The structure containing configurations related to insights.
- The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
GroupSummary
data GroupSummary Source #
Details for a group without metadata.
See: newGroupSummary smart constructor.
Constructors
| GroupSummary' | |
Fields
| |
Instances
newGroupSummary :: GroupSummary Source #
Create a value of GroupSummary 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:filterExpression:GroupSummary', groupSummary_filterExpression - The filter expression defining the parameters to include traces.
$sel:groupARN:GroupSummary', groupSummary_groupARN - The ARN of the group generated based on the GroupName.
$sel:groupName:GroupSummary', groupSummary_groupName - The unique case-sensitive name of the group.
$sel:insightsConfiguration:GroupSummary', groupSummary_insightsConfiguration - The structure containing configurations related to insights.
- The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
groupSummary_filterExpression :: Lens' GroupSummary (Maybe Text) Source #
The filter expression defining the parameters to include traces.
groupSummary_groupARN :: Lens' GroupSummary (Maybe Text) Source #
The ARN of the group generated based on the GroupName.
groupSummary_groupName :: Lens' GroupSummary (Maybe Text) Source #
The unique case-sensitive name of the group.
groupSummary_insightsConfiguration :: Lens' GroupSummary (Maybe InsightsConfiguration) Source #
The structure containing configurations related to insights.
- The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
- The NotificationsEnabled boolean can be set to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
HistogramEntry
data HistogramEntry Source #
An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.
See: newHistogramEntry smart constructor.
Constructors
| HistogramEntry' | |
Instances
newHistogramEntry :: HistogramEntry Source #
Create a value of HistogramEntry 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:count:HistogramEntry', histogramEntry_count - The prevalence of the entry.
$sel:value:HistogramEntry', histogramEntry_value - The value of the entry.
histogramEntry_count :: Lens' HistogramEntry (Maybe Int) Source #
The prevalence of the entry.
histogramEntry_value :: Lens' HistogramEntry (Maybe Double) Source #
The value of the entry.
Http
Information about an HTTP request.
See: newHttp smart constructor.
Constructors
| Http' | |
Instances
Create a value of Http 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:clientIp:Http', http_clientIp - The IP address of the requestor.
$sel:httpMethod:Http', http_httpMethod - The request method.
$sel:httpStatus:Http', http_httpStatus - The response status.
$sel:httpURL:Http', http_httpURL - The request URL.
$sel:userAgent:Http', http_userAgent - The request's user agent string.
Insight
When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.
See: newInsight smart constructor.
Constructors
| Insight' | |
Fields
| |
Instances
newInsight :: Insight Source #
Create a value of Insight 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:categories:Insight', insight_categories - The categories that label and describe the type of insight.
$sel:clientRequestImpactStatistics:Insight', insight_clientRequestImpactStatistics - The impact statistics of the client side service. This includes the
number of requests to the client service and whether the requests were
faults or okay.
$sel:endTime:Insight', insight_endTime - The time, in Unix seconds, at which the insight ended.
$sel:groupARN:Insight', insight_groupARN - The Amazon Resource Name (ARN) of the group that the insight belongs to.
$sel:groupName:Insight', insight_groupName - The name of the group that the insight belongs to.
$sel:insightId:Insight', insight_insightId - The insights unique identifier.
$sel:rootCauseServiceId:Insight', insight_rootCauseServiceId - Undocumented member.
$sel:rootCauseServiceRequestImpactStatistics:Insight', insight_rootCauseServiceRequestImpactStatistics - The impact statistics of the root cause service. This includes the
number of requests to the client service and whether the requests were
faults or okay.
$sel:startTime:Insight', insight_startTime - The time, in Unix seconds, at which the insight began.
$sel:state:Insight', insight_state - The current state of the insight.
$sel:summary:Insight', insight_summary - A brief description of the insight.
$sel:topAnomalousServices:Insight', insight_topAnomalousServices - The service within the insight that is most impacted by the incident.
insight_categories :: Lens' Insight (Maybe [InsightCategory]) Source #
The categories that label and describe the type of insight.
insight_clientRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics) Source #
The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
insight_endTime :: Lens' Insight (Maybe UTCTime) Source #
The time, in Unix seconds, at which the insight ended.
insight_groupARN :: Lens' Insight (Maybe Text) Source #
The Amazon Resource Name (ARN) of the group that the insight belongs to.
insight_groupName :: Lens' Insight (Maybe Text) Source #
The name of the group that the insight belongs to.
insight_rootCauseServiceRequestImpactStatistics :: Lens' Insight (Maybe RequestImpactStatistics) Source #
The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
insight_startTime :: Lens' Insight (Maybe UTCTime) Source #
The time, in Unix seconds, at which the insight began.
insight_state :: Lens' Insight (Maybe InsightState) Source #
The current state of the insight.
insight_topAnomalousServices :: Lens' Insight (Maybe [AnomalousService]) Source #
The service within the insight that is most impacted by the incident.
InsightEvent
data InsightEvent Source #
X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.
See: newInsightEvent smart constructor.
Constructors
| InsightEvent' | |
Fields
| |
Instances
newInsightEvent :: InsightEvent Source #
Create a value of InsightEvent 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:clientRequestImpactStatistics:InsightEvent', insightEvent_clientRequestImpactStatistics - The impact statistics of the client side service. This includes the
number of requests to the client service and whether the requests were
faults or okay.
$sel:eventTime:InsightEvent', insightEvent_eventTime - The time, in Unix seconds, at which the event was recorded.
$sel:rootCauseServiceRequestImpactStatistics:InsightEvent', insightEvent_rootCauseServiceRequestImpactStatistics - The impact statistics of the root cause service. This includes the
number of requests to the client service and whether the requests were
faults or okay.
$sel:summary:InsightEvent', insightEvent_summary - A brief description of the event.
$sel:topAnomalousServices:InsightEvent', insightEvent_topAnomalousServices - The service during the event that is most impacted by the incident.
insightEvent_clientRequestImpactStatistics :: Lens' InsightEvent (Maybe RequestImpactStatistics) Source #
The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
insightEvent_eventTime :: Lens' InsightEvent (Maybe UTCTime) Source #
The time, in Unix seconds, at which the event was recorded.
insightEvent_rootCauseServiceRequestImpactStatistics :: Lens' InsightEvent (Maybe RequestImpactStatistics) Source #
The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
insightEvent_summary :: Lens' InsightEvent (Maybe Text) Source #
A brief description of the event.
insightEvent_topAnomalousServices :: Lens' InsightEvent (Maybe [AnomalousService]) Source #
The service during the event that is most impacted by the incident.
InsightImpactGraphEdge
data InsightImpactGraphEdge Source #
The connection between two service in an insight impact graph.
See: newInsightImpactGraphEdge smart constructor.
Constructors
| InsightImpactGraphEdge' | |
Fields
| |
Instances
newInsightImpactGraphEdge :: InsightImpactGraphEdge Source #
Create a value of InsightImpactGraphEdge 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:referenceId:InsightImpactGraphEdge', insightImpactGraphEdge_referenceId - Identifier of the edge. Unique within a service map.
insightImpactGraphEdge_referenceId :: Lens' InsightImpactGraphEdge (Maybe Int) Source #
Identifier of the edge. Unique within a service map.
InsightImpactGraphService
data InsightImpactGraphService Source #
Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
See: newInsightImpactGraphService smart constructor.
Constructors
| InsightImpactGraphService' | |
Fields
| |
Instances
newInsightImpactGraphService :: InsightImpactGraphService Source #
Create a value of InsightImpactGraphService 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:accountId:InsightImpactGraphService', insightImpactGraphService_accountId - Identifier of the Amazon Web Services account in which the service runs.
$sel:edges:InsightImpactGraphService', insightImpactGraphService_edges - Connections to downstream services.
$sel:name:InsightImpactGraphService', insightImpactGraphService_name - The canonical name of the service.
$sel:names:InsightImpactGraphService', insightImpactGraphService_names - A list of names for the service, including the canonical name.
InsightImpactGraphService, insightImpactGraphService_referenceId - Identifier for the service. Unique within the service map.
$sel:type':InsightImpactGraphService', insightImpactGraphService_type - Identifier for the service. Unique within the service map.
- Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
- Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
- Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
- remote - A downstream service of indeterminate type.
insightImpactGraphService_accountId :: Lens' InsightImpactGraphService (Maybe Text) Source #
Identifier of the Amazon Web Services account in which the service runs.
insightImpactGraphService_edges :: Lens' InsightImpactGraphService (Maybe [InsightImpactGraphEdge]) Source #
Connections to downstream services.
insightImpactGraphService_name :: Lens' InsightImpactGraphService (Maybe Text) Source #
The canonical name of the service.
insightImpactGraphService_names :: Lens' InsightImpactGraphService (Maybe [Text]) Source #
A list of names for the service, including the canonical name.
insightImpactGraphService_referenceId :: Lens' InsightImpactGraphService (Maybe Int) Source #
Identifier for the service. Unique within the service map.
insightImpactGraphService_type :: Lens' InsightImpactGraphService (Maybe Text) Source #
Identifier for the service. Unique within the service map.
- Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
- Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
- Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.
- remote - A downstream service of indeterminate type.
InsightSummary
data InsightSummary Source #
Information that describes an insight.
See: newInsightSummary smart constructor.
Constructors
| InsightSummary' | |
Fields
| |
Instances
newInsightSummary :: InsightSummary Source #
Create a value of InsightSummary 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:categories:InsightSummary', insightSummary_categories - Categories The categories that label and describe the type of insight.
$sel:clientRequestImpactStatistics:InsightSummary', insightSummary_clientRequestImpactStatistics - The impact statistics of the client side service. This includes the
number of requests to the client service and whether the requests were
faults or okay.
$sel:endTime:InsightSummary', insightSummary_endTime - The time, in Unix seconds, at which the insight ended.
$sel:groupARN:InsightSummary', insightSummary_groupARN - The Amazon Resource Name (ARN) of the group that the insight belongs to.
$sel:groupName:InsightSummary', insightSummary_groupName - The name of the group that the insight belongs to.
$sel:insightId:InsightSummary', insightSummary_insightId - The insights unique identifier.
$sel:lastUpdateTime:InsightSummary', insightSummary_lastUpdateTime - The time, in Unix seconds, that the insight was last updated.
$sel:rootCauseServiceId:InsightSummary', insightSummary_rootCauseServiceId - Undocumented member.
$sel:rootCauseServiceRequestImpactStatistics:InsightSummary', insightSummary_rootCauseServiceRequestImpactStatistics - The impact statistics of the root cause service. This includes the
number of requests to the client service and whether the requests were
faults or okay.
$sel:startTime:InsightSummary', insightSummary_startTime - The time, in Unix seconds, at which the insight began.
$sel:state:InsightSummary', insightSummary_state - The current state of the insight.
$sel:summary:InsightSummary', insightSummary_summary - A brief description of the insight.
$sel:topAnomalousServices:InsightSummary', insightSummary_topAnomalousServices - The service within the insight that is most impacted by the incident.
insightSummary_categories :: Lens' InsightSummary (Maybe [InsightCategory]) Source #
Categories The categories that label and describe the type of insight.
insightSummary_clientRequestImpactStatistics :: Lens' InsightSummary (Maybe RequestImpactStatistics) Source #
The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.
insightSummary_endTime :: Lens' InsightSummary (Maybe UTCTime) Source #
The time, in Unix seconds, at which the insight ended.
insightSummary_groupARN :: Lens' InsightSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the group that the insight belongs to.
insightSummary_groupName :: Lens' InsightSummary (Maybe Text) Source #
The name of the group that the insight belongs to.
insightSummary_insightId :: Lens' InsightSummary (Maybe Text) Source #
The insights unique identifier.
insightSummary_lastUpdateTime :: Lens' InsightSummary (Maybe UTCTime) Source #
The time, in Unix seconds, that the insight was last updated.
insightSummary_rootCauseServiceId :: Lens' InsightSummary (Maybe ServiceId) Source #
Undocumented member.
insightSummary_rootCauseServiceRequestImpactStatistics :: Lens' InsightSummary (Maybe RequestImpactStatistics) Source #
The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.
insightSummary_startTime :: Lens' InsightSummary (Maybe UTCTime) Source #
The time, in Unix seconds, at which the insight began.
insightSummary_state :: Lens' InsightSummary (Maybe InsightState) Source #
The current state of the insight.
insightSummary_summary :: Lens' InsightSummary (Maybe Text) Source #
A brief description of the insight.
insightSummary_topAnomalousServices :: Lens' InsightSummary (Maybe [AnomalousService]) Source #
The service within the insight that is most impacted by the incident.
InsightsConfiguration
data InsightsConfiguration Source #
The structure containing configurations related to insights.
See: newInsightsConfiguration smart constructor.
Constructors
| InsightsConfiguration' | |
Fields
| |
Instances
newInsightsConfiguration :: InsightsConfiguration Source #
Create a value of InsightsConfiguration 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:insightsEnabled:InsightsConfiguration', insightsConfiguration_insightsEnabled - Set the InsightsEnabled value to true to enable insights or false to
disable insights.
$sel:notificationsEnabled:InsightsConfiguration', insightsConfiguration_notificationsEnabled - Set the NotificationsEnabled value to true to enable insights
notifications. Notifications can only be enabled on a group with
InsightsEnabled set to true.
insightsConfiguration_insightsEnabled :: Lens' InsightsConfiguration (Maybe Bool) Source #
Set the InsightsEnabled value to true to enable insights or false to disable insights.
insightsConfiguration_notificationsEnabled :: Lens' InsightsConfiguration (Maybe Bool) Source #
Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
InstanceIdDetail
data InstanceIdDetail Source #
A list of EC2 instance IDs corresponding to the segments in a trace.
See: newInstanceIdDetail smart constructor.
Constructors
| InstanceIdDetail' | |
Instances
newInstanceIdDetail :: InstanceIdDetail Source #
Create a value of InstanceIdDetail 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:InstanceIdDetail', instanceIdDetail_id - The ID of a corresponding EC2 instance.
instanceIdDetail_id :: Lens' InstanceIdDetail (Maybe Text) Source #
The ID of a corresponding EC2 instance.
RequestImpactStatistics
data RequestImpactStatistics Source #
Statistics that describe how the incident has impacted a service.
See: newRequestImpactStatistics smart constructor.
Constructors
| RequestImpactStatistics' | |
Fields
| |
Instances
newRequestImpactStatistics :: RequestImpactStatistics Source #
Create a value of RequestImpactStatistics 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:faultCount:RequestImpactStatistics', requestImpactStatistics_faultCount - The number of requests that have resulted in a fault,
$sel:okCount:RequestImpactStatistics', requestImpactStatistics_okCount - The number of successful requests.
$sel:totalCount:RequestImpactStatistics', requestImpactStatistics_totalCount - The total number of requests to the service.
requestImpactStatistics_faultCount :: Lens' RequestImpactStatistics (Maybe Integer) Source #
The number of requests that have resulted in a fault,
requestImpactStatistics_okCount :: Lens' RequestImpactStatistics (Maybe Integer) Source #
The number of successful requests.
requestImpactStatistics_totalCount :: Lens' RequestImpactStatistics (Maybe Integer) Source #
The total number of requests to the service.
ResourceARNDetail
data ResourceARNDetail Source #
A list of resources ARNs corresponding to the segments in a trace.
See: newResourceARNDetail smart constructor.
Constructors
| ResourceARNDetail' | |
Instances
newResourceARNDetail :: ResourceARNDetail Source #
Create a value of ResourceARNDetail 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:arn:ResourceARNDetail', resourceARNDetail_arn - The ARN of a corresponding resource.
resourceARNDetail_arn :: Lens' ResourceARNDetail (Maybe Text) Source #
The ARN of a corresponding resource.
ResourcePolicy
data ResourcePolicy Source #
A resource policy grants one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy is associated with a specific Amazon Web Services account.
See: newResourcePolicy smart constructor.
Constructors
| ResourcePolicy' | |
Fields
| |
Instances
newResourcePolicy :: ResourcePolicy Source #
Create a value of ResourcePolicy 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:lastUpdatedTime:ResourcePolicy', resourcePolicy_lastUpdatedTime - When the policy was last updated, in Unix time seconds.
$sel:policyDocument:ResourcePolicy', resourcePolicy_policyDocument - The resource policy document, which can be up to 5kb in size.
$sel:policyName:ResourcePolicy', resourcePolicy_policyName - The name of the resource policy. Must be unique within a specific Amazon
Web Services account.
$sel:policyRevisionId:ResourcePolicy', resourcePolicy_policyRevisionId - Returns the current policy revision id for this policy name.
resourcePolicy_lastUpdatedTime :: Lens' ResourcePolicy (Maybe UTCTime) Source #
When the policy was last updated, in Unix time seconds.
resourcePolicy_policyDocument :: Lens' ResourcePolicy (Maybe Text) Source #
The resource policy document, which can be up to 5kb in size.
resourcePolicy_policyName :: Lens' ResourcePolicy (Maybe Text) Source #
The name of the resource policy. Must be unique within a specific Amazon Web Services account.
resourcePolicy_policyRevisionId :: Lens' ResourcePolicy (Maybe Text) Source #
Returns the current policy revision id for this policy name.
ResponseTimeRootCause
data ResponseTimeRootCause Source #
The root cause information for a response time warning.
See: newResponseTimeRootCause smart constructor.
Constructors
| ResponseTimeRootCause' | |
Fields
| |
Instances
newResponseTimeRootCause :: ResponseTimeRootCause Source #
Create a value of ResponseTimeRootCause 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:clientImpacting:ResponseTimeRootCause', responseTimeRootCause_clientImpacting - A flag that denotes that the root cause impacts the trace client.
$sel:services:ResponseTimeRootCause', responseTimeRootCause_services - A list of corresponding services. A service identifies a segment and
contains a name, account ID, type, and inferred flag.
responseTimeRootCause_clientImpacting :: Lens' ResponseTimeRootCause (Maybe Bool) Source #
A flag that denotes that the root cause impacts the trace client.
responseTimeRootCause_services :: Lens' ResponseTimeRootCause (Maybe [ResponseTimeRootCauseService]) Source #
A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag.
ResponseTimeRootCauseEntity
data ResponseTimeRootCauseEntity Source #
A collection of segments and corresponding subsegments associated to a response time warning.
See: newResponseTimeRootCauseEntity smart constructor.
Constructors
| ResponseTimeRootCauseEntity' | |
Instances
newResponseTimeRootCauseEntity :: ResponseTimeRootCauseEntity Source #
Create a value of ResponseTimeRootCauseEntity 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:coverage:ResponseTimeRootCauseEntity', responseTimeRootCauseEntity_coverage - The type and messages of the exceptions.
$sel:name:ResponseTimeRootCauseEntity', responseTimeRootCauseEntity_name - The name of the entity.
$sel:remote:ResponseTimeRootCauseEntity', responseTimeRootCauseEntity_remote - A flag that denotes a remote subsegment.
responseTimeRootCauseEntity_coverage :: Lens' ResponseTimeRootCauseEntity (Maybe Double) Source #
The type and messages of the exceptions.
responseTimeRootCauseEntity_name :: Lens' ResponseTimeRootCauseEntity (Maybe Text) Source #
The name of the entity.
responseTimeRootCauseEntity_remote :: Lens' ResponseTimeRootCauseEntity (Maybe Bool) Source #
A flag that denotes a remote subsegment.
ResponseTimeRootCauseService
data ResponseTimeRootCauseService Source #
A collection of fields identifying the service in a response time warning.
See: newResponseTimeRootCauseService smart constructor.
Constructors
| ResponseTimeRootCauseService' | |
Fields
| |
Instances
newResponseTimeRootCauseService :: ResponseTimeRootCauseService Source #
Create a value of ResponseTimeRootCauseService 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:accountId:ResponseTimeRootCauseService', responseTimeRootCauseService_accountId - The account ID associated to the service.
$sel:entityPath:ResponseTimeRootCauseService', responseTimeRootCauseService_entityPath - The path of root cause entities found on the service.
$sel:inferred:ResponseTimeRootCauseService', responseTimeRootCauseService_inferred - A Boolean value indicating if the service is inferred from the trace.
ResponseTimeRootCauseService, responseTimeRootCauseService_name - The service name.
$sel:names:ResponseTimeRootCauseService', responseTimeRootCauseService_names - A collection of associated service names.
$sel:type':ResponseTimeRootCauseService', responseTimeRootCauseService_type - The type associated to the service.
responseTimeRootCauseService_accountId :: Lens' ResponseTimeRootCauseService (Maybe Text) Source #
The account ID associated to the service.
responseTimeRootCauseService_entityPath :: Lens' ResponseTimeRootCauseService (Maybe [ResponseTimeRootCauseEntity]) Source #
The path of root cause entities found on the service.
responseTimeRootCauseService_inferred :: Lens' ResponseTimeRootCauseService (Maybe Bool) Source #
A Boolean value indicating if the service is inferred from the trace.
responseTimeRootCauseService_name :: Lens' ResponseTimeRootCauseService (Maybe Text) Source #
The service name.
responseTimeRootCauseService_names :: Lens' ResponseTimeRootCauseService (Maybe [Text]) Source #
A collection of associated service names.
responseTimeRootCauseService_type :: Lens' ResponseTimeRootCauseService (Maybe Text) Source #
The type associated to the service.
RootCauseException
data RootCauseException Source #
The exception associated with a root cause.
See: newRootCauseException smart constructor.
Constructors
| RootCauseException' | |
Instances
newRootCauseException :: RootCauseException Source #
Create a value of RootCauseException 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:message:RootCauseException', rootCauseException_message - The message of the exception.
$sel:name:RootCauseException', rootCauseException_name - The name of the exception.
rootCauseException_message :: Lens' RootCauseException (Maybe Text) Source #
The message of the exception.
rootCauseException_name :: Lens' RootCauseException (Maybe Text) Source #
The name of the exception.
SamplingRule
data SamplingRule Source #
A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.
See: newSamplingRule smart constructor.
Constructors
| SamplingRule' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Natural | |
| -> Double | |
| -> Natural | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Natural | |
| -> SamplingRule |
Create a value of SamplingRule 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:attributes:SamplingRule', samplingRule_attributes - Matches attributes derived from the request.
$sel:ruleARN:SamplingRule', samplingRule_ruleARN - The ARN of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:ruleName:SamplingRule', samplingRule_ruleName - The name of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:resourceARN:SamplingRule', samplingRule_resourceARN - Matches the ARN of the Amazon Web Services resource on which the service
runs.
$sel:priority:SamplingRule', samplingRule_priority - The priority of the sampling rule.
$sel:fixedRate:SamplingRule', samplingRule_fixedRate - The percentage of matching requests to instrument, after the reservoir
is exhausted.
$sel:reservoirSize:SamplingRule', samplingRule_reservoirSize - A fixed number of matching requests to instrument per second, prior to
applying the fixed rate. The reservoir is not used directly by services,
but applies to all services using the rule collectively.
$sel:serviceName:SamplingRule', samplingRule_serviceName - Matches the name that the service uses to identify itself in segments.
$sel:serviceType:SamplingRule', samplingRule_serviceType - Matches the origin that the service uses to identify its type in
segments.
$sel:host:SamplingRule', samplingRule_host - Matches the hostname from a request URL.
$sel:hTTPMethod:SamplingRule', samplingRule_hTTPMethod - Matches the HTTP method of a request.
$sel:uRLPath:SamplingRule', samplingRule_uRLPath - Matches the path from a request URL.
$sel:version:SamplingRule', samplingRule_version - The version of the sampling rule format (1).
samplingRule_attributes :: Lens' SamplingRule (Maybe (HashMap Text Text)) Source #
Matches attributes derived from the request.
samplingRule_ruleARN :: Lens' SamplingRule (Maybe Text) Source #
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
samplingRule_ruleName :: Lens' SamplingRule (Maybe Text) Source #
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
samplingRule_resourceARN :: Lens' SamplingRule Text Source #
Matches the ARN of the Amazon Web Services resource on which the service runs.
samplingRule_priority :: Lens' SamplingRule Natural Source #
The priority of the sampling rule.
samplingRule_fixedRate :: Lens' SamplingRule Double Source #
The percentage of matching requests to instrument, after the reservoir is exhausted.
samplingRule_reservoirSize :: Lens' SamplingRule Natural Source #
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
samplingRule_serviceName :: Lens' SamplingRule Text Source #
Matches the name that the service uses to identify itself in segments.
samplingRule_serviceType :: Lens' SamplingRule Text Source #
Matches the origin that the service uses to identify its type in
segments.
samplingRule_host :: Lens' SamplingRule Text Source #
Matches the hostname from a request URL.
samplingRule_hTTPMethod :: Lens' SamplingRule Text Source #
Matches the HTTP method of a request.
samplingRule_uRLPath :: Lens' SamplingRule Text Source #
Matches the path from a request URL.
samplingRule_version :: Lens' SamplingRule Natural Source #
The version of the sampling rule format (1).
SamplingRuleRecord
data SamplingRuleRecord Source #
A SamplingRule and its metadata.
See: newSamplingRuleRecord smart constructor.
Constructors
| SamplingRuleRecord' | |
Fields
| |
Instances
newSamplingRuleRecord :: SamplingRuleRecord Source #
Create a value of SamplingRuleRecord 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:createdAt:SamplingRuleRecord', samplingRuleRecord_createdAt - When the rule was created.
$sel:modifiedAt:SamplingRuleRecord', samplingRuleRecord_modifiedAt - When the rule was last modified.
$sel:samplingRule:SamplingRuleRecord', samplingRuleRecord_samplingRule - The sampling rule.
samplingRuleRecord_createdAt :: Lens' SamplingRuleRecord (Maybe UTCTime) Source #
When the rule was created.
samplingRuleRecord_modifiedAt :: Lens' SamplingRuleRecord (Maybe UTCTime) Source #
When the rule was last modified.
samplingRuleRecord_samplingRule :: Lens' SamplingRuleRecord (Maybe SamplingRule) Source #
The sampling rule.
SamplingRuleUpdate
data SamplingRuleUpdate Source #
A document specifying changes to a sampling rule's configuration.
See: newSamplingRuleUpdate smart constructor.
Constructors
| SamplingRuleUpdate' | |
Fields
| |
Instances
newSamplingRuleUpdate :: SamplingRuleUpdate Source #
Create a value of SamplingRuleUpdate 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:attributes:SamplingRuleUpdate', samplingRuleUpdate_attributes - Matches attributes derived from the request.
$sel:fixedRate:SamplingRuleUpdate', samplingRuleUpdate_fixedRate - The percentage of matching requests to instrument, after the reservoir
is exhausted.
$sel:hTTPMethod:SamplingRuleUpdate', samplingRuleUpdate_hTTPMethod - Matches the HTTP method of a request.
$sel:host:SamplingRuleUpdate', samplingRuleUpdate_host - Matches the hostname from a request URL.
$sel:priority:SamplingRuleUpdate', samplingRuleUpdate_priority - The priority of the sampling rule.
$sel:reservoirSize:SamplingRuleUpdate', samplingRuleUpdate_reservoirSize - A fixed number of matching requests to instrument per second, prior to
applying the fixed rate. The reservoir is not used directly by services,
but applies to all services using the rule collectively.
$sel:resourceARN:SamplingRuleUpdate', samplingRuleUpdate_resourceARN - Matches the ARN of the Amazon Web Services resource on which the service
runs.
$sel:ruleARN:SamplingRuleUpdate', samplingRuleUpdate_ruleARN - The ARN of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:ruleName:SamplingRuleUpdate', samplingRuleUpdate_ruleName - The name of the sampling rule. Specify a rule by either name or ARN, but
not both.
$sel:serviceName:SamplingRuleUpdate', samplingRuleUpdate_serviceName - Matches the name that the service uses to identify itself in segments.
$sel:serviceType:SamplingRuleUpdate', samplingRuleUpdate_serviceType - Matches the origin that the service uses to identify its type in
segments.
$sel:uRLPath:SamplingRuleUpdate', samplingRuleUpdate_uRLPath - Matches the path from a request URL.
samplingRuleUpdate_attributes :: Lens' SamplingRuleUpdate (Maybe (HashMap Text Text)) Source #
Matches attributes derived from the request.
samplingRuleUpdate_fixedRate :: Lens' SamplingRuleUpdate (Maybe Double) Source #
The percentage of matching requests to instrument, after the reservoir is exhausted.
samplingRuleUpdate_hTTPMethod :: Lens' SamplingRuleUpdate (Maybe Text) Source #
Matches the HTTP method of a request.
samplingRuleUpdate_host :: Lens' SamplingRuleUpdate (Maybe Text) Source #
Matches the hostname from a request URL.
samplingRuleUpdate_priority :: Lens' SamplingRuleUpdate (Maybe Int) Source #
The priority of the sampling rule.
samplingRuleUpdate_reservoirSize :: Lens' SamplingRuleUpdate (Maybe Int) Source #
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
samplingRuleUpdate_resourceARN :: Lens' SamplingRuleUpdate (Maybe Text) Source #
Matches the ARN of the Amazon Web Services resource on which the service runs.
samplingRuleUpdate_ruleARN :: Lens' SamplingRuleUpdate (Maybe Text) Source #
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
samplingRuleUpdate_ruleName :: Lens' SamplingRuleUpdate (Maybe Text) Source #
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
samplingRuleUpdate_serviceName :: Lens' SamplingRuleUpdate (Maybe Text) Source #
Matches the name that the service uses to identify itself in segments.
samplingRuleUpdate_serviceType :: Lens' SamplingRuleUpdate (Maybe Text) Source #
Matches the origin that the service uses to identify its type in
segments.
samplingRuleUpdate_uRLPath :: Lens' SamplingRuleUpdate (Maybe Text) Source #
Matches the path from a request URL.
SamplingStatisticSummary
data SamplingStatisticSummary Source #
Aggregated request sampling data for a sampling rule across all services for a 10-second window.
See: newSamplingStatisticSummary smart constructor.
Constructors
| SamplingStatisticSummary' | |
Fields
| |
Instances
newSamplingStatisticSummary :: SamplingStatisticSummary Source #
Create a value of SamplingStatisticSummary 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:borrowCount:SamplingStatisticSummary', samplingStatisticSummary_borrowCount - The number of requests recorded with borrowed reservoir quota.
$sel:requestCount:SamplingStatisticSummary', samplingStatisticSummary_requestCount - The number of requests that matched the rule.
$sel:ruleName:SamplingStatisticSummary', samplingStatisticSummary_ruleName - The name of the sampling rule.
$sel:sampledCount:SamplingStatisticSummary', samplingStatisticSummary_sampledCount - The number of requests recorded.
$sel:timestamp:SamplingStatisticSummary', samplingStatisticSummary_timestamp - The start time of the reporting window.
samplingStatisticSummary_borrowCount :: Lens' SamplingStatisticSummary (Maybe Int) Source #
The number of requests recorded with borrowed reservoir quota.
samplingStatisticSummary_requestCount :: Lens' SamplingStatisticSummary (Maybe Int) Source #
The number of requests that matched the rule.
samplingStatisticSummary_ruleName :: Lens' SamplingStatisticSummary (Maybe Text) Source #
The name of the sampling rule.
samplingStatisticSummary_sampledCount :: Lens' SamplingStatisticSummary (Maybe Int) Source #
The number of requests recorded.
samplingStatisticSummary_timestamp :: Lens' SamplingStatisticSummary (Maybe UTCTime) Source #
The start time of the reporting window.
SamplingStatisticsDocument
data SamplingStatisticsDocument Source #
Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.
See: newSamplingStatisticsDocument smart constructor.
Constructors
| SamplingStatisticsDocument' | |
Fields
| |
Instances
newSamplingStatisticsDocument Source #
Create a value of SamplingStatisticsDocument 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:borrowCount:SamplingStatisticsDocument', samplingStatisticsDocument_borrowCount - The number of requests recorded with borrowed reservoir quota.
$sel:ruleName:SamplingStatisticsDocument', samplingStatisticsDocument_ruleName - The name of the sampling rule.
$sel:clientID:SamplingStatisticsDocument', samplingStatisticsDocument_clientID - A unique identifier for the service in hexadecimal.
$sel:timestamp:SamplingStatisticsDocument', samplingStatisticsDocument_timestamp - The current time.
$sel:requestCount:SamplingStatisticsDocument', samplingStatisticsDocument_requestCount - The number of requests that matched the rule.
$sel:sampledCount:SamplingStatisticsDocument', samplingStatisticsDocument_sampledCount - The number of requests recorded.
samplingStatisticsDocument_borrowCount :: Lens' SamplingStatisticsDocument (Maybe Natural) Source #
The number of requests recorded with borrowed reservoir quota.
samplingStatisticsDocument_ruleName :: Lens' SamplingStatisticsDocument Text Source #
The name of the sampling rule.
samplingStatisticsDocument_clientID :: Lens' SamplingStatisticsDocument Text Source #
A unique identifier for the service in hexadecimal.
samplingStatisticsDocument_timestamp :: Lens' SamplingStatisticsDocument UTCTime Source #
The current time.
samplingStatisticsDocument_requestCount :: Lens' SamplingStatisticsDocument Natural Source #
The number of requests that matched the rule.
samplingStatisticsDocument_sampledCount :: Lens' SamplingStatisticsDocument Natural Source #
The number of requests recorded.
SamplingStrategy
data SamplingStrategy Source #
The name and value of a sampling rule to apply to a trace summary.
See: newSamplingStrategy smart constructor.
Constructors
| SamplingStrategy' | |
Instances
newSamplingStrategy :: SamplingStrategy Source #
Create a value of SamplingStrategy 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:name:SamplingStrategy', samplingStrategy_name - The name of a sampling rule.
$sel:value:SamplingStrategy', samplingStrategy_value - The value of a sampling rule.
samplingStrategy_name :: Lens' SamplingStrategy (Maybe SamplingStrategyName) Source #
The name of a sampling rule.
samplingStrategy_value :: Lens' SamplingStrategy (Maybe Double) Source #
The value of a sampling rule.
SamplingTargetDocument
data SamplingTargetDocument Source #
Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.
See: newSamplingTargetDocument smart constructor.
Constructors
| SamplingTargetDocument' | |
Fields
| |
Instances
newSamplingTargetDocument :: SamplingTargetDocument Source #
Create a value of SamplingTargetDocument 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:fixedRate:SamplingTargetDocument', samplingTargetDocument_fixedRate - The percentage of matching requests to instrument, after the reservoir
is exhausted.
$sel:interval:SamplingTargetDocument', samplingTargetDocument_interval - The number of seconds for the service to wait before getting sampling
targets again.
$sel:reservoirQuota:SamplingTargetDocument', samplingTargetDocument_reservoirQuota - The number of requests per second that X-Ray allocated for this service.
$sel:reservoirQuotaTTL:SamplingTargetDocument', samplingTargetDocument_reservoirQuotaTTL - When the reservoir quota expires.
$sel:ruleName:SamplingTargetDocument', samplingTargetDocument_ruleName - The name of the sampling rule.
samplingTargetDocument_fixedRate :: Lens' SamplingTargetDocument (Maybe Double) Source #
The percentage of matching requests to instrument, after the reservoir is exhausted.
samplingTargetDocument_interval :: Lens' SamplingTargetDocument (Maybe Int) Source #
The number of seconds for the service to wait before getting sampling targets again.
samplingTargetDocument_reservoirQuota :: Lens' SamplingTargetDocument (Maybe Int) Source #
The number of requests per second that X-Ray allocated for this service.
samplingTargetDocument_reservoirQuotaTTL :: Lens' SamplingTargetDocument (Maybe UTCTime) Source #
When the reservoir quota expires.
samplingTargetDocument_ruleName :: Lens' SamplingTargetDocument (Maybe Text) Source #
The name of the sampling rule.
Segment
A segment from a trace that has been ingested by the X-Ray service. The
segment can be compiled from documents uploaded with
PutTraceSegments,
or an inferred segment for a downstream service, generated from a
subsegment sent by the service that called it.
For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide.
See: newSegment smart constructor.
Constructors
| Segment' | |
Instances
| FromJSON Segment Source # | |
| Generic Segment Source # | |
| Read Segment Source # | |
| Show Segment Source # | |
| NFData Segment Source # | |
Defined in Amazonka.XRay.Types.Segment | |
| Eq Segment Source # | |
| Hashable Segment Source # | |
Defined in Amazonka.XRay.Types.Segment | |
| type Rep Segment Source # | |
Defined in Amazonka.XRay.Types.Segment type Rep Segment = D1 ('MetaData "Segment" "Amazonka.XRay.Types.Segment" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Segment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newSegment :: Segment Source #
Create a value of Segment 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:document:Segment', segment_document - The segment document.
$sel:id:Segment', segment_id - The segment's ID.
ServiceId
See: newServiceId smart constructor.
Constructors
| ServiceId' | |
Instances
| FromJSON ServiceId Source # | |
| Generic ServiceId Source # | |
| Read ServiceId Source # | |
| Show ServiceId Source # | |
| NFData ServiceId Source # | |
Defined in Amazonka.XRay.Types.ServiceId | |
| Eq ServiceId Source # | |
| Hashable ServiceId Source # | |
Defined in Amazonka.XRay.Types.ServiceId | |
| type Rep ServiceId Source # | |
Defined in Amazonka.XRay.Types.ServiceId type Rep ServiceId = D1 ('MetaData "ServiceId" "Amazonka.XRay.Types.ServiceId" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "ServiceId'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newServiceId :: ServiceId Source #
Create a value of ServiceId 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:accountId:ServiceId', serviceId_accountId -
$sel:name:ServiceId', serviceId_name -
ServiceInfo
data ServiceInfo Source #
Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.
See: newServiceInfo smart constructor.
Constructors
| ServiceInfo' | |
Fields
| |
Instances
newServiceInfo :: ServiceInfo Source #
Create a value of ServiceInfo 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:accountId:ServiceInfo', serviceInfo_accountId - Identifier of the Amazon Web Services account in which the service runs.
$sel:durationHistogram:ServiceInfo', serviceInfo_durationHistogram - A histogram that maps the spread of service durations.
$sel:edges:ServiceInfo', serviceInfo_edges - Connections to downstream services.
ServiceInfo, serviceInfo_endTime - The end time of the last segment that the service generated.
$sel:name:ServiceInfo', serviceInfo_name - The canonical name of the service.
$sel:names:ServiceInfo', serviceInfo_names - A list of names for the service, including the canonical name.
ServiceInfo, serviceInfo_referenceId - Identifier for the service. Unique within the service map.
ServiceInfo, serviceInfo_responseTimeHistogram - A histogram that maps the spread of service response times.
$sel:root:ServiceInfo', serviceInfo_root - Indicates that the service was the first service to process a request.
ServiceInfo, serviceInfo_startTime - The start time of the first segment that the service generated.
$sel:state:ServiceInfo', serviceInfo_state - The service's state.
ServiceInfo, serviceInfo_summaryStatistics - Aggregated statistics for the service.
$sel:type':ServiceInfo', serviceInfo_type - The type of service.
- Amazon Web Services Resource - The type of an Amazon Web Services
resource. For example,
AWS::EC2::Instancefor an application running on Amazon EC2 orAWS::DynamoDB::Tablefor an Amazon DynamoDB table that the application used. - Amazon Web Services Service - The type of an Amazon Web Services
service. For example,
AWS::DynamoDBfor downstream calls to Amazon DynamoDB that didn't target a specific table. client- Represents the clients that sent requests to a root service.remote- A downstream service of indeterminate type.
serviceInfo_accountId :: Lens' ServiceInfo (Maybe Text) Source #
Identifier of the Amazon Web Services account in which the service runs.
serviceInfo_durationHistogram :: Lens' ServiceInfo (Maybe [HistogramEntry]) Source #
A histogram that maps the spread of service durations.
serviceInfo_edges :: Lens' ServiceInfo (Maybe [Edge]) Source #
Connections to downstream services.
serviceInfo_endTime :: Lens' ServiceInfo (Maybe UTCTime) Source #
The end time of the last segment that the service generated.
serviceInfo_name :: Lens' ServiceInfo (Maybe Text) Source #
The canonical name of the service.
serviceInfo_names :: Lens' ServiceInfo (Maybe [Text]) Source #
A list of names for the service, including the canonical name.
serviceInfo_referenceId :: Lens' ServiceInfo (Maybe Int) Source #
Identifier for the service. Unique within the service map.
serviceInfo_responseTimeHistogram :: Lens' ServiceInfo (Maybe [HistogramEntry]) Source #
A histogram that maps the spread of service response times.
serviceInfo_root :: Lens' ServiceInfo (Maybe Bool) Source #
Indicates that the service was the first service to process a request.
serviceInfo_startTime :: Lens' ServiceInfo (Maybe UTCTime) Source #
The start time of the first segment that the service generated.
serviceInfo_state :: Lens' ServiceInfo (Maybe Text) Source #
The service's state.
serviceInfo_summaryStatistics :: Lens' ServiceInfo (Maybe ServiceStatistics) Source #
Aggregated statistics for the service.
serviceInfo_type :: Lens' ServiceInfo (Maybe Text) Source #
The type of service.
- Amazon Web Services Resource - The type of an Amazon Web Services
resource. For example,
AWS::EC2::Instancefor an application running on Amazon EC2 orAWS::DynamoDB::Tablefor an Amazon DynamoDB table that the application used. - Amazon Web Services Service - The type of an Amazon Web Services
service. For example,
AWS::DynamoDBfor downstream calls to Amazon DynamoDB that didn't target a specific table. client- Represents the clients that sent requests to a root service.remote- A downstream service of indeterminate type.
ServiceStatistics
data ServiceStatistics Source #
Response statistics for a service.
See: newServiceStatistics smart constructor.
Constructors
| ServiceStatistics' | |
Fields
| |
Instances
newServiceStatistics :: ServiceStatistics Source #
Create a value of ServiceStatistics 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:errorStatistics:ServiceStatistics', serviceStatistics_errorStatistics - Information about requests that failed with a 4xx Client Error status
code.
$sel:faultStatistics:ServiceStatistics', serviceStatistics_faultStatistics - Information about requests that failed with a 5xx Server Error status
code.
$sel:okCount:ServiceStatistics', serviceStatistics_okCount - The number of requests that completed with a 2xx Success status code.
ServiceStatistics, serviceStatistics_totalCount - The total number of completed requests.
$sel:totalResponseTime:ServiceStatistics', serviceStatistics_totalResponseTime - The aggregate response time of completed requests.
serviceStatistics_errorStatistics :: Lens' ServiceStatistics (Maybe ErrorStatistics) Source #
Information about requests that failed with a 4xx Client Error status code.
serviceStatistics_faultStatistics :: Lens' ServiceStatistics (Maybe FaultStatistics) Source #
Information about requests that failed with a 5xx Server Error status code.
serviceStatistics_okCount :: Lens' ServiceStatistics (Maybe Integer) Source #
The number of requests that completed with a 2xx Success status code.
serviceStatistics_totalCount :: Lens' ServiceStatistics (Maybe Integer) Source #
The total number of completed requests.
serviceStatistics_totalResponseTime :: Lens' ServiceStatistics (Maybe Double) Source #
The aggregate response time of completed requests.
Tag
A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The following restrictions apply to tags:
- Maximum number of user-applied tags per resource: 50
- Tag keys and values are case sensitive.
- Don't use
aws:as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.XRay.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.XRay.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.XRay.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.XRay.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.XRay.Types.Tag" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:key:Tag', tag_key - A tag key, such as Stage or Name. A tag key cannot be empty. The key
can be a maximum of 128 characters, and can contain only Unicode
letters, numbers, or separators, or the following special characters:
+ - = . _ : /
$sel:value:Tag', tag_value - An optional tag value, such as Production or test-only. The value
can be a maximum of 255 characters, and contain only Unicode letters,
numbers, or separators, or the following special characters:
+ - = . _ : /
tag_key :: Lens' Tag Text Source #
A tag key, such as Stage or Name. A tag key cannot be empty. The key
can be a maximum of 128 characters, and can contain only Unicode
letters, numbers, or separators, or the following special characters:
+ - = . _ : /
tag_value :: Lens' Tag Text Source #
An optional tag value, such as Production or test-only. The value
can be a maximum of 255 characters, and contain only Unicode letters,
numbers, or separators, or the following special characters:
+ - = . _ : /
TelemetryRecord
data TelemetryRecord Source #
See: newTelemetryRecord smart constructor.
Constructors
| TelemetryRecord' | |
Instances
Arguments
| :: UTCTime | |
| -> TelemetryRecord |
Create a value of TelemetryRecord 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:backendConnectionErrors:TelemetryRecord', telemetryRecord_backendConnectionErrors -
$sel:segmentsReceivedCount:TelemetryRecord', telemetryRecord_segmentsReceivedCount -
$sel:segmentsRejectedCount:TelemetryRecord', telemetryRecord_segmentsRejectedCount -
$sel:segmentsSentCount:TelemetryRecord', telemetryRecord_segmentsSentCount -
$sel:segmentsSpilloverCount:TelemetryRecord', telemetryRecord_segmentsSpilloverCount -
$sel:timestamp:TelemetryRecord', telemetryRecord_timestamp -
telemetryRecord_backendConnectionErrors :: Lens' TelemetryRecord (Maybe BackendConnectionErrors) Source #
TimeSeriesServiceStatistics
data TimeSeriesServiceStatistics Source #
A list of TimeSeriesStatistic structures.
See: newTimeSeriesServiceStatistics smart constructor.
Constructors
| TimeSeriesServiceStatistics' | |
Fields
| |
Instances
newTimeSeriesServiceStatistics :: TimeSeriesServiceStatistics Source #
Create a value of TimeSeriesServiceStatistics 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:edgeSummaryStatistics:TimeSeriesServiceStatistics', timeSeriesServiceStatistics_edgeSummaryStatistics - Undocumented member.
$sel:responseTimeHistogram:TimeSeriesServiceStatistics', timeSeriesServiceStatistics_responseTimeHistogram - The response time histogram for the selected entities.
$sel:serviceForecastStatistics:TimeSeriesServiceStatistics', timeSeriesServiceStatistics_serviceForecastStatistics - The forecasted high and low fault count values.
$sel:serviceSummaryStatistics:TimeSeriesServiceStatistics', timeSeriesServiceStatistics_serviceSummaryStatistics - Undocumented member.
$sel:timestamp:TimeSeriesServiceStatistics', timeSeriesServiceStatistics_timestamp - Timestamp of the window for which statistics are aggregated.
timeSeriesServiceStatistics_edgeSummaryStatistics :: Lens' TimeSeriesServiceStatistics (Maybe EdgeStatistics) Source #
Undocumented member.
timeSeriesServiceStatistics_responseTimeHistogram :: Lens' TimeSeriesServiceStatistics (Maybe [HistogramEntry]) Source #
The response time histogram for the selected entities.
timeSeriesServiceStatistics_serviceForecastStatistics :: Lens' TimeSeriesServiceStatistics (Maybe ForecastStatistics) Source #
The forecasted high and low fault count values.
timeSeriesServiceStatistics_serviceSummaryStatistics :: Lens' TimeSeriesServiceStatistics (Maybe ServiceStatistics) Source #
Undocumented member.
timeSeriesServiceStatistics_timestamp :: Lens' TimeSeriesServiceStatistics (Maybe UTCTime) Source #
Timestamp of the window for which statistics are aggregated.
Trace
A collection of segment documents with matching trace IDs.
See: newTrace smart constructor.
Constructors
| Trace' | |
Fields
| |
Instances
| FromJSON Trace Source # | |
| Generic Trace Source # | |
| Read Trace Source # | |
| Show Trace Source # | |
| NFData Trace Source # | |
Defined in Amazonka.XRay.Types.Trace | |
| Eq Trace Source # | |
| Hashable Trace Source # | |
Defined in Amazonka.XRay.Types.Trace | |
| type Rep Trace Source # | |
Defined in Amazonka.XRay.Types.Trace type Rep Trace = D1 ('MetaData "Trace" "Amazonka.XRay.Types.Trace" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "Trace'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limitExceeded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "segments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Segment]))))) | |
Create a value of Trace 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:duration:Trace', trace_duration - The length of time in seconds between the start time of the root segment
and the end time of the last segment that completed.
Trace, trace_id - The unique identifier for the request that generated the trace's
segments and subsegments.
$sel:limitExceeded:Trace', trace_limitExceeded - LimitExceeded is set to true when the trace has exceeded the
Trace document size limit. For more information about this limit and
other X-Ray limits and quotas, see
Amazon Web Services X-Ray endpoints and quotas.
$sel:segments:Trace', trace_segments - Segment documents for the segments and subsegments that comprise the
trace.
trace_duration :: Lens' Trace (Maybe Double) Source #
The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
trace_id :: Lens' Trace (Maybe Text) Source #
The unique identifier for the request that generated the trace's segments and subsegments.
trace_limitExceeded :: Lens' Trace (Maybe Bool) Source #
LimitExceeded is set to true when the trace has exceeded the
Trace document size limit. For more information about this limit and
other X-Ray limits and quotas, see
Amazon Web Services X-Ray endpoints and quotas.
trace_segments :: Lens' Trace (Maybe [Segment]) Source #
Segment documents for the segments and subsegments that comprise the trace.
TraceSummary
data TraceSummary Source #
Metadata generated from the segment documents in a trace.
See: newTraceSummary smart constructor.
Constructors
| TraceSummary' | |
Fields
| |
Instances
newTraceSummary :: TraceSummary Source #
Create a value of TraceSummary 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:annotations:TraceSummary', traceSummary_annotations - Annotations from the trace's segment documents.
$sel:availabilityZones:TraceSummary', traceSummary_availabilityZones - A list of Availability Zones for any zone corresponding to the trace
segments.
$sel:duration:TraceSummary', traceSummary_duration - The length of time in seconds between the start time of the root segment
and the end time of the last segment that completed.
$sel:entryPoint:TraceSummary', traceSummary_entryPoint - The root of a trace.
$sel:errorRootCauses:TraceSummary', traceSummary_errorRootCauses - A collection of ErrorRootCause structures corresponding to the trace
segments.
$sel:faultRootCauses:TraceSummary', traceSummary_faultRootCauses - A collection of FaultRootCause structures corresponding to the trace
segments.
$sel:hasError:TraceSummary', traceSummary_hasError - The root segment document has a 400 series error.
$sel:hasFault:TraceSummary', traceSummary_hasFault - The root segment document has a 500 series error.
$sel:hasThrottle:TraceSummary', traceSummary_hasThrottle - One or more of the segment documents has a 429 throttling error.
$sel:http:TraceSummary', traceSummary_http - Information about the HTTP request served by the trace.
TraceSummary, traceSummary_id - The unique identifier for the request that generated the trace's
segments and subsegments.
$sel:instanceIds:TraceSummary', traceSummary_instanceIds - A list of EC2 instance IDs for any instance corresponding to the trace
segments.
$sel:isPartial:TraceSummary', traceSummary_isPartial - One or more of the segment documents is in progress.
$sel:matchedEventTime:TraceSummary', traceSummary_matchedEventTime - The matched time stamp of a defined event.
$sel:resourceARNs:TraceSummary', traceSummary_resourceARNs - A list of resource ARNs for any resource corresponding to the trace
segments.
$sel:responseTime:TraceSummary', traceSummary_responseTime - The length of time in seconds between the start and end times of the
root segment. If the service performs work asynchronously, the response
time measures the time before the response is sent to the user, while
the duration measures the amount of time before the last traced activity
completes.
$sel:responseTimeRootCauses:TraceSummary', traceSummary_responseTimeRootCauses - A collection of ResponseTimeRootCause structures corresponding to the
trace segments.
$sel:revision:TraceSummary', traceSummary_revision - The revision number of a trace.
TraceSummary, traceSummary_serviceIds - Service IDs from the trace's segment documents.
$sel:users:TraceSummary', traceSummary_users - Users from the trace's segment documents.
traceSummary_annotations :: Lens' TraceSummary (Maybe (HashMap Text [ValueWithServiceIds])) Source #
Annotations from the trace's segment documents.
traceSummary_availabilityZones :: Lens' TraceSummary (Maybe [AvailabilityZoneDetail]) Source #
A list of Availability Zones for any zone corresponding to the trace segments.
traceSummary_duration :: Lens' TraceSummary (Maybe Double) Source #
The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
traceSummary_entryPoint :: Lens' TraceSummary (Maybe ServiceId) Source #
The root of a trace.
traceSummary_errorRootCauses :: Lens' TraceSummary (Maybe [ErrorRootCause]) Source #
A collection of ErrorRootCause structures corresponding to the trace segments.
traceSummary_faultRootCauses :: Lens' TraceSummary (Maybe [FaultRootCause]) Source #
A collection of FaultRootCause structures corresponding to the trace segments.
traceSummary_hasError :: Lens' TraceSummary (Maybe Bool) Source #
The root segment document has a 400 series error.
traceSummary_hasFault :: Lens' TraceSummary (Maybe Bool) Source #
The root segment document has a 500 series error.
traceSummary_hasThrottle :: Lens' TraceSummary (Maybe Bool) Source #
One or more of the segment documents has a 429 throttling error.
traceSummary_http :: Lens' TraceSummary (Maybe Http) Source #
Information about the HTTP request served by the trace.
traceSummary_id :: Lens' TraceSummary (Maybe Text) Source #
The unique identifier for the request that generated the trace's segments and subsegments.
traceSummary_instanceIds :: Lens' TraceSummary (Maybe [InstanceIdDetail]) Source #
A list of EC2 instance IDs for any instance corresponding to the trace segments.
traceSummary_isPartial :: Lens' TraceSummary (Maybe Bool) Source #
One or more of the segment documents is in progress.
traceSummary_matchedEventTime :: Lens' TraceSummary (Maybe UTCTime) Source #
The matched time stamp of a defined event.
traceSummary_resourceARNs :: Lens' TraceSummary (Maybe [ResourceARNDetail]) Source #
A list of resource ARNs for any resource corresponding to the trace segments.
traceSummary_responseTime :: Lens' TraceSummary (Maybe Double) Source #
The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.
traceSummary_responseTimeRootCauses :: Lens' TraceSummary (Maybe [ResponseTimeRootCause]) Source #
A collection of ResponseTimeRootCause structures corresponding to the trace segments.
traceSummary_revision :: Lens' TraceSummary (Maybe Int) Source #
The revision number of a trace.
traceSummary_serviceIds :: Lens' TraceSummary (Maybe [ServiceId]) Source #
Service IDs from the trace's segment documents.
traceSummary_users :: Lens' TraceSummary (Maybe [TraceUser]) Source #
Users from the trace's segment documents.
TraceUser
Information about a user recorded in segment documents.
See: newTraceUser smart constructor.
Constructors
| TraceUser' | |
Instances
| FromJSON TraceUser Source # | |
| Generic TraceUser Source # | |
| Read TraceUser Source # | |
| Show TraceUser Source # | |
| NFData TraceUser Source # | |
Defined in Amazonka.XRay.Types.TraceUser | |
| Eq TraceUser Source # | |
| Hashable TraceUser Source # | |
Defined in Amazonka.XRay.Types.TraceUser | |
| type Rep TraceUser Source # | |
Defined in Amazonka.XRay.Types.TraceUser type Rep TraceUser = D1 ('MetaData "TraceUser" "Amazonka.XRay.Types.TraceUser" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "TraceUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceId])) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newTraceUser :: TraceUser Source #
Create a value of TraceUser 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:serviceIds:TraceUser', traceUser_serviceIds - Services that the user's request hit.
$sel:userName:TraceUser', traceUser_userName - The user's name.
traceUser_serviceIds :: Lens' TraceUser (Maybe [ServiceId]) Source #
Services that the user's request hit.
UnprocessedStatistics
data UnprocessedStatistics Source #
Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.
See: newUnprocessedStatistics smart constructor.
Constructors
| UnprocessedStatistics' | |
Instances
newUnprocessedStatistics :: UnprocessedStatistics Source #
Create a value of UnprocessedStatistics 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:errorCode:UnprocessedStatistics', unprocessedStatistics_errorCode - The error code.
$sel:message:UnprocessedStatistics', unprocessedStatistics_message - The error message.
$sel:ruleName:UnprocessedStatistics', unprocessedStatistics_ruleName - The name of the sampling rule.
unprocessedStatistics_errorCode :: Lens' UnprocessedStatistics (Maybe Text) Source #
The error code.
unprocessedStatistics_message :: Lens' UnprocessedStatistics (Maybe Text) Source #
The error message.
unprocessedStatistics_ruleName :: Lens' UnprocessedStatistics (Maybe Text) Source #
The name of the sampling rule.
UnprocessedTraceSegment
data UnprocessedTraceSegment Source #
Information about a segment that failed processing.
See: newUnprocessedTraceSegment smart constructor.
Constructors
| UnprocessedTraceSegment' | |
Instances
newUnprocessedTraceSegment :: UnprocessedTraceSegment Source #
Create a value of UnprocessedTraceSegment 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:errorCode:UnprocessedTraceSegment', unprocessedTraceSegment_errorCode - The error that caused processing to fail.
$sel:id:UnprocessedTraceSegment', unprocessedTraceSegment_id - The segment's ID.
$sel:message:UnprocessedTraceSegment', unprocessedTraceSegment_message - The error message.
unprocessedTraceSegment_errorCode :: Lens' UnprocessedTraceSegment (Maybe Text) Source #
The error that caused processing to fail.
unprocessedTraceSegment_id :: Lens' UnprocessedTraceSegment (Maybe Text) Source #
The segment's ID.
unprocessedTraceSegment_message :: Lens' UnprocessedTraceSegment (Maybe Text) Source #
The error message.
ValueWithServiceIds
data ValueWithServiceIds Source #
Information about a segment annotation.
See: newValueWithServiceIds smart constructor.
Constructors
| ValueWithServiceIds' | |
Fields
| |
Instances
newValueWithServiceIds :: ValueWithServiceIds Source #
Create a value of ValueWithServiceIds 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:annotationValue:ValueWithServiceIds', valueWithServiceIds_annotationValue - Values of the annotation.
$sel:serviceIds:ValueWithServiceIds', valueWithServiceIds_serviceIds - Services to which the annotation applies.
valueWithServiceIds_annotationValue :: Lens' ValueWithServiceIds (Maybe AnnotationValue) Source #
Values of the annotation.
valueWithServiceIds_serviceIds :: Lens' ValueWithServiceIds (Maybe [ServiceId]) Source #
Services to which the annotation applies.