Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- xRay :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottledException :: AsError a => Getting (First ServiceError) a ServiceError
- data Alias
- alias :: Alias
- aNames :: Lens' Alias [Text]
- aName :: Lens' Alias (Maybe Text)
- aType :: Lens' Alias (Maybe Text)
- data AnnotationValue
- annotationValue :: AnnotationValue
- avNumberValue :: Lens' AnnotationValue (Maybe Double)
- avStringValue :: Lens' AnnotationValue (Maybe Text)
- avBooleanValue :: Lens' AnnotationValue (Maybe Bool)
- data BackendConnectionErrors
- backendConnectionErrors :: BackendConnectionErrors
- bceOtherCount :: Lens' BackendConnectionErrors (Maybe Int)
- bceTimeoutCount :: Lens' BackendConnectionErrors (Maybe Int)
- bceHTTPCode5XXCount :: Lens' BackendConnectionErrors (Maybe Int)
- bceConnectionRefusedCount :: Lens' BackendConnectionErrors (Maybe Int)
- bceHTTPCode4XXCount :: Lens' BackendConnectionErrors (Maybe Int)
- bceUnknownHostCount :: Lens' BackendConnectionErrors (Maybe Int)
- data Edge
- edge :: Edge
- eStartTime :: Lens' Edge (Maybe UTCTime)
- eAliases :: Lens' Edge [Alias]
- eResponseTimeHistogram :: Lens' Edge [HistogramEntry]
- eReferenceId :: Lens' Edge (Maybe Int)
- eEndTime :: Lens' Edge (Maybe UTCTime)
- eSummaryStatistics :: Lens' Edge (Maybe EdgeStatistics)
- data EdgeStatistics
- edgeStatistics :: EdgeStatistics
- esFaultStatistics :: Lens' EdgeStatistics (Maybe FaultStatistics)
- esOKCount :: Lens' EdgeStatistics (Maybe Integer)
- esTotalResponseTime :: Lens' EdgeStatistics (Maybe Double)
- esErrorStatistics :: Lens' EdgeStatistics (Maybe ErrorStatistics)
- esTotalCount :: Lens' EdgeStatistics (Maybe Integer)
- data ErrorStatistics
- errorStatistics :: ErrorStatistics
- eOtherCount :: Lens' ErrorStatistics (Maybe Integer)
- eThrottleCount :: Lens' ErrorStatistics (Maybe Integer)
- eTotalCount :: Lens' ErrorStatistics (Maybe Integer)
- data FaultStatistics
- faultStatistics :: FaultStatistics
- fsOtherCount :: Lens' FaultStatistics (Maybe Integer)
- fsTotalCount :: Lens' FaultStatistics (Maybe Integer)
- data HTTP
- hTTP :: HTTP
- httpHTTPMethod :: Lens' HTTP (Maybe Text)
- httpHTTPStatus :: Lens' HTTP (Maybe Int)
- httpClientIP :: Lens' HTTP (Maybe Text)
- httpUserAgent :: Lens' HTTP (Maybe Text)
- httpHTTPURL :: Lens' HTTP (Maybe Text)
- data HistogramEntry
- histogramEntry :: HistogramEntry
- heCount :: Lens' HistogramEntry (Maybe Int)
- heValue :: Lens' HistogramEntry (Maybe Double)
- data Segment
- segment :: Segment
- sDocument :: Lens' Segment (Maybe Text)
- sId :: Lens' Segment (Maybe Text)
- data ServiceId
- serviceId :: ServiceId
- siAccountId :: Lens' ServiceId (Maybe Text)
- siNames :: Lens' ServiceId [Text]
- siName :: Lens' ServiceId (Maybe Text)
- siType :: Lens' ServiceId (Maybe Text)
- data ServiceInfo
- serviceInfo :: ServiceInfo
- sState :: Lens' ServiceInfo (Maybe Text)
- sStartTime :: Lens' ServiceInfo (Maybe UTCTime)
- sRoot :: Lens' ServiceInfo (Maybe Bool)
- sResponseTimeHistogram :: Lens' ServiceInfo [HistogramEntry]
- sDurationHistogram :: Lens' ServiceInfo [HistogramEntry]
- sReferenceId :: Lens' ServiceInfo (Maybe Int)
- sAccountId :: Lens' ServiceInfo (Maybe Text)
- sNames :: Lens' ServiceInfo [Text]
- sName :: Lens' ServiceInfo (Maybe Text)
- sEndTime :: Lens' ServiceInfo (Maybe UTCTime)
- sType :: Lens' ServiceInfo (Maybe Text)
- sEdges :: Lens' ServiceInfo [Edge]
- sSummaryStatistics :: Lens' ServiceInfo (Maybe ServiceStatistics)
- data ServiceStatistics
- serviceStatistics :: ServiceStatistics
- ssFaultStatistics :: Lens' ServiceStatistics (Maybe FaultStatistics)
- ssOKCount :: Lens' ServiceStatistics (Maybe Integer)
- ssTotalResponseTime :: Lens' ServiceStatistics (Maybe Double)
- ssErrorStatistics :: Lens' ServiceStatistics (Maybe ErrorStatistics)
- ssTotalCount :: Lens' ServiceStatistics (Maybe Integer)
- data TelemetryRecord
- telemetryRecord :: TelemetryRecord
- trSegmentsReceivedCount :: Lens' TelemetryRecord (Maybe Int)
- trSegmentsSentCount :: Lens' TelemetryRecord (Maybe Int)
- trSegmentsSpilloverCount :: Lens' TelemetryRecord (Maybe Int)
- trSegmentsRejectedCount :: Lens' TelemetryRecord (Maybe Int)
- trTimestamp :: Lens' TelemetryRecord (Maybe UTCTime)
- trBackendConnectionErrors :: Lens' TelemetryRecord (Maybe BackendConnectionErrors)
- data Trace
- trace :: Trace
- tId :: Lens' Trace (Maybe Text)
- tSegments :: Lens' Trace [Segment]
- tDuration :: Lens' Trace (Maybe Double)
- data TraceSummary
- traceSummary :: TraceSummary
- tsAnnotations :: Lens' TraceSummary (HashMap Text [ValueWithServiceIds])
- tsHasThrottle :: Lens' TraceSummary (Maybe Bool)
- tsUsers :: Lens' TraceSummary [TraceUser]
- tsHasFault :: Lens' TraceSummary (Maybe Bool)
- tsServiceIds :: Lens' TraceSummary [ServiceId]
- tsIsPartial :: Lens' TraceSummary (Maybe Bool)
- tsHasError :: Lens' TraceSummary (Maybe Bool)
- tsId :: Lens' TraceSummary (Maybe Text)
- tsHTTP :: Lens' TraceSummary (Maybe HTTP)
- tsDuration :: Lens' TraceSummary (Maybe Double)
- tsResponseTime :: Lens' TraceSummary (Maybe Double)
- data TraceUser
- traceUser :: TraceUser
- tuServiceIds :: Lens' TraceUser [ServiceId]
- tuUserName :: Lens' TraceUser (Maybe Text)
- data UnprocessedTraceSegment
- unprocessedTraceSegment :: UnprocessedTraceSegment
- utsErrorCode :: Lens' UnprocessedTraceSegment (Maybe Text)
- utsId :: Lens' UnprocessedTraceSegment (Maybe Text)
- utsMessage :: Lens' UnprocessedTraceSegment (Maybe Text)
- data ValueWithServiceIds
- valueWithServiceIds :: ValueWithServiceIds
- vwsiServiceIds :: Lens' ValueWithServiceIds [ServiceId]
- vwsiAnnotationValue :: Lens' ValueWithServiceIds (Maybe AnnotationValue)
Service Configuration
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request is missing required parameters or has invalid parameters.
_ThrottledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeds the maximum number of requests per second.
Alias
An alias for an edge.
See: alias
smart constructor.
AnnotationValue
data AnnotationValue Source #
Value of a segment annotation. Has one of three value types: Number, Boolean or String.
See: annotationValue
smart constructor.
annotationValue :: AnnotationValue Source #
Creates a value of AnnotationValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
avNumberValue
- Value for a Number annotation.avStringValue
- Value for a String annotation.avBooleanValue
- Value for a Boolean annotation.
avNumberValue :: Lens' AnnotationValue (Maybe Double) Source #
Value for a Number annotation.
avStringValue :: Lens' AnnotationValue (Maybe Text) Source #
Value for a String annotation.
avBooleanValue :: Lens' AnnotationValue (Maybe Bool) Source #
Value for a Boolean annotation.
BackendConnectionErrors
data BackendConnectionErrors Source #
See: backendConnectionErrors
smart constructor.
backendConnectionErrors :: BackendConnectionErrors Source #
Creates a value of BackendConnectionErrors
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Edge
Information about a connection between two services.
See: edge
smart constructor.
Creates a value of Edge
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eStartTime
- The start time of the first segment on the edge.eAliases
- Aliases for the edge.eResponseTimeHistogram
- A histogram that maps the spread of client response times on an edge.eReferenceId
- Identifier of the edge. Unique within a service map.eEndTime
- The end time of the last segment on the edge.eSummaryStatistics
- Response statistics for segments on the edge.
eResponseTimeHistogram :: Lens' Edge [HistogramEntry] Source #
A histogram that maps the spread of client response times on an edge.
eSummaryStatistics :: Lens' Edge (Maybe EdgeStatistics) Source #
Response statistics for segments on the edge.
EdgeStatistics
data EdgeStatistics Source #
Response statistics for an edge.
See: edgeStatistics
smart constructor.
edgeStatistics :: EdgeStatistics Source #
Creates a value of EdgeStatistics
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esFaultStatistics
- Information about requests that failed with a 5xx Server Error status code.esOKCount
- The number of requests that completed with a 2xx Success status code.esTotalResponseTime
- The aggregate response time of completed requests.esErrorStatistics
- Information about requests that failed with a 4xx Client Error status code.esTotalCount
- The total number of completed requests.
esFaultStatistics :: Lens' EdgeStatistics (Maybe FaultStatistics) Source #
Information about requests that failed with a 5xx Server Error status code.
esOKCount :: Lens' EdgeStatistics (Maybe Integer) Source #
The number of requests that completed with a 2xx Success status code.
esTotalResponseTime :: Lens' EdgeStatistics (Maybe Double) Source #
The aggregate response time of completed requests.
esErrorStatistics :: Lens' EdgeStatistics (Maybe ErrorStatistics) Source #
Information about requests that failed with a 4xx Client Error status code.
esTotalCount :: Lens' EdgeStatistics (Maybe Integer) Source #
The total number of completed requests.
ErrorStatistics
data ErrorStatistics Source #
Information about requests that failed with a 4xx Client Error status code.
See: errorStatistics
smart constructor.
errorStatistics :: ErrorStatistics Source #
Creates a value of ErrorStatistics
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eOtherCount
- The number of requests that failed with untracked 4xx Client Error status codes.eThrottleCount
- The number of requests that failed with a 419 throttling status code.eTotalCount
- The total number of requests that failed with a 4xx Client Error status code.
eOtherCount :: Lens' ErrorStatistics (Maybe Integer) Source #
The number of requests that failed with untracked 4xx Client Error status codes.
eThrottleCount :: Lens' ErrorStatistics (Maybe Integer) Source #
The number of requests that failed with a 419 throttling status code.
eTotalCount :: Lens' ErrorStatistics (Maybe Integer) Source #
The total number of requests that failed with a 4xx Client Error status code.
FaultStatistics
data FaultStatistics Source #
Information about requests that failed with a 5xx Server Error status code.
See: faultStatistics
smart constructor.
faultStatistics :: FaultStatistics Source #
Creates a value of FaultStatistics
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fsOtherCount
- The number of requests that failed with untracked 5xx Server Error status codes.fsTotalCount
- The total number of requests that failed with a 5xx Server Error status code.
fsOtherCount :: Lens' FaultStatistics (Maybe Integer) Source #
The number of requests that failed with untracked 5xx Server Error status codes.
fsTotalCount :: Lens' FaultStatistics (Maybe Integer) Source #
The total number of requests that failed with a 5xx Server Error status code.
HTTP
Information about an HTTP request.
See: hTTP
smart constructor.
Creates a value of HTTP
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
httpHTTPMethod
- The request method.httpHTTPStatus
- The response status.httpClientIP
- The IP address of the requestor.httpUserAgent
- The request's user agent string.httpHTTPURL
- The request URL.
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: histogramEntry
smart constructor.
histogramEntry :: HistogramEntry Source #
Creates a value of HistogramEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
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.
See: segment
smart constructor.
ServiceId
See: serviceId
smart constructor.
serviceId :: ServiceId Source #
Creates a value of ServiceId
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siAccountId
-siNames
-siName
-siType
-
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: serviceInfo
smart constructor.
serviceInfo :: ServiceInfo Source #
Creates a value of ServiceInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sState
- The service's state.sStartTime
- The start time of the first segment that the service generated.sRoot
- Indicates that the service was the first service to process a request.sResponseTimeHistogram
- A histogram that maps the spread of service response times.sDurationHistogram
- A histogram that maps the spread of service durations.sReferenceId
- Identifier for the service. Unique within the service map.sAccountId
- Identifier of the AWS account in which the service runs.sNames
- A list of names for the service, including the canonical name.sName
- The canonical name of the service.sEndTime
- The end time of the last segment that the service generated.sType
- The type of service. * AWS Resource - The type of an AWS resource. For example,AWS::EC2::Instance
for a application running on Amazon EC2 orAWS::DynamoDB::Table
for an Amazon DynamoDB table that the application used. * AWS Service - The type of an AWS service. For example,AWS::DynamoDB
for 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.sEdges
- Connections to downstream services.sSummaryStatistics
- Aggregated statistics for the service.
sStartTime :: Lens' ServiceInfo (Maybe UTCTime) Source #
The start time of the first segment that the service generated.
sRoot :: Lens' ServiceInfo (Maybe Bool) Source #
Indicates that the service was the first service to process a request.
sResponseTimeHistogram :: Lens' ServiceInfo [HistogramEntry] Source #
A histogram that maps the spread of service response times.
sDurationHistogram :: Lens' ServiceInfo [HistogramEntry] Source #
A histogram that maps the spread of service durations.
sReferenceId :: Lens' ServiceInfo (Maybe Int) Source #
Identifier for the service. Unique within the service map.
sAccountId :: Lens' ServiceInfo (Maybe Text) Source #
Identifier of the AWS account in which the service runs.
sNames :: Lens' ServiceInfo [Text] Source #
A list of names for the service, including the canonical name.
sEndTime :: Lens' ServiceInfo (Maybe UTCTime) Source #
The end time of the last segment that the service generated.
sType :: Lens' ServiceInfo (Maybe Text) Source #
The type of service. * AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance
for a application running on Amazon EC2 or AWS::DynamoDB::Table
for an Amazon DynamoDB table that the application used. * AWS Service - The type of an AWS service. For example, AWS::DynamoDB
for 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.
sSummaryStatistics :: Lens' ServiceInfo (Maybe ServiceStatistics) Source #
Aggregated statistics for the service.
ServiceStatistics
data ServiceStatistics Source #
Response statistics for a service.
See: serviceStatistics
smart constructor.
serviceStatistics :: ServiceStatistics Source #
Creates a value of ServiceStatistics
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssFaultStatistics
- Information about requests that failed with a 5xx Server Error status code.ssOKCount
- The number of requests that completed with a 2xx Success status code.ssTotalResponseTime
- The aggregate response time of completed requests.ssErrorStatistics
- Information about requests that failed with a 4xx Client Error status code.ssTotalCount
- The total number of completed requests.
ssFaultStatistics :: Lens' ServiceStatistics (Maybe FaultStatistics) Source #
Information about requests that failed with a 5xx Server Error status code.
ssOKCount :: Lens' ServiceStatistics (Maybe Integer) Source #
The number of requests that completed with a 2xx Success status code.
ssTotalResponseTime :: Lens' ServiceStatistics (Maybe Double) Source #
The aggregate response time of completed requests.
ssErrorStatistics :: Lens' ServiceStatistics (Maybe ErrorStatistics) Source #
Information about requests that failed with a 4xx Client Error status code.
ssTotalCount :: Lens' ServiceStatistics (Maybe Integer) Source #
The total number of completed requests.
TelemetryRecord
data TelemetryRecord Source #
See: telemetryRecord
smart constructor.
telemetryRecord :: TelemetryRecord Source #
Creates a value of TelemetryRecord
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Trace
A collection of segment documents with matching trace IDs.
See: trace
smart constructor.
Creates a value of Trace
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tId
- The unique identifier for the request that generated the trace's segments and subsegments.tSegments
- Segment documents for the segments and subsegments that comprise the trace.tDuration
- The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.
tId :: Lens' Trace (Maybe Text) Source #
The unique identifier for the request that generated the trace's segments and subsegments.
tSegments :: Lens' Trace [Segment] Source #
Segment documents for the segments and subsegments that comprise the trace.
tDuration :: 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.
TraceSummary
data TraceSummary Source #
Metadata generated from the segment documents in a trace.
See: traceSummary
smart constructor.
traceSummary :: TraceSummary Source #
Creates a value of TraceSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsAnnotations
- Annotations from the trace's segment documents.tsHasThrottle
- One or more of the segment documents has a 429 throttling error.tsUsers
- Users from the trace's segment documents.tsHasFault
- One or more of the segment documents has a 500 series error.tsServiceIds
- Service IDs from the trace's segment documents.tsIsPartial
- One or more of the segment documents is in progress.tsHasError
- One or more of the segment documents has a 400 series error.tsId
- The unique identifier for the request that generated the trace's segments and subsegments.tsHTTP
- Information about the HTTP request served by the trace.tsDuration
- The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.tsResponseTime
- 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.
tsAnnotations :: Lens' TraceSummary (HashMap Text [ValueWithServiceIds]) Source #
Annotations from the trace's segment documents.
tsHasThrottle :: Lens' TraceSummary (Maybe Bool) Source #
One or more of the segment documents has a 429 throttling error.
tsHasFault :: Lens' TraceSummary (Maybe Bool) Source #
One or more of the segment documents has a 500 series error.
tsServiceIds :: Lens' TraceSummary [ServiceId] Source #
Service IDs from the trace's segment documents.
tsIsPartial :: Lens' TraceSummary (Maybe Bool) Source #
One or more of the segment documents is in progress.
tsHasError :: Lens' TraceSummary (Maybe Bool) Source #
One or more of the segment documents has a 400 series error.
tsId :: Lens' TraceSummary (Maybe Text) Source #
The unique identifier for the request that generated the trace's segments and subsegments.
tsHTTP :: Lens' TraceSummary (Maybe HTTP) Source #
Information about the HTTP request served by the trace.
tsDuration :: 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.
tsResponseTime :: 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.
TraceUser
Information about a user recorded in segment documents.
See: traceUser
smart constructor.
traceUser :: TraceUser Source #
Creates a value of TraceUser
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tuServiceIds
- Services that the user's request hit.tuUserName
- The user's name.
UnprocessedTraceSegment
data UnprocessedTraceSegment Source #
Information about a segment that failed processing.
See: unprocessedTraceSegment
smart constructor.
unprocessedTraceSegment :: UnprocessedTraceSegment Source #
Creates a value of UnprocessedTraceSegment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
utsErrorCode
- The error that caused processing to fail.utsId
- The segment's ID.utsMessage
- The error message.
utsErrorCode :: Lens' UnprocessedTraceSegment (Maybe Text) Source #
The error that caused processing to fail.
utsMessage :: Lens' UnprocessedTraceSegment (Maybe Text) Source #
The error message.
ValueWithServiceIds
data ValueWithServiceIds Source #
Information about a segment annotation.
See: valueWithServiceIds
smart constructor.
valueWithServiceIds :: ValueWithServiceIds Source #
Creates a value of ValueWithServiceIds
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vwsiServiceIds
- Services to which the annotation applies.vwsiAnnotationValue
- Values of the annotation.
vwsiServiceIds :: Lens' ValueWithServiceIds [ServiceId] Source #
Services to which the annotation applies.
vwsiAnnotationValue :: Lens' ValueWithServiceIds (Maybe AnnotationValue) Source #
Values of the annotation.