...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/xray"
Overview
Constants

Overview ▾

Package xray provides the client and types for making API requests to AWS X-Ray.

AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

See https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12 for more information on this service.

See xray package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/xray/

Using the Client

To contact AWS X-Ray with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS X-Ray client XRay for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/xray/#New

The stub package, xrayiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type Alias
func (s *Alias) SetName(v string) *Alias
func (s *Alias) SetNames(v []*string) *Alias
func (s *Alias) SetType(v string) *Alias
type AnnotationValue
func (s *AnnotationValue) SetBooleanValue(v bool) *AnnotationValue
func (s *AnnotationValue) SetNumberValue(v float64) *AnnotationValue
func (s *AnnotationValue) SetStringValue(v string) *AnnotationValue
type BackendConnectionErrors
func (s *BackendConnectionErrors) SetConnectionRefusedCount(v int64) *BackendConnectionErrors
func (s *BackendConnectionErrors) SetHTTPCode4XXCount(v int64) *BackendConnectionErrors
func (s *BackendConnectionErrors) SetHTTPCode5XXCount(v int64) *BackendConnectionErrors
func (s *BackendConnectionErrors) SetOtherCount(v int64) *BackendConnectionErrors
func (s *BackendConnectionErrors) SetTimeoutCount(v int64) *BackendConnectionErrors
func (s *BackendConnectionErrors) SetUnknownHostCount(v int64) *BackendConnectionErrors
type BatchGetTracesInput
func (s *BatchGetTracesInput) SetNextToken(v string) *BatchGetTracesInput
func (s *BatchGetTracesInput) SetTraceIds(v []*string) *BatchGetTracesInput
type BatchGetTracesOutput
func (s *BatchGetTracesOutput) SetNextToken(v string) *BatchGetTracesOutput
func (s *BatchGetTracesOutput) SetTraces(v []*Trace) *BatchGetTracesOutput
func (s *BatchGetTracesOutput) SetUnprocessedTraceIds(v []*string) *BatchGetTracesOutput
type Edge
func (s *Edge) SetAliases(v []*Alias) *Edge
func (s *Edge) SetEndTime(v time.Time) *Edge
func (s *Edge) SetReferenceId(v int64) *Edge
func (s *Edge) SetResponseTimeHistogram(v []*HistogramEntry) *Edge
func (s *Edge) SetStartTime(v time.Time) *Edge
func (s *Edge) SetSummaryStatistics(v *EdgeStatistics) *Edge
type EdgeStatistics
func (s *EdgeStatistics) SetErrorStatistics(v *ErrorStatistics) *EdgeStatistics
func (s *EdgeStatistics) SetFaultStatistics(v *FaultStatistics) *EdgeStatistics
func (s *EdgeStatistics) SetOkCount(v int64) *EdgeStatistics
func (s *EdgeStatistics) SetTotalCount(v int64) *EdgeStatistics
func (s *EdgeStatistics) SetTotalResponseTime(v float64) *EdgeStatistics
type EncryptionConfig
func (s *EncryptionConfig) SetKeyId(v string) *EncryptionConfig
func (s *EncryptionConfig) SetStatus(v string) *EncryptionConfig
func (s *EncryptionConfig) SetType(v string) *EncryptionConfig
type ErrorStatistics
func (s *ErrorStatistics) SetOtherCount(v int64) *ErrorStatistics
func (s *ErrorStatistics) SetThrottleCount(v int64) *ErrorStatistics
func (s *ErrorStatistics) SetTotalCount(v int64) *ErrorStatistics
type FaultStatistics
func (s *FaultStatistics) SetOtherCount(v int64) *FaultStatistics
func (s *FaultStatistics) SetTotalCount(v int64) *FaultStatistics
type GetEncryptionConfigInput
type GetEncryptionConfigOutput
func (s *GetEncryptionConfigOutput) SetEncryptionConfig(v *EncryptionConfig) *GetEncryptionConfigOutput
type GetServiceGraphInput
func (s *GetServiceGraphInput) SetEndTime(v time.Time) *GetServiceGraphInput
func (s *GetServiceGraphInput) SetNextToken(v string) *GetServiceGraphInput
func (s *GetServiceGraphInput) SetStartTime(v time.Time) *GetServiceGraphInput
type GetServiceGraphOutput
func (s *GetServiceGraphOutput) SetEndTime(v time.Time) *GetServiceGraphOutput
func (s *GetServiceGraphOutput) SetNextToken(v string) *GetServiceGraphOutput
func (s *GetServiceGraphOutput) SetServices(v []*Service) *GetServiceGraphOutput
func (s *GetServiceGraphOutput) SetStartTime(v time.Time) *GetServiceGraphOutput
type GetTraceGraphInput
func (s *GetTraceGraphInput) SetNextToken(v string) *GetTraceGraphInput
func (s *GetTraceGraphInput) SetTraceIds(v []*string) *GetTraceGraphInput
type GetTraceGraphOutput
func (s *GetTraceGraphOutput) SetNextToken(v string) *GetTraceGraphOutput
func (s *GetTraceGraphOutput) SetServices(v []*Service) *GetTraceGraphOutput
type GetTraceSummariesInput
func (s *GetTraceSummariesInput) SetEndTime(v time.Time) *GetTraceSummariesInput
func (s *GetTraceSummariesInput) SetFilterExpression(v string) *GetTraceSummariesInput
func (s *GetTraceSummariesInput) SetNextToken(v string) *GetTraceSummariesInput
func (s *GetTraceSummariesInput) SetSampling(v bool) *GetTraceSummariesInput
func (s *GetTraceSummariesInput) SetStartTime(v time.Time) *GetTraceSummariesInput
type GetTraceSummariesOutput
func (s *GetTraceSummariesOutput) SetApproximateTime(v time.Time) *GetTraceSummariesOutput
func (s *GetTraceSummariesOutput) SetNextToken(v string) *GetTraceSummariesOutput
func (s *GetTraceSummariesOutput) SetTraceSummaries(v []*TraceSummary) *GetTraceSummariesOutput
func (s *GetTraceSummariesOutput) SetTracesProcessedCount(v int64) *GetTraceSummariesOutput
type HistogramEntry
func (s *HistogramEntry) SetCount(v int64) *HistogramEntry
func (s *HistogramEntry) SetValue(v float64) *HistogramEntry
type Http
func (s *Http) SetClientIp(v string) *Http
func (s *Http) SetHttpMethod(v string) *Http
func (s *Http) SetHttpStatus(v int64) *Http
func (s *Http) SetHttpURL(v string) *Http
func (s *Http) SetUserAgent(v string) *Http
type PutEncryptionConfigInput
func (s *PutEncryptionConfigInput) SetKeyId(v string) *PutEncryptionConfigInput
func (s *PutEncryptionConfigInput) SetType(v string) *PutEncryptionConfigInput
type PutEncryptionConfigOutput
func (s *PutEncryptionConfigOutput) SetEncryptionConfig(v *EncryptionConfig) *PutEncryptionConfigOutput
type PutTelemetryRecordsInput
func (s *PutTelemetryRecordsInput) SetEC2InstanceId(v string) *PutTelemetryRecordsInput
func (s *PutTelemetryRecordsInput) SetHostname(v string) *PutTelemetryRecordsInput
func (s *PutTelemetryRecordsInput) SetResourceARN(v string) *PutTelemetryRecordsInput
func (s *PutTelemetryRecordsInput) SetTelemetryRecords(v []*TelemetryRecord) *PutTelemetryRecordsInput
type PutTelemetryRecordsOutput
type PutTraceSegmentsInput
func (s *PutTraceSegmentsInput) SetTraceSegmentDocuments(v []*string) *PutTraceSegmentsInput
type PutTraceSegmentsOutput
func (s *PutTraceSegmentsOutput) SetUnprocessedTraceSegments(v []*UnprocessedTraceSegment) *PutTraceSegmentsOutput
type Segment
func (s *Segment) SetDocument(v string) *Segment
func (s *Segment) SetId(v string) *Segment
type Service
func (s *Service) SetAccountId(v string) *Service
func (s *Service) SetDurationHistogram(v []*HistogramEntry) *Service
func (s *Service) SetEdges(v []*Edge) *Service
func (s *Service) SetEndTime(v time.Time) *Service
func (s *Service) SetName(v string) *Service
func (s *Service) SetNames(v []*string) *Service
func (s *Service) SetReferenceId(v int64) *Service
func (s *Service) SetResponseTimeHistogram(v []*HistogramEntry) *Service
func (s *Service) SetRoot(v bool) *Service
func (s *Service) SetStartTime(v time.Time) *Service
func (s *Service) SetState(v string) *Service
func (s *Service) SetSummaryStatistics(v *ServiceStatistics) *Service
func (s *Service) SetType(v string) *Service
type ServiceId
func (s *ServiceId) SetAccountId(v string) *ServiceId
func (s *ServiceId) SetName(v string) *ServiceId
func (s *ServiceId) SetNames(v []*string) *ServiceId
func (s *ServiceId) SetType(v string) *ServiceId
type ServiceStatistics
func (s *ServiceStatistics) SetErrorStatistics(v *ErrorStatistics) *ServiceStatistics
func (s *ServiceStatistics) SetFaultStatistics(v *FaultStatistics) *ServiceStatistics
func (s *ServiceStatistics) SetOkCount(v int64) *ServiceStatistics
func (s *ServiceStatistics) SetTotalCount(v int64) *ServiceStatistics
func (s *ServiceStatistics) SetTotalResponseTime(v float64) *ServiceStatistics
type TelemetryRecord
func (s *TelemetryRecord) SetBackendConnectionErrors(v *BackendConnectionErrors) *TelemetryRecord
func (s *TelemetryRecord) SetSegmentsReceivedCount(v int64) *TelemetryRecord
func (s *TelemetryRecord) SetSegmentsRejectedCount(v int64) *TelemetryRecord
func (s *TelemetryRecord) SetSegmentsSentCount(v int64) *TelemetryRecord
func (s *TelemetryRecord) SetSegmentsSpilloverCount(v int64) *TelemetryRecord
func (s *TelemetryRecord) SetTimestamp(v time.Time) *TelemetryRecord
type Trace
func (s *Trace) SetDuration(v float64) *Trace
func (s *Trace) SetId(v string) *Trace
func (s *Trace) SetSegments(v []*Segment) *Trace
type TraceSummary
func (s *TraceSummary) SetAnnotations(v map[string][]*ValueWithServiceIds) *TraceSummary
func (s *TraceSummary) SetDuration(v float64) *TraceSummary
func (s *TraceSummary) SetHasError(v bool) *TraceSummary
func (s *TraceSummary) SetHasFault(v bool) *TraceSummary
func (s *TraceSummary) SetHasThrottle(v bool) *TraceSummary
func (s *TraceSummary) SetHttp(v *Http) *TraceSummary
func (s *TraceSummary) SetId(v string) *TraceSummary
func (s *TraceSummary) SetIsPartial(v bool) *TraceSummary
func (s *TraceSummary) SetResponseTime(v float64) *TraceSummary
func (s *TraceSummary) SetServiceIds(v []*ServiceId) *TraceSummary
func (s *TraceSummary) SetUsers(v []*TraceUser) *TraceSummary
type TraceUser
func (s *TraceUser) SetServiceIds(v []*ServiceId) *TraceUser
func (s *TraceUser) SetUserName(v string) *TraceUser
type UnprocessedTraceSegment
func (s *UnprocessedTraceSegment) SetErrorCode(v string) *UnprocessedTraceSegment
func (s *UnprocessedTraceSegment) SetId(v string) *UnprocessedTraceSegment
func (s *UnprocessedTraceSegment) SetMessage(v string) *UnprocessedTraceSegment
type ValueWithServiceIds
func (s *ValueWithServiceIds) SetAnnotationValue(v *AnnotationValue) *ValueWithServiceIds
func (s *ValueWithServiceIds) SetServiceIds(v []*ServiceId) *ValueWithServiceIds
type XRay

Constants ▾

const (
    // EncryptionStatusUpdating is a EncryptionStatus enum value
    EncryptionStatusUpdating = "UPDATING"

    // EncryptionStatusActive is a EncryptionStatus enum value
    EncryptionStatusActive = "ACTIVE"
)
const (
    // EncryptionTypeNone is a EncryptionType enum value
    EncryptionTypeNone = "NONE"

    // EncryptionTypeKms is a EncryptionType enum value
    EncryptionTypeKms = "KMS"
)
const (

    // ErrCodeInvalidRequestException for service response error code
    // "InvalidRequestException".
    //
    // The request is missing required parameters or has invalid parameters.
    ErrCodeInvalidRequestException = "InvalidRequestException"

    // ErrCodeThrottledException for service response error code
    // "ThrottledException".
    //
    // The request exceeds the maximum number of requests per second.
    ErrCodeThrottledException = "ThrottledException"
)
const (
    ServiceName = "xray"      // Service endpoint prefix API calls made to.
    EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

type Alias

type Alias struct {

    // The canonical name of the alias.
    Name *string `type:"string"`

    // A list of names for the alias, including the canonical name.
    Names []*string `type:"list"`

    // The type of the alias.
    Type *string `type:"string"`
    // contains filtered or unexported fields
}

An alias for an edge.

func (Alias) GoString

func (s Alias) GoString() string

GoString returns the string representation

func (*Alias) SetName

func (s *Alias) SetName(v string) *Alias

SetName sets the Name field's value.

func (*Alias) SetNames

func (s *Alias) SetNames(v []*string) *Alias

SetNames sets the Names field's value.

func (*Alias) SetType

func (s *Alias) SetType(v string) *Alias

SetType sets the Type field's value.

func (Alias) String

func (s Alias) String() string

String returns the string representation

type AnnotationValue

type AnnotationValue struct {

    // Value for a Boolean annotation.
    BooleanValue *bool `type:"boolean"`

    // Value for a Number annotation.
    NumberValue *float64 `type:"double"`

    // Value for a String annotation.
    StringValue *string `type:"string"`
    // contains filtered or unexported fields
}

Value of a segment annotation. Has one of three value types: Number, Boolean or String.

func (AnnotationValue) GoString

func (s AnnotationValue) GoString() string

GoString returns the string representation

func (*AnnotationValue) SetBooleanValue

func (s *AnnotationValue) SetBooleanValue(v bool) *AnnotationValue

SetBooleanValue sets the BooleanValue field's value.

func (*AnnotationValue) SetNumberValue

func (s *AnnotationValue) SetNumberValue(v float64) *AnnotationValue

SetNumberValue sets the NumberValue field's value.

func (*AnnotationValue) SetStringValue

func (s *AnnotationValue) SetStringValue(v string) *AnnotationValue

SetStringValue sets the StringValue field's value.

func (AnnotationValue) String

func (s AnnotationValue) String() string

String returns the string representation

type BackendConnectionErrors

type BackendConnectionErrors struct {
    ConnectionRefusedCount *int64 `type:"integer"`

    HTTPCode4XXCount *int64 `type:"integer"`

    HTTPCode5XXCount *int64 `type:"integer"`

    OtherCount *int64 `type:"integer"`

    TimeoutCount *int64 `type:"integer"`

    UnknownHostCount *int64 `type:"integer"`
    // contains filtered or unexported fields
}

func (BackendConnectionErrors) GoString

func (s BackendConnectionErrors) GoString() string

GoString returns the string representation

func (*BackendConnectionErrors) SetConnectionRefusedCount

func (s *BackendConnectionErrors) SetConnectionRefusedCount(v int64) *BackendConnectionErrors

SetConnectionRefusedCount sets the ConnectionRefusedCount field's value.

func (*BackendConnectionErrors) SetHTTPCode4XXCount

func (s *BackendConnectionErrors) SetHTTPCode4XXCount(v int64) *BackendConnectionErrors

SetHTTPCode4XXCount sets the HTTPCode4XXCount field's value.

func (*BackendConnectionErrors) SetHTTPCode5XXCount

func (s *BackendConnectionErrors) SetHTTPCode5XXCount(v int64) *BackendConnectionErrors

SetHTTPCode5XXCount sets the HTTPCode5XXCount field's value.

func (*BackendConnectionErrors) SetOtherCount

func (s *BackendConnectionErrors) SetOtherCount(v int64) *BackendConnectionErrors

SetOtherCount sets the OtherCount field's value.

func (*BackendConnectionErrors) SetTimeoutCount

func (s *BackendConnectionErrors) SetTimeoutCount(v int64) *BackendConnectionErrors

SetTimeoutCount sets the TimeoutCount field's value.

func (*BackendConnectionErrors) SetUnknownHostCount

func (s *BackendConnectionErrors) SetUnknownHostCount(v int64) *BackendConnectionErrors

SetUnknownHostCount sets the UnknownHostCount field's value.

func (BackendConnectionErrors) String

func (s BackendConnectionErrors) String() string

String returns the string representation

type BatchGetTracesInput

type BatchGetTracesInput struct {

    // Pagination token. Not used.
    NextToken *string `type:"string"`

    // Specify the trace IDs of requests for which to retrieve segments.
    //
    // TraceIds is a required field
    TraceIds []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchGetTracesInput) GoString

func (s BatchGetTracesInput) GoString() string

GoString returns the string representation

func (*BatchGetTracesInput) SetNextToken

func (s *BatchGetTracesInput) SetNextToken(v string) *BatchGetTracesInput

SetNextToken sets the NextToken field's value.

func (*BatchGetTracesInput) SetTraceIds

func (s *BatchGetTracesInput) SetTraceIds(v []*string) *BatchGetTracesInput

SetTraceIds sets the TraceIds field's value.

func (BatchGetTracesInput) String

func (s BatchGetTracesInput) String() string

String returns the string representation

func (*BatchGetTracesInput) Validate

func (s *BatchGetTracesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetTracesOutput

type BatchGetTracesOutput struct {

    // Pagination token. Not used.
    NextToken *string `type:"string"`

    // Full traces for the specified requests.
    Traces []*Trace `type:"list"`

    // Trace IDs of requests that haven't been processed.
    UnprocessedTraceIds []*string `type:"list"`
    // contains filtered or unexported fields
}

func (BatchGetTracesOutput) GoString

func (s BatchGetTracesOutput) GoString() string

GoString returns the string representation

func (*BatchGetTracesOutput) SetNextToken

func (s *BatchGetTracesOutput) SetNextToken(v string) *BatchGetTracesOutput

SetNextToken sets the NextToken field's value.

func (*BatchGetTracesOutput) SetTraces

func (s *BatchGetTracesOutput) SetTraces(v []*Trace) *BatchGetTracesOutput

SetTraces sets the Traces field's value.

func (*BatchGetTracesOutput) SetUnprocessedTraceIds

func (s *BatchGetTracesOutput) SetUnprocessedTraceIds(v []*string) *BatchGetTracesOutput

SetUnprocessedTraceIds sets the UnprocessedTraceIds field's value.

func (BatchGetTracesOutput) String

func (s BatchGetTracesOutput) String() string

String returns the string representation

type Edge

type Edge struct {

    // Aliases for the edge.
    Aliases []*Alias `type:"list"`

    // The end time of the last segment on the edge.
    EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

    // Identifier of the edge. Unique within a service map.
    ReferenceId *int64 `type:"integer"`

    // A histogram that maps the spread of client response times on an edge.
    ResponseTimeHistogram []*HistogramEntry `type:"list"`

    // The start time of the first segment on the edge.
    StartTime *time.Time `type:"timestamp" timestampFormat:"unix"`

    // Response statistics for segments on the edge.
    SummaryStatistics *EdgeStatistics `type:"structure"`
    // contains filtered or unexported fields
}

Information about a connection between two services.

func (Edge) GoString

func (s Edge) GoString() string

GoString returns the string representation

func (*Edge) SetAliases

func (s *Edge) SetAliases(v []*Alias) *Edge

SetAliases sets the Aliases field's value.

func (*Edge) SetEndTime

func (s *Edge) SetEndTime(v time.Time) *Edge

SetEndTime sets the EndTime field's value.

func (*Edge) SetReferenceId

func (s *Edge) SetReferenceId(v int64) *Edge

SetReferenceId sets the ReferenceId field's value.

func (*Edge) SetResponseTimeHistogram

func (s *Edge) SetResponseTimeHistogram(v []*HistogramEntry) *Edge

SetResponseTimeHistogram sets the ResponseTimeHistogram field's value.

func (*Edge) SetStartTime

func (s *Edge) SetStartTime(v time.Time) *Edge

SetStartTime sets the StartTime field's value.

func (*Edge) SetSummaryStatistics

func (s *Edge) SetSummaryStatistics(v *EdgeStatistics) *Edge

SetSummaryStatistics sets the SummaryStatistics field's value.

func (Edge) String

func (s Edge) String() string

String returns the string representation

type EdgeStatistics

type EdgeStatistics struct {

    // Information about requests that failed with a 4xx Client Error status code.
    ErrorStatistics *ErrorStatistics `type:"structure"`

    // Information about requests that failed with a 5xx Server Error status code.
    FaultStatistics *FaultStatistics `type:"structure"`

    // The number of requests that completed with a 2xx Success status code.
    OkCount *int64 `type:"long"`

    // The total number of completed requests.
    TotalCount *int64 `type:"long"`

    // The aggregate response time of completed requests.
    TotalResponseTime *float64 `type:"double"`
    // contains filtered or unexported fields
}

Response statistics for an edge.

func (EdgeStatistics) GoString

func (s EdgeStatistics) GoString() string

GoString returns the string representation

func (*EdgeStatistics) SetErrorStatistics

func (s *EdgeStatistics) SetErrorStatistics(v *ErrorStatistics) *EdgeStatistics

SetErrorStatistics sets the ErrorStatistics field's value.

func (*EdgeStatistics) SetFaultStatistics

func (s *EdgeStatistics) SetFaultStatistics(v *FaultStatistics) *EdgeStatistics

SetFaultStatistics sets the FaultStatistics field's value.

func (*EdgeStatistics) SetOkCount

func (s *EdgeStatistics) SetOkCount(v int64) *EdgeStatistics

SetOkCount sets the OkCount field's value.

func (*EdgeStatistics) SetTotalCount

func (s *EdgeStatistics) SetTotalCount(v int64) *EdgeStatistics

SetTotalCount sets the TotalCount field's value.

func (*EdgeStatistics) SetTotalResponseTime

func (s *EdgeStatistics) SetTotalResponseTime(v float64) *EdgeStatistics

SetTotalResponseTime sets the TotalResponseTime field's value.

func (EdgeStatistics) String

func (s EdgeStatistics) String() string

String returns the string representation

type EncryptionConfig

type EncryptionConfig struct {

    // The ID of the customer master key (CMK) used for encryption, if applicable.
    KeyId *string `type:"string"`

    // The encryption status. After modifying encryption configuration with PutEncryptionConfig,
    // the status can be UPDATING for up to one hour before X-Ray starts encrypting
    // data with the new key.
    Status *string `type:"string" enum:"EncryptionStatus"`

    // The type of encryption. Set to KMS for encryption with CMKs. Set to NONE
    // for default encryption.
    Type *string `type:"string" enum:"EncryptionType"`
    // contains filtered or unexported fields
}

A configuration document that specifies encryption configuration settings.

func (EncryptionConfig) GoString

func (s EncryptionConfig) GoString() string

GoString returns the string representation

func (*EncryptionConfig) SetKeyId

func (s *EncryptionConfig) SetKeyId(v string) *EncryptionConfig

SetKeyId sets the KeyId field's value.

func (*EncryptionConfig) SetStatus

func (s *EncryptionConfig) SetStatus(v string) *EncryptionConfig

SetStatus sets the Status field's value.

func (*EncryptionConfig) SetType

func (s *EncryptionConfig) SetType(v string) *EncryptionConfig

SetType sets the Type field's value.

func (EncryptionConfig) String

func (s EncryptionConfig) String() string

String returns the string representation

type ErrorStatistics

type ErrorStatistics struct {

    // The number of requests that failed with untracked 4xx Client Error status
    // codes.
    OtherCount *int64 `type:"long"`

    // The number of requests that failed with a 419 throttling status code.
    ThrottleCount *int64 `type:"long"`

    // The total number of requests that failed with a 4xx Client Error status code.
    TotalCount *int64 `type:"long"`
    // contains filtered or unexported fields
}

Information about requests that failed with a 4xx Client Error status code.

func (ErrorStatistics) GoString

func (s ErrorStatistics) GoString() string

GoString returns the string representation

func (*ErrorStatistics) SetOtherCount

func (s *ErrorStatistics) SetOtherCount(v int64) *ErrorStatistics

SetOtherCount sets the OtherCount field's value.

func (*ErrorStatistics) SetThrottleCount

func (s *ErrorStatistics) SetThrottleCount(v int64) *ErrorStatistics

SetThrottleCount sets the ThrottleCount field's value.

func (*ErrorStatistics) SetTotalCount

func (s *ErrorStatistics) SetTotalCount(v int64) *ErrorStatistics

SetTotalCount sets the TotalCount field's value.

func (ErrorStatistics) String

func (s ErrorStatistics) String() string

String returns the string representation

type FaultStatistics

type FaultStatistics struct {

    // The number of requests that failed with untracked 5xx Server Error status
    // codes.
    OtherCount *int64 `type:"long"`

    // The total number of requests that failed with a 5xx Server Error status code.
    TotalCount *int64 `type:"long"`
    // contains filtered or unexported fields
}

Information about requests that failed with a 5xx Server Error status code.

func (FaultStatistics) GoString

func (s FaultStatistics) GoString() string

GoString returns the string representation

func (*FaultStatistics) SetOtherCount

func (s *FaultStatistics) SetOtherCount(v int64) *FaultStatistics

SetOtherCount sets the OtherCount field's value.

func (*FaultStatistics) SetTotalCount

func (s *FaultStatistics) SetTotalCount(v int64) *FaultStatistics

SetTotalCount sets the TotalCount field's value.

func (FaultStatistics) String

func (s FaultStatistics) String() string

String returns the string representation

type GetEncryptionConfigInput

type GetEncryptionConfigInput struct {
    // contains filtered or unexported fields
}

func (GetEncryptionConfigInput) GoString

func (s GetEncryptionConfigInput) GoString() string

GoString returns the string representation

func (GetEncryptionConfigInput) String

func (s GetEncryptionConfigInput) String() string

String returns the string representation

type GetEncryptionConfigOutput

type GetEncryptionConfigOutput struct {

    // The encryption configuration document.
    EncryptionConfig *EncryptionConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (GetEncryptionConfigOutput) GoString

func (s GetEncryptionConfigOutput) GoString() string

GoString returns the string representation

func (*GetEncryptionConfigOutput) SetEncryptionConfig

func (s *GetEncryptionConfigOutput) SetEncryptionConfig(v *EncryptionConfig) *GetEncryptionConfigOutput

SetEncryptionConfig sets the EncryptionConfig field's value.

func (GetEncryptionConfigOutput) String

func (s GetEncryptionConfigOutput) String() string

String returns the string representation

type GetServiceGraphInput

type GetServiceGraphInput struct {

    // The end of the time frame for which to generate a graph.
    //
    // EndTime is a required field
    EndTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`

    // Pagination token. Not used.
    NextToken *string `type:"string"`

    // The start of the time frame for which to generate a graph.
    //
    // StartTime is a required field
    StartTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
    // contains filtered or unexported fields
}

func (GetServiceGraphInput) GoString

func (s GetServiceGraphInput) GoString() string

GoString returns the string representation

func (*GetServiceGraphInput) SetEndTime

func (s *GetServiceGraphInput) SetEndTime(v time.Time) *GetServiceGraphInput

SetEndTime sets the EndTime field's value.

func (*GetServiceGraphInput) SetNextToken

func (s *GetServiceGraphInput) SetNextToken(v string) *GetServiceGraphInput

SetNextToken sets the NextToken field's value.

func (*GetServiceGraphInput) SetStartTime

func (s *GetServiceGraphInput) SetStartTime(v time.Time) *GetServiceGraphInput

SetStartTime sets the StartTime field's value.

func (GetServiceGraphInput) String

func (s GetServiceGraphInput) String() string

String returns the string representation

func (*GetServiceGraphInput) Validate

func (s *GetServiceGraphInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetServiceGraphOutput

type GetServiceGraphOutput struct {

    // The end of the time frame for which the graph was generated.
    EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

    // Pagination token. Not used.
    NextToken *string `type:"string"`

    // The services that have processed a traced request during the specified time
    // frame.
    Services []*Service `type:"list"`

    // The start of the time frame for which the graph was generated.
    StartTime *time.Time `type:"timestamp" timestampFormat:"unix"`
    // contains filtered or unexported fields
}

func (GetServiceGraphOutput) GoString

func (s GetServiceGraphOutput) GoString() string

GoString returns the string representation

func (*GetServiceGraphOutput) SetEndTime

func (s *GetServiceGraphOutput) SetEndTime(v time.Time) *GetServiceGraphOutput

SetEndTime sets the EndTime field's value.

func (*GetServiceGraphOutput) SetNextToken

func (s *GetServiceGraphOutput) SetNextToken(v string) *GetServiceGraphOutput

SetNextToken sets the NextToken field's value.

func (*GetServiceGraphOutput) SetServices

func (s *GetServiceGraphOutput) SetServices(v []*Service) *GetServiceGraphOutput

SetServices sets the Services field's value.

func (*GetServiceGraphOutput) SetStartTime

func (s *GetServiceGraphOutput) SetStartTime(v time.Time) *GetServiceGraphOutput

SetStartTime sets the StartTime field's value.

func (GetServiceGraphOutput) String

func (s GetServiceGraphOutput) String() string

String returns the string representation

type GetTraceGraphInput

type GetTraceGraphInput struct {

    // Pagination token. Not used.
    NextToken *string `type:"string"`

    // Trace IDs of requests for which to generate a service graph.
    //
    // TraceIds is a required field
    TraceIds []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (GetTraceGraphInput) GoString

func (s GetTraceGraphInput) GoString() string

GoString returns the string representation

func (*GetTraceGraphInput) SetNextToken

func (s *GetTraceGraphInput) SetNextToken(v string) *GetTraceGraphInput

SetNextToken sets the NextToken field's value.

func (*GetTraceGraphInput) SetTraceIds

func (s *GetTraceGraphInput) SetTraceIds(v []*string) *GetTraceGraphInput

SetTraceIds sets the TraceIds field's value.

func (GetTraceGraphInput) String

func (s GetTraceGraphInput) String() string

String returns the string representation

func (*GetTraceGraphInput) Validate

func (s *GetTraceGraphInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTraceGraphOutput

type GetTraceGraphOutput struct {

    // Pagination token. Not used.
    NextToken *string `type:"string"`

    // The services that have processed one of the specified requests.
    Services []*Service `type:"list"`
    // contains filtered or unexported fields
}

func (GetTraceGraphOutput) GoString

func (s GetTraceGraphOutput) GoString() string

GoString returns the string representation

func (*GetTraceGraphOutput) SetNextToken

func (s *GetTraceGraphOutput) SetNextToken(v string) *GetTraceGraphOutput

SetNextToken sets the NextToken field's value.

func (*GetTraceGraphOutput) SetServices

func (s *GetTraceGraphOutput) SetServices(v []*Service) *GetTraceGraphOutput

SetServices sets the Services field's value.

func (GetTraceGraphOutput) String

func (s GetTraceGraphOutput) String() string

String returns the string representation

type GetTraceSummariesInput

type GetTraceSummariesInput struct {

    // The end of the time frame for which to retrieve traces.
    //
    // EndTime is a required field
    EndTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`

    // Specify a filter expression to retrieve trace summaries for services or requests
    // that meet certain requirements.
    FilterExpression *string `min:"1" type:"string"`

    // Specify the pagination token returned by a previous request to retrieve the
    // next page of results.
    NextToken *string `type:"string"`

    // Set to true to get summaries for only a subset of available traces.
    Sampling *bool `type:"boolean"`

    // The start of the time frame for which to retrieve traces.
    //
    // StartTime is a required field
    StartTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
    // contains filtered or unexported fields
}

func (GetTraceSummariesInput) GoString

func (s GetTraceSummariesInput) GoString() string

GoString returns the string representation

func (*GetTraceSummariesInput) SetEndTime

func (s *GetTraceSummariesInput) SetEndTime(v time.Time) *GetTraceSummariesInput

SetEndTime sets the EndTime field's value.

func (*GetTraceSummariesInput) SetFilterExpression

func (s *GetTraceSummariesInput) SetFilterExpression(v string) *GetTraceSummariesInput

SetFilterExpression sets the FilterExpression field's value.

func (*GetTraceSummariesInput) SetNextToken

func (s *GetTraceSummariesInput) SetNextToken(v string) *GetTraceSummariesInput

SetNextToken sets the NextToken field's value.

func (*GetTraceSummariesInput) SetSampling

func (s *GetTraceSummariesInput) SetSampling(v bool) *GetTraceSummariesInput

SetSampling sets the Sampling field's value.

func (*GetTraceSummariesInput) SetStartTime

func (s *GetTraceSummariesInput) SetStartTime(v time.Time) *GetTraceSummariesInput

SetStartTime sets the StartTime field's value.

func (GetTraceSummariesInput) String

func (s GetTraceSummariesInput) String() string

String returns the string representation

func (*GetTraceSummariesInput) Validate

func (s *GetTraceSummariesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTraceSummariesOutput

type GetTraceSummariesOutput struct {

    // The start time of this page of results.
    ApproximateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

    // If the requested time frame contained more than one page of results, you
    // can use this token to retrieve the next page. The first page contains the
    // most most recent results, closest to the end of the time frame.
    NextToken *string `type:"string"`

    // Trace IDs and metadata for traces that were found in the specified time frame.
    TraceSummaries []*TraceSummary `type:"list"`

    // The total number of traces processed, including traces that did not match
    // the specified filter expression.
    TracesProcessedCount *int64 `type:"long"`
    // contains filtered or unexported fields
}

func (GetTraceSummariesOutput) GoString

func (s GetTraceSummariesOutput) GoString() string

GoString returns the string representation

func (*GetTraceSummariesOutput) SetApproximateTime

func (s *GetTraceSummariesOutput) SetApproximateTime(v time.Time) *GetTraceSummariesOutput

SetApproximateTime sets the ApproximateTime field's value.

func (*GetTraceSummariesOutput) SetNextToken

func (s *GetTraceSummariesOutput) SetNextToken(v string) *GetTraceSummariesOutput

SetNextToken sets the NextToken field's value.

func (*GetTraceSummariesOutput) SetTraceSummaries

func (s *GetTraceSummariesOutput) SetTraceSummaries(v []*TraceSummary) *GetTraceSummariesOutput

SetTraceSummaries sets the TraceSummaries field's value.

func (*GetTraceSummariesOutput) SetTracesProcessedCount

func (s *GetTraceSummariesOutput) SetTracesProcessedCount(v int64) *GetTraceSummariesOutput

SetTracesProcessedCount sets the TracesProcessedCount field's value.

func (GetTraceSummariesOutput) String

func (s GetTraceSummariesOutput) String() string

String returns the string representation

type HistogramEntry

type HistogramEntry struct {

    // The prevalence of the entry.
    Count *int64 `type:"integer"`

    // The value of the entry.
    Value *float64 `type:"double"`
    // contains filtered or unexported fields
}

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.

func (HistogramEntry) GoString

func (s HistogramEntry) GoString() string

GoString returns the string representation

func (*HistogramEntry) SetCount

func (s *HistogramEntry) SetCount(v int64) *HistogramEntry

SetCount sets the Count field's value.

func (*HistogramEntry) SetValue

func (s *HistogramEntry) SetValue(v float64) *HistogramEntry

SetValue sets the Value field's value.

func (HistogramEntry) String

func (s HistogramEntry) String() string

String returns the string representation

type Http

type Http struct {

    // The IP address of the requestor.
    ClientIp *string `type:"string"`

    // The request method.
    HttpMethod *string `type:"string"`

    // The response status.
    HttpStatus *int64 `type:"integer"`

    // The request URL.
    HttpURL *string `type:"string"`

    // The request's user agent string.
    UserAgent *string `type:"string"`
    // contains filtered or unexported fields
}

Information about an HTTP request.

func (Http) GoString

func (s Http) GoString() string

GoString returns the string representation

func (*Http) SetClientIp

func (s *Http) SetClientIp(v string) *Http

SetClientIp sets the ClientIp field's value.

func (*Http) SetHttpMethod

func (s *Http) SetHttpMethod(v string) *Http

SetHttpMethod sets the HttpMethod field's value.

func (*Http) SetHttpStatus

func (s *Http) SetHttpStatus(v int64) *Http

SetHttpStatus sets the HttpStatus field's value.

func (*Http) SetHttpURL

func (s *Http) SetHttpURL(v string) *Http

SetHttpURL sets the HttpURL field's value.

func (*Http) SetUserAgent

func (s *Http) SetUserAgent(v string) *Http

SetUserAgent sets the UserAgent field's value.

func (Http) String

func (s Http) String() string

String returns the string representation

type PutEncryptionConfigInput

type PutEncryptionConfigInput struct {

    // An AWS KMS customer master key (CMK) in one of the following formats:
    //
    //    * Alias - The name of the key. For example, alias/MyKey.
    //
    //    * Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.
    //
    //    * ARN - The full Amazon Resource Name of the key ID or alias. For example,
    //    arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.
    //    Use this format to specify a key in a different account.
    //
    // Omit this key if you set Type to NONE.
    KeyId *string `min:"1" type:"string"`

    // The type of encryption. Set to KMS to use your own key for encryption. Set
    // to NONE for default encryption.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"EncryptionType"`
    // contains filtered or unexported fields
}

func (PutEncryptionConfigInput) GoString

func (s PutEncryptionConfigInput) GoString() string

GoString returns the string representation

func (*PutEncryptionConfigInput) SetKeyId

func (s *PutEncryptionConfigInput) SetKeyId(v string) *PutEncryptionConfigInput

SetKeyId sets the KeyId field's value.

func (*PutEncryptionConfigInput) SetType

func (s *PutEncryptionConfigInput) SetType(v string) *PutEncryptionConfigInput

SetType sets the Type field's value.

func (PutEncryptionConfigInput) String

func (s PutEncryptionConfigInput) String() string

String returns the string representation

func (*PutEncryptionConfigInput) Validate

func (s *PutEncryptionConfigInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEncryptionConfigOutput

type PutEncryptionConfigOutput struct {

    // The new encryption configuration.
    EncryptionConfig *EncryptionConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (PutEncryptionConfigOutput) GoString

func (s PutEncryptionConfigOutput) GoString() string

GoString returns the string representation

func (*PutEncryptionConfigOutput) SetEncryptionConfig

func (s *PutEncryptionConfigOutput) SetEncryptionConfig(v *EncryptionConfig) *PutEncryptionConfigOutput

SetEncryptionConfig sets the EncryptionConfig field's value.

func (PutEncryptionConfigOutput) String

func (s PutEncryptionConfigOutput) String() string

String returns the string representation

type PutTelemetryRecordsInput

type PutTelemetryRecordsInput struct {
    EC2InstanceId *string `type:"string"`

    Hostname *string `type:"string"`

    ResourceARN *string `type:"string"`

    // TelemetryRecords is a required field
    TelemetryRecords []*TelemetryRecord `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (PutTelemetryRecordsInput) GoString

func (s PutTelemetryRecordsInput) GoString() string

GoString returns the string representation

func (*PutTelemetryRecordsInput) SetEC2InstanceId

func (s *PutTelemetryRecordsInput) SetEC2InstanceId(v string) *PutTelemetryRecordsInput

SetEC2InstanceId sets the EC2InstanceId field's value.

func (*PutTelemetryRecordsInput) SetHostname

func (s *PutTelemetryRecordsInput) SetHostname(v string) *PutTelemetryRecordsInput

SetHostname sets the Hostname field's value.

func (*PutTelemetryRecordsInput) SetResourceARN

func (s *PutTelemetryRecordsInput) SetResourceARN(v string) *PutTelemetryRecordsInput

SetResourceARN sets the ResourceARN field's value.

func (*PutTelemetryRecordsInput) SetTelemetryRecords

func (s *PutTelemetryRecordsInput) SetTelemetryRecords(v []*TelemetryRecord) *PutTelemetryRecordsInput

SetTelemetryRecords sets the TelemetryRecords field's value.

func (PutTelemetryRecordsInput) String

func (s PutTelemetryRecordsInput) String() string

String returns the string representation

func (*PutTelemetryRecordsInput) Validate

func (s *PutTelemetryRecordsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutTelemetryRecordsOutput

type PutTelemetryRecordsOutput struct {
    // contains filtered or unexported fields
}

func (PutTelemetryRecordsOutput) GoString

func (s PutTelemetryRecordsOutput) GoString() string

GoString returns the string representation

func (PutTelemetryRecordsOutput) String

func (s PutTelemetryRecordsOutput) String() string

String returns the string representation

type PutTraceSegmentsInput

type PutTraceSegmentsInput struct {

    // A string containing a JSON document defining one or more segments or subsegments.
    //
    // TraceSegmentDocuments is a required field
    TraceSegmentDocuments []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (PutTraceSegmentsInput) GoString

func (s PutTraceSegmentsInput) GoString() string

GoString returns the string representation

func (*PutTraceSegmentsInput) SetTraceSegmentDocuments

func (s *PutTraceSegmentsInput) SetTraceSegmentDocuments(v []*string) *PutTraceSegmentsInput

SetTraceSegmentDocuments sets the TraceSegmentDocuments field's value.

func (PutTraceSegmentsInput) String

func (s PutTraceSegmentsInput) String() string

String returns the string representation

func (*PutTraceSegmentsInput) Validate

func (s *PutTraceSegmentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutTraceSegmentsOutput

type PutTraceSegmentsOutput struct {

    // Segments that failed processing.
    UnprocessedTraceSegments []*UnprocessedTraceSegment `type:"list"`
    // contains filtered or unexported fields
}

func (PutTraceSegmentsOutput) GoString

func (s PutTraceSegmentsOutput) GoString() string

GoString returns the string representation

func (*PutTraceSegmentsOutput) SetUnprocessedTraceSegments

func (s *PutTraceSegmentsOutput) SetUnprocessedTraceSegments(v []*UnprocessedTraceSegment) *PutTraceSegmentsOutput

SetUnprocessedTraceSegments sets the UnprocessedTraceSegments field's value.

func (PutTraceSegmentsOutput) String

func (s PutTraceSegmentsOutput) String() string

String returns the string representation

type Segment

type Segment struct {

    // The segment document.
    Document *string `min:"1" type:"string"`

    // The segment's ID.
    Id *string `type:"string"`
    // contains filtered or unexported fields
}

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 AWS X-Ray Segment Documents (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) in the AWS X-Ray Developer Guide.

func (Segment) GoString

func (s Segment) GoString() string

GoString returns the string representation

func (*Segment) SetDocument

func (s *Segment) SetDocument(v string) *Segment

SetDocument sets the Document field's value.

func (*Segment) SetId

func (s *Segment) SetId(v string) *Segment

SetId sets the Id field's value.

func (Segment) String

func (s Segment) String() string

String returns the string representation

type Service

type Service struct {

    // Identifier of the AWS account in which the service runs.
    AccountId *string `type:"string"`

    // A histogram that maps the spread of service durations.
    DurationHistogram []*HistogramEntry `type:"list"`

    // Connections to downstream services.
    Edges []*Edge `type:"list"`

    // The end time of the last segment that the service generated.
    EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

    // The canonical name of the service.
    Name *string `type:"string"`

    // A list of names for the service, including the canonical name.
    Names []*string `type:"list"`

    // Identifier for the service. Unique within the service map.
    ReferenceId *int64 `type:"integer"`

    // A histogram that maps the spread of service response times.
    ResponseTimeHistogram []*HistogramEntry `type:"list"`

    // Indicates that the service was the first service to process a request.
    Root *bool `type:"boolean"`

    // The start time of the first segment that the service generated.
    StartTime *time.Time `type:"timestamp" timestampFormat:"unix"`

    // The service's state.
    State *string `type:"string"`

    // Aggregated statistics for the service.
    SummaryStatistics *ServiceStatistics `type:"structure"`

    // 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.
    Type *string `type:"string"`
    // contains filtered or unexported fields
}

Information about an application that processed requests, users that made requests, or downstream services, resources and applications that an application used.

func (Service) GoString

func (s Service) GoString() string

GoString returns the string representation

func (*Service) SetAccountId

func (s *Service) SetAccountId(v string) *Service

SetAccountId sets the AccountId field's value.

func (*Service) SetDurationHistogram

func (s *Service) SetDurationHistogram(v []*HistogramEntry) *Service

SetDurationHistogram sets the DurationHistogram field's value.

func (*Service) SetEdges

func (s *Service) SetEdges(v []*Edge) *Service

SetEdges sets the Edges field's value.

func (*Service) SetEndTime

func (s *Service) SetEndTime(v time.Time) *Service

SetEndTime sets the EndTime field's value.

func (*Service) SetName

func (s *Service) SetName(v string) *Service

SetName sets the Name field's value.

func (*Service) SetNames

func (s *Service) SetNames(v []*string) *Service

SetNames sets the Names field's value.

func (*Service) SetReferenceId

func (s *Service) SetReferenceId(v int64) *Service

SetReferenceId sets the ReferenceId field's value.

func (*Service) SetResponseTimeHistogram

func (s *Service) SetResponseTimeHistogram(v []*HistogramEntry) *Service

SetResponseTimeHistogram sets the ResponseTimeHistogram field's value.

func (*Service) SetRoot

func (s *Service) SetRoot(v bool) *Service

SetRoot sets the Root field's value.

func (*Service) SetStartTime

func (s *Service) SetStartTime(v time.Time) *Service

SetStartTime sets the StartTime field's value.

func (*Service) SetState

func (s *Service) SetState(v string) *Service

SetState sets the State field's value.

func (*Service) SetSummaryStatistics

func (s *Service) SetSummaryStatistics(v *ServiceStatistics) *Service

SetSummaryStatistics sets the SummaryStatistics field's value.

func (*Service) SetType

func (s *Service) SetType(v string) *Service

SetType sets the Type field's value.

func (Service) String

func (s Service) String() string

String returns the string representation

type ServiceId

type ServiceId struct {
    AccountId *string `type:"string"`

    Name *string `type:"string"`

    Names []*string `type:"list"`

    Type *string `type:"string"`
    // contains filtered or unexported fields
}

func (ServiceId) GoString

func (s ServiceId) GoString() string

GoString returns the string representation

func (*ServiceId) SetAccountId

func (s *ServiceId) SetAccountId(v string) *ServiceId

SetAccountId sets the AccountId field's value.

func (*ServiceId) SetName

func (s *ServiceId) SetName(v string) *ServiceId

SetName sets the Name field's value.

func (*ServiceId) SetNames

func (s *ServiceId) SetNames(v []*string) *ServiceId

SetNames sets the Names field's value.

func (*ServiceId) SetType

func (s *ServiceId) SetType(v string) *ServiceId

SetType sets the Type field's value.

func (ServiceId) String

func (s ServiceId) String() string

String returns the string representation

type ServiceStatistics

type ServiceStatistics struct {

    // Information about requests that failed with a 4xx Client Error status code.
    ErrorStatistics *ErrorStatistics `type:"structure"`

    // Information about requests that failed with a 5xx Server Error status code.
    FaultStatistics *FaultStatistics `type:"structure"`

    // The number of requests that completed with a 2xx Success status code.
    OkCount *int64 `type:"long"`

    // The total number of completed requests.
    TotalCount *int64 `type:"long"`

    // The aggregate response time of completed requests.
    TotalResponseTime *float64 `type:"double"`
    // contains filtered or unexported fields
}

Response statistics for a service.

func (ServiceStatistics) GoString

func (s ServiceStatistics) GoString() string

GoString returns the string representation

func (*ServiceStatistics) SetErrorStatistics

func (s *ServiceStatistics) SetErrorStatistics(v *ErrorStatistics) *ServiceStatistics

SetErrorStatistics sets the ErrorStatistics field's value.

func (*ServiceStatistics) SetFaultStatistics

func (s *ServiceStatistics) SetFaultStatistics(v *FaultStatistics) *ServiceStatistics

SetFaultStatistics sets the FaultStatistics field's value.

func (*ServiceStatistics) SetOkCount

func (s *ServiceStatistics) SetOkCount(v int64) *ServiceStatistics

SetOkCount sets the OkCount field's value.

func (*ServiceStatistics) SetTotalCount

func (s *ServiceStatistics) SetTotalCount(v int64) *ServiceStatistics

SetTotalCount sets the TotalCount field's value.

func (*ServiceStatistics) SetTotalResponseTime

func (s *ServiceStatistics) SetTotalResponseTime(v float64) *ServiceStatistics

SetTotalResponseTime sets the TotalResponseTime field's value.

func (ServiceStatistics) String

func (s ServiceStatistics) String() string

String returns the string representation

type TelemetryRecord

type TelemetryRecord struct {
    BackendConnectionErrors *BackendConnectionErrors `type:"structure"`

    SegmentsReceivedCount *int64 `type:"integer"`

    SegmentsRejectedCount *int64 `type:"integer"`

    SegmentsSentCount *int64 `type:"integer"`

    SegmentsSpilloverCount *int64 `type:"integer"`

    // Timestamp is a required field
    Timestamp *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
    // contains filtered or unexported fields
}

func (TelemetryRecord) GoString

func (s TelemetryRecord) GoString() string

GoString returns the string representation

func (*TelemetryRecord) SetBackendConnectionErrors

func (s *TelemetryRecord) SetBackendConnectionErrors(v *BackendConnectionErrors) *TelemetryRecord

SetBackendConnectionErrors sets the BackendConnectionErrors field's value.

func (*TelemetryRecord) SetSegmentsReceivedCount

func (s *TelemetryRecord) SetSegmentsReceivedCount(v int64) *TelemetryRecord

SetSegmentsReceivedCount sets the SegmentsReceivedCount field's value.

func (*TelemetryRecord) SetSegmentsRejectedCount

func (s *TelemetryRecord) SetSegmentsRejectedCount(v int64) *TelemetryRecord

SetSegmentsRejectedCount sets the SegmentsRejectedCount field's value.

func (*TelemetryRecord) SetSegmentsSentCount

func (s *TelemetryRecord) SetSegmentsSentCount(v int64) *TelemetryRecord

SetSegmentsSentCount sets the SegmentsSentCount field's value.

func (*TelemetryRecord) SetSegmentsSpilloverCount

func (s *TelemetryRecord) SetSegmentsSpilloverCount(v int64) *TelemetryRecord

SetSegmentsSpilloverCount sets the SegmentsSpilloverCount field's value.

func (*TelemetryRecord) SetTimestamp

func (s *TelemetryRecord) SetTimestamp(v time.Time) *TelemetryRecord

SetTimestamp sets the Timestamp field's value.

func (TelemetryRecord) String

func (s TelemetryRecord) String() string

String returns the string representation

func (*TelemetryRecord) Validate

func (s *TelemetryRecord) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Trace

type Trace struct {

    // The length of time in seconds between the start time of the root segment
    // and the end time of the last segment that completed.
    Duration *float64 `type:"double"`

    // The unique identifier for the request that generated the trace's segments
    // and subsegments.
    Id *string `min:"1" type:"string"`

    // Segment documents for the segments and subsegments that comprise the trace.
    Segments []*Segment `type:"list"`
    // contains filtered or unexported fields
}

A collection of segment documents with matching trace IDs.

func (Trace) GoString

func (s Trace) GoString() string

GoString returns the string representation

func (*Trace) SetDuration

func (s *Trace) SetDuration(v float64) *Trace

SetDuration sets the Duration field's value.

func (*Trace) SetId

func (s *Trace) SetId(v string) *Trace

SetId sets the Id field's value.

func (*Trace) SetSegments

func (s *Trace) SetSegments(v []*Segment) *Trace

SetSegments sets the Segments field's value.

func (Trace) String

func (s Trace) String() string

String returns the string representation

type TraceSummary

type TraceSummary struct {

    // Annotations from the trace's segment documents.
    Annotations map[string][]*ValueWithServiceIds `type:"map"`

    // The length of time in seconds between the start time of the root segment
    // and the end time of the last segment that completed.
    Duration *float64 `type:"double"`

    // One or more of the segment documents has a 400 series error.
    HasError *bool `type:"boolean"`

    // One or more of the segment documents has a 500 series error.
    HasFault *bool `type:"boolean"`

    // One or more of the segment documents has a 429 throttling error.
    HasThrottle *bool `type:"boolean"`

    // Information about the HTTP request served by the trace.
    Http *Http `type:"structure"`

    // The unique identifier for the request that generated the trace's segments
    // and subsegments.
    Id *string `min:"1" type:"string"`

    // One or more of the segment documents is in progress.
    IsPartial *bool `type:"boolean"`

    // 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.
    ResponseTime *float64 `type:"double"`

    // Service IDs from the trace's segment documents.
    ServiceIds []*ServiceId `type:"list"`

    // Users from the trace's segment documents.
    Users []*TraceUser `type:"list"`
    // contains filtered or unexported fields
}

Metadata generated from the segment documents in a trace.

func (TraceSummary) GoString

func (s TraceSummary) GoString() string

GoString returns the string representation

func (*TraceSummary) SetAnnotations

func (s *TraceSummary) SetAnnotations(v map[string][]*ValueWithServiceIds) *TraceSummary

SetAnnotations sets the Annotations field's value.

func (*TraceSummary) SetDuration

func (s *TraceSummary) SetDuration(v float64) *TraceSummary

SetDuration sets the Duration field's value.

func (*TraceSummary) SetHasError

func (s *TraceSummary) SetHasError(v bool) *TraceSummary

SetHasError sets the HasError field's value.

func (*TraceSummary) SetHasFault

func (s *TraceSummary) SetHasFault(v bool) *TraceSummary

SetHasFault sets the HasFault field's value.

func (*TraceSummary) SetHasThrottle

func (s *TraceSummary) SetHasThrottle(v bool) *TraceSummary

SetHasThrottle sets the HasThrottle field's value.

func (*TraceSummary) SetHttp

func (s *TraceSummary) SetHttp(v *Http) *TraceSummary

SetHttp sets the Http field's value.

func (*TraceSummary) SetId

func (s *TraceSummary) SetId(v string) *TraceSummary

SetId sets the Id field's value.

func (*TraceSummary) SetIsPartial

func (s *TraceSummary) SetIsPartial(v bool) *TraceSummary

SetIsPartial sets the IsPartial field's value.

func (*TraceSummary) SetResponseTime

func (s *TraceSummary) SetResponseTime(v float64) *TraceSummary

SetResponseTime sets the ResponseTime field's value.

func (*TraceSummary) SetServiceIds

func (s *TraceSummary) SetServiceIds(v []*ServiceId) *TraceSummary

SetServiceIds sets the ServiceIds field's value.

func (*TraceSummary) SetUsers

func (s *TraceSummary) SetUsers(v []*TraceUser) *TraceSummary

SetUsers sets the Users field's value.

func (TraceSummary) String

func (s TraceSummary) String() string

String returns the string representation

type TraceUser

type TraceUser struct {

    // Services that the user's request hit.
    ServiceIds []*ServiceId `type:"list"`

    // The user's name.
    UserName *string `type:"string"`
    // contains filtered or unexported fields
}

Information about a user recorded in segment documents.

func (TraceUser) GoString

func (s TraceUser) GoString() string

GoString returns the string representation

func (*TraceUser) SetServiceIds

func (s *TraceUser) SetServiceIds(v []*ServiceId) *TraceUser

SetServiceIds sets the ServiceIds field's value.

func (*TraceUser) SetUserName

func (s *TraceUser) SetUserName(v string) *TraceUser

SetUserName sets the UserName field's value.

func (TraceUser) String

func (s TraceUser) String() string

String returns the string representation

type UnprocessedTraceSegment

type UnprocessedTraceSegment struct {

    // The error that caused processing to fail.
    ErrorCode *string `type:"string"`

    // The segment's ID.
    Id *string `type:"string"`

    // The error message.
    Message *string `type:"string"`
    // contains filtered or unexported fields
}

Information about a segment that failed processing.

func (UnprocessedTraceSegment) GoString

func (s UnprocessedTraceSegment) GoString() string

GoString returns the string representation

func (*UnprocessedTraceSegment) SetErrorCode

func (s *UnprocessedTraceSegment) SetErrorCode(v string) *UnprocessedTraceSegment

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedTraceSegment) SetId

func (s *UnprocessedTraceSegment) SetId(v string) *UnprocessedTraceSegment

SetId sets the Id field's value.

func (*UnprocessedTraceSegment) SetMessage

func (s *UnprocessedTraceSegment) SetMessage(v string) *UnprocessedTraceSegment

SetMessage sets the Message field's value.

func (UnprocessedTraceSegment) String

func (s UnprocessedTraceSegment) String() string

String returns the string representation

type ValueWithServiceIds

type ValueWithServiceIds struct {

    // Values of the annotation.
    AnnotationValue *AnnotationValue `type:"structure"`

    // Services to which the annotation applies.
    ServiceIds []*ServiceId `type:"list"`
    // contains filtered or unexported fields
}

Information about a segment annotation.

func (ValueWithServiceIds) GoString

func (s ValueWithServiceIds) GoString() string

GoString returns the string representation

func (*ValueWithServiceIds) SetAnnotationValue

func (s *ValueWithServiceIds) SetAnnotationValue(v *AnnotationValue) *ValueWithServiceIds

SetAnnotationValue sets the AnnotationValue field's value.

func (*ValueWithServiceIds) SetServiceIds

func (s *ValueWithServiceIds) SetServiceIds(v []*ServiceId) *ValueWithServiceIds

SetServiceIds sets the ServiceIds field's value.

func (ValueWithServiceIds) String

func (s ValueWithServiceIds) String() string

String returns the string representation

type XRay

type XRay struct {
    *client.Client
}

XRay provides the API operation methods for making requests to AWS X-Ray. See this package's package overview docs for details on the service.

XRay methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *XRay

New creates a new instance of the XRay client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a XRay client from just a session.
svc := xray.New(mySession)

// Create a XRay client with additional configuration
svc := xray.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*XRay) BatchGetTraces

func (c *XRay) BatchGetTraces(input *BatchGetTracesInput) (*BatchGetTracesOutput, error)

BatchGetTraces API operation for AWS X-Ray.

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS X-Ray's API operation BatchGetTraces for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is missing required parameters or has invalid parameters.

* ErrCodeThrottledException "ThrottledException"
The request exceeds the maximum number of requests per second.

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTraces

func (*XRay) BatchGetTracesPages

func (c *XRay) BatchGetTracesPages(input *BatchGetTracesInput, fn func(*BatchGetTracesOutput, bool) bool) error

BatchGetTracesPages iterates over the pages of a BatchGetTraces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See BatchGetTraces method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a BatchGetTraces operation.
pageNum := 0
err := client.BatchGetTracesPages(params,
    func(page *BatchGetTracesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*XRay) BatchGetTracesPagesWithContext

func (c *XRay) BatchGetTracesPagesWithContext(ctx aws.Context, input *BatchGetTracesInput, fn func(*BatchGetTracesOutput, bool) bool, opts ...request.Option) error

BatchGetTracesPagesWithContext same as BatchGetTracesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) BatchGetTracesRequest

func (c *XRay) BatchGetTracesRequest(input *BatchGetTracesInput) (req *request.Request, output *BatchGetTracesOutput)

BatchGetTracesRequest generates a "aws/request.Request" representing the client's request for the BatchGetTraces operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetTraces for more information on using the BatchGetTraces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGetTracesRequest method.
req, resp := client.BatchGetTracesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/BatchGetTraces

func (*XRay) BatchGetTracesWithContext

func (c *XRay) BatchGetTracesWithContext(ctx aws.Context, input *BatchGetTracesInput, opts ...request.Option) (*BatchGetTracesOutput, error)

BatchGetTracesWithContext is the same as BatchGetTraces with the addition of the ability to pass a context and additional request options.

See BatchGetTraces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) GetEncryptionConfig

func (c *XRay) GetEncryptionConfig(input *GetEncryptionConfigInput) (*GetEncryptionConfigOutput, error)

GetEncryptionConfig API operation for AWS X-Ray.

Retrieves the current encryption configuration for X-Ray data.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS X-Ray's API operation GetEncryptionConfig for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is missing required parameters or has invalid parameters.

* ErrCodeThrottledException "ThrottledException"
The request exceeds the maximum number of requests per second.

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetEncryptionConfig

func (*XRay) GetEncryptionConfigRequest

func (c *XRay) GetEncryptionConfigRequest(input *GetEncryptionConfigInput) (req *request.Request, output *GetEncryptionConfigOutput)

GetEncryptionConfigRequest generates a "aws/request.Request" representing the client's request for the GetEncryptionConfig operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEncryptionConfig for more information on using the GetEncryptionConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetEncryptionConfigRequest method.
req, resp := client.GetEncryptionConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetEncryptionConfig

func (*XRay) GetEncryptionConfigWithContext

func (c *XRay) GetEncryptionConfigWithContext(ctx aws.Context, input *GetEncryptionConfigInput, opts ...request.Option) (*GetEncryptionConfigOutput, error)

GetEncryptionConfigWithContext is the same as GetEncryptionConfig with the addition of the ability to pass a context and additional request options.

See GetEncryptionConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) GetServiceGraph

func (c *XRay) GetServiceGraph(input *GetServiceGraphInput) (*GetServiceGraphOutput, error)

GetServiceGraph API operation for AWS X-Ray.

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS X-Ray's API operation GetServiceGraph for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is missing required parameters or has invalid parameters.

* ErrCodeThrottledException "ThrottledException"
The request exceeds the maximum number of requests per second.

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraph

func (*XRay) GetServiceGraphPages

func (c *XRay) GetServiceGraphPages(input *GetServiceGraphInput, fn func(*GetServiceGraphOutput, bool) bool) error

GetServiceGraphPages iterates over the pages of a GetServiceGraph operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetServiceGraph method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetServiceGraph operation.
pageNum := 0
err := client.GetServiceGraphPages(params,
    func(page *GetServiceGraphOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*XRay) GetServiceGraphPagesWithContext

func (c *XRay) GetServiceGraphPagesWithContext(ctx aws.Context, input *GetServiceGraphInput, fn func(*GetServiceGraphOutput, bool) bool, opts ...request.Option) error

GetServiceGraphPagesWithContext same as GetServiceGraphPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) GetServiceGraphRequest

func (c *XRay) GetServiceGraphRequest(input *GetServiceGraphInput) (req *request.Request, output *GetServiceGraphOutput)

GetServiceGraphRequest generates a "aws/request.Request" representing the client's request for the GetServiceGraph operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetServiceGraph for more information on using the GetServiceGraph API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetServiceGraphRequest method.
req, resp := client.GetServiceGraphRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetServiceGraph

func (*XRay) GetServiceGraphWithContext

func (c *XRay) GetServiceGraphWithContext(ctx aws.Context, input *GetServiceGraphInput, opts ...request.Option) (*GetServiceGraphOutput, error)

GetServiceGraphWithContext is the same as GetServiceGraph with the addition of the ability to pass a context and additional request options.

See GetServiceGraph for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) GetTraceGraph

func (c *XRay) GetTraceGraph(input *GetTraceGraphInput) (*GetTraceGraphOutput, error)

GetTraceGraph API operation for AWS X-Ray.

Retrieves a service graph for one or more specific trace IDs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS X-Ray's API operation GetTraceGraph for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is missing required parameters or has invalid parameters.

* ErrCodeThrottledException "ThrottledException"
The request exceeds the maximum number of requests per second.

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraph

func (*XRay) GetTraceGraphPages

func (c *XRay) GetTraceGraphPages(input *GetTraceGraphInput, fn func(*GetTraceGraphOutput, bool) bool) error

GetTraceGraphPages iterates over the pages of a GetTraceGraph operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetTraceGraph method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetTraceGraph operation.
pageNum := 0
err := client.GetTraceGraphPages(params,
    func(page *GetTraceGraphOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*XRay) GetTraceGraphPagesWithContext

func (c *XRay) GetTraceGraphPagesWithContext(ctx aws.Context, input *GetTraceGraphInput, fn func(*GetTraceGraphOutput, bool) bool, opts ...request.Option) error

GetTraceGraphPagesWithContext same as GetTraceGraphPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) GetTraceGraphRequest

func (c *XRay) GetTraceGraphRequest(input *GetTraceGraphInput) (req *request.Request, output *GetTraceGraphOutput)

GetTraceGraphRequest generates a "aws/request.Request" representing the client's request for the GetTraceGraph operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTraceGraph for more information on using the GetTraceGraph API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetTraceGraphRequest method.
req, resp := client.GetTraceGraphRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceGraph

func (*XRay) GetTraceGraphWithContext

func (c *XRay) GetTraceGraphWithContext(ctx aws.Context, input *GetTraceGraphInput, opts ...request.Option) (*GetTraceGraphOutput, error)

GetTraceGraphWithContext is the same as GetTraceGraph with the addition of the ability to pass a context and additional request options.

See GetTraceGraph for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) GetTraceSummaries

func (c *XRay) GetTraceSummaries(input *GetTraceSummariesInput) (*GetTraceSummariesOutput, error)

GetTraceSummaries API operation for AWS X-Ray.

Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:

service("api.example.com")

This filter expression finds traces that have an annotation named account with the value 12345:

annotation.account = "12345"

For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions (http://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html) in the AWS X-Ray Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS X-Ray's API operation GetTraceSummaries for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is missing required parameters or has invalid parameters.

* ErrCodeThrottledException "ThrottledException"
The request exceeds the maximum number of requests per second.

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSummaries

func (*XRay) GetTraceSummariesPages

func (c *XRay) GetTraceSummariesPages(input *GetTraceSummariesInput, fn func(*GetTraceSummariesOutput, bool) bool) error

GetTraceSummariesPages iterates over the pages of a GetTraceSummaries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetTraceSummaries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetTraceSummaries operation.
pageNum := 0
err := client.GetTraceSummariesPages(params,
    func(page *GetTraceSummariesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*XRay) GetTraceSummariesPagesWithContext

func (c *XRay) GetTraceSummariesPagesWithContext(ctx aws.Context, input *GetTraceSummariesInput, fn func(*GetTraceSummariesOutput, bool) bool, opts ...request.Option) error

GetTraceSummariesPagesWithContext same as GetTraceSummariesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) GetTraceSummariesRequest

func (c *XRay) GetTraceSummariesRequest(input *GetTraceSummariesInput) (req *request.Request, output *GetTraceSummariesOutput)

GetTraceSummariesRequest generates a "aws/request.Request" representing the client's request for the GetTraceSummaries operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTraceSummaries for more information on using the GetTraceSummaries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetTraceSummariesRequest method.
req, resp := client.GetTraceSummariesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSummaries

func (*XRay) GetTraceSummariesWithContext

func (c *XRay) GetTraceSummariesWithContext(ctx aws.Context, input *GetTraceSummariesInput, opts ...request.Option) (*GetTraceSummariesOutput, error)

GetTraceSummariesWithContext is the same as GetTraceSummaries with the addition of the ability to pass a context and additional request options.

See GetTraceSummaries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) PutEncryptionConfig

func (c *XRay) PutEncryptionConfig(input *PutEncryptionConfigInput) (*PutEncryptionConfigOutput, error)

PutEncryptionConfig API operation for AWS X-Ray.

Updates the encryption configuration for X-Ray data.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS X-Ray's API operation PutEncryptionConfig for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is missing required parameters or has invalid parameters.

* ErrCodeThrottledException "ThrottledException"
The request exceeds the maximum number of requests per second.

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutEncryptionConfig

func (*XRay) PutEncryptionConfigRequest

func (c *XRay) PutEncryptionConfigRequest(input *PutEncryptionConfigInput) (req *request.Request, output *PutEncryptionConfigOutput)

PutEncryptionConfigRequest generates a "aws/request.Request" representing the client's request for the PutEncryptionConfig operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutEncryptionConfig for more information on using the PutEncryptionConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutEncryptionConfigRequest method.
req, resp := client.PutEncryptionConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutEncryptionConfig

func (*XRay) PutEncryptionConfigWithContext

func (c *XRay) PutEncryptionConfigWithContext(ctx aws.Context, input *PutEncryptionConfigInput, opts ...request.Option) (*PutEncryptionConfigOutput, error)

PutEncryptionConfigWithContext is the same as PutEncryptionConfig with the addition of the ability to pass a context and additional request options.

See PutEncryptionConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) PutTelemetryRecords

func (c *XRay) PutTelemetryRecords(input *PutTelemetryRecordsInput) (*PutTelemetryRecordsOutput, error)

PutTelemetryRecords API operation for AWS X-Ray.

Used by the AWS X-Ray daemon to upload telemetry.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS X-Ray's API operation PutTelemetryRecords for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is missing required parameters or has invalid parameters.

* ErrCodeThrottledException "ThrottledException"
The request exceeds the maximum number of requests per second.

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTelemetryRecords

func (*XRay) PutTelemetryRecordsRequest

func (c *XRay) PutTelemetryRecordsRequest(input *PutTelemetryRecordsInput) (req *request.Request, output *PutTelemetryRecordsOutput)

PutTelemetryRecordsRequest generates a "aws/request.Request" representing the client's request for the PutTelemetryRecords operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutTelemetryRecords for more information on using the PutTelemetryRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutTelemetryRecordsRequest method.
req, resp := client.PutTelemetryRecordsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTelemetryRecords

func (*XRay) PutTelemetryRecordsWithContext

func (c *XRay) PutTelemetryRecordsWithContext(ctx aws.Context, input *PutTelemetryRecordsInput, opts ...request.Option) (*PutTelemetryRecordsOutput, error)

PutTelemetryRecordsWithContext is the same as PutTelemetryRecords with the addition of the ability to pass a context and additional request options.

See PutTelemetryRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*XRay) PutTraceSegments

func (c *XRay) PutTraceSegments(input *PutTraceSegmentsInput) (*PutTraceSegmentsOutput, error)

PutTraceSegments API operation for AWS X-Ray.

Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) in the AWS X-Ray Developer Guide.

Required Segment Document Fields

* name - The name of the service that handled the request.

* id - A 64-bit identifier for the segment, unique among segments in the
same trace, in 16 hexadecimal digits.

* trace_id - A unique identifier that connects all segments and subsegments
originating from a single client request.

* start_time - Time the segment or subsegment was created, in floating
point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010
or 1.480615200010E9.

* end_time - Time the segment or subsegment was closed. For example, 1480615200.090
or 1.480615200090E9. Specify either an end_time or in_progress.

* in_progress - Set to true instead of specifying an end_time to record
that a segment has been started, but is not complete. Send an in progress
segment when your application receives a request that will take a long
time to serve, to trace the fact that the request was received. When the
response is sent, send the complete segment to overwrite the in-progress
segment.

A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:

Trace ID Format

* The version number, i.e. 1.

* The time of the original request, in Unix epoch time, in 8 hexadecimal
digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200
seconds, or 58406520 in hexadecimal.

* A 96-bit identifier for the trace, globally unique, in 24 hexadecimal
digits.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS X-Ray's API operation PutTraceSegments for usage and error information.

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is missing required parameters or has invalid parameters.

* ErrCodeThrottledException "ThrottledException"
The request exceeds the maximum number of requests per second.

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTraceSegments

func (*XRay) PutTraceSegmentsRequest

func (c *XRay) PutTraceSegmentsRequest(input *PutTraceSegmentsInput) (req *request.Request, output *PutTraceSegmentsOutput)

PutTraceSegmentsRequest generates a "aws/request.Request" representing the client's request for the PutTraceSegments operation. The "output" return value will be populated with the request's response once the request completes successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutTraceSegments for more information on using the PutTraceSegments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutTraceSegmentsRequest method.
req, resp := client.PutTraceSegmentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/PutTraceSegments

func (*XRay) PutTraceSegmentsWithContext

func (c *XRay) PutTraceSegmentsWithContext(ctx aws.Context, input *PutTraceSegmentsInput, opts ...request.Option) (*PutTraceSegmentsOutput, error)

PutTraceSegmentsWithContext is the same as PutTraceSegments with the addition of the ability to pass a context and additional request options.

See PutTraceSegments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.