xray

package
Version: v1.40.14 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 3, 2021 License: Apache-2.0 Imports: 10 Imported by: 82

Documentation

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

Index

Constants

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

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

	// EncryptionTypeKms is a EncryptionType enum value
	EncryptionTypeKms = "KMS"
)
View Source
const (
	// InsightStateActive is a InsightState enum value
	InsightStateActive = "ACTIVE"

	// InsightStateClosed is a InsightState enum value
	InsightStateClosed = "CLOSED"
)
View Source
const (
	// SamplingStrategyNamePartialScan is a SamplingStrategyName enum value
	SamplingStrategyNamePartialScan = "PartialScan"

	// SamplingStrategyNameFixedRate is a SamplingStrategyName enum value
	SamplingStrategyNameFixedRate = "FixedRate"
)
View Source
const (
	// TimeRangeTypeTraceId is a TimeRangeType enum value
	TimeRangeTypeTraceId = "TraceId"

	// TimeRangeTypeEvent is a TimeRangeType enum value
	TimeRangeTypeEvent = "Event"
)
View Source
const (

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

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource was not found. Verify that the name or Amazon Resource Name
	// (ARN) of the resource is correct.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeRuleLimitExceededException for service response error code
	// "RuleLimitExceededException".
	//
	// You have reached the maximum number of sampling rules.
	ErrCodeRuleLimitExceededException = "RuleLimitExceededException"

	// ErrCodeThrottledException for service response error code
	// "ThrottledException".
	//
	// The request exceeds the maximum number of requests per second.
	ErrCodeThrottledException = "ThrottledException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// You have exceeded the maximum number of tags you can apply to this resource.
	ErrCodeTooManyTagsException = "TooManyTagsException"
)
View Source
const (
	ServiceName = "xray"      // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "XRay"      // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// InsightCategoryFault is a InsightCategory enum value
	InsightCategoryFault = "FAULT"
)

Variables

This section is empty.

Functions

func EncryptionStatus_Values added in v1.34.3

func EncryptionStatus_Values() []string

EncryptionStatus_Values returns all elements of the EncryptionStatus enum

func EncryptionType_Values added in v1.34.3

func EncryptionType_Values() []string

EncryptionType_Values returns all elements of the EncryptionType enum

func InsightCategory_Values added in v1.35.21

func InsightCategory_Values() []string

InsightCategory_Values returns all elements of the InsightCategory enum

func InsightState_Values added in v1.35.21

func InsightState_Values() []string

InsightState_Values returns all elements of the InsightState enum

func SamplingStrategyName_Values added in v1.34.3

func SamplingStrategyName_Values() []string

SamplingStrategyName_Values returns all elements of the SamplingStrategyName enum

func TimeRangeType_Values added in v1.34.3

func TimeRangeType_Values() []string

TimeRangeType_Values returns all elements of the TimeRangeType enum

Types

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 AnomalousService added in v1.35.21

type AnomalousService struct {
	ServiceId *ServiceId `type:"structure"`
	// contains filtered or unexported fields
}

The service within the service graph that has anomalously high fault rates.

func (AnomalousService) GoString added in v1.35.21

func (s AnomalousService) GoString() string

GoString returns the string representation

func (*AnomalousService) SetServiceId added in v1.35.21

func (s *AnomalousService) SetServiceId(v *ServiceId) *AnomalousService

SetServiceId sets the ServiceId field's value.

func (AnomalousService) String added in v1.35.21

func (s AnomalousService) String() string

String returns the string representation

type AvailabilityZoneDetail added in v1.15.87

type AvailabilityZoneDetail struct {

	// The name of a corresponding Availability Zone.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A list of Availability Zones corresponding to the segments in a trace.

func (AvailabilityZoneDetail) GoString added in v1.15.87

func (s AvailabilityZoneDetail) GoString() string

GoString returns the string representation

func (*AvailabilityZoneDetail) SetName added in v1.15.87

SetName sets the Name field's value.

func (AvailabilityZoneDetail) String added in v1.15.87

func (s AvailabilityZoneDetail) 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

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.
	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.
	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 CreateGroupInput added in v1.15.80

type CreateGroupInput struct {

	// The filter expression defining criteria by which to group traces.
	FilterExpression *string `type:"string"`

	// The case-sensitive name of the new group. Default is a reserved name and
	// names must be unique.
	//
	// GroupName is a required field
	GroupName *string `min:"1" type:"string" required:"true"`

	// The structure containing configurations related to insights.
	//
	//    * The InsightsEnabled boolean can be set to true to enable insights for
	//    the new group or false to disable insights for the new group.
	//
	//    * The NotifcationsEnabled boolean can be set to true to enable insights
	//    notifications for the new group. Notifications may only be enabled on
	//    a group with InsightsEnabled set to true.
	InsightsConfiguration *InsightsConfiguration `type:"structure"`

	// A map that contains one or more tag keys and tag values to attach to an X-Ray
	// group. For more information about ways to use tags, see Tagging AWS resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the AWS
	// General Reference.
	//
	// The following restrictions apply to tags:
	//
	//    * Maximum number of user-applied tags per resource: 50
	//
	//    * Maximum tag key length: 128 Unicode characters
	//
	//    * Maximum tag value length: 256 Unicode characters
	//
	//    * Valid values for key and value: a-z, A-Z, 0-9, space, and the following
	//    characters: _ . : / = + - and @
	//
	//    * Tag keys and values are case sensitive.
	//
	//    * Don't use aws: as a prefix for keys; it's reserved for AWS use.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateGroupInput) GoString added in v1.15.80

func (s CreateGroupInput) GoString() string

GoString returns the string representation

func (*CreateGroupInput) SetFilterExpression added in v1.15.80

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

SetFilterExpression sets the FilterExpression field's value.

func (*CreateGroupInput) SetGroupName added in v1.15.80

func (s *CreateGroupInput) SetGroupName(v string) *CreateGroupInput

SetGroupName sets the GroupName field's value.

func (*CreateGroupInput) SetInsightsConfiguration added in v1.34.18

func (s *CreateGroupInput) SetInsightsConfiguration(v *InsightsConfiguration) *CreateGroupInput

SetInsightsConfiguration sets the InsightsConfiguration field's value.

func (*CreateGroupInput) SetTags added in v1.34.10

func (s *CreateGroupInput) SetTags(v []*Tag) *CreateGroupInput

SetTags sets the Tags field's value.

func (CreateGroupInput) String added in v1.15.80

func (s CreateGroupInput) String() string

String returns the string representation

func (*CreateGroupInput) Validate added in v1.15.80

func (s *CreateGroupInput) Validate() error

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

type CreateGroupOutput added in v1.15.80

type CreateGroupOutput struct {

	// The group that was created. Contains the name of the group that was created,
	// the Amazon Resource Name (ARN) of the group that was generated based on the
	// group name, the filter expression, and the insight configuration that was
	// assigned to the group.
	Group *Group `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateGroupOutput) GoString added in v1.15.80

func (s CreateGroupOutput) GoString() string

GoString returns the string representation

func (*CreateGroupOutput) SetGroup added in v1.15.80

func (s *CreateGroupOutput) SetGroup(v *Group) *CreateGroupOutput

SetGroup sets the Group field's value.

func (CreateGroupOutput) String added in v1.15.80

func (s CreateGroupOutput) String() string

String returns the string representation

type CreateSamplingRuleInput added in v1.15.23

type CreateSamplingRuleInput struct {

	// The rule definition.
	//
	// SamplingRule is a required field
	SamplingRule *SamplingRule `type:"structure" required:"true"`

	// A map that contains one or more tag keys and tag values to attach to an X-Ray
	// sampling rule. For more information about ways to use tags, see Tagging AWS
	// resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the AWS General Reference.
	//
	// The following restrictions apply to tags:
	//
	//    * Maximum number of user-applied tags per resource: 50
	//
	//    * Maximum tag key length: 128 Unicode characters
	//
	//    * Maximum tag value length: 256 Unicode characters
	//
	//    * Valid values for key and value: a-z, A-Z, 0-9, space, and the following
	//    characters: _ . : / = + - and @
	//
	//    * Tag keys and values are case sensitive.
	//
	//    * Don't use aws: as a prefix for keys; it's reserved for AWS use.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateSamplingRuleInput) GoString added in v1.15.23

func (s CreateSamplingRuleInput) GoString() string

GoString returns the string representation

func (*CreateSamplingRuleInput) SetSamplingRule added in v1.15.23

SetSamplingRule sets the SamplingRule field's value.

func (*CreateSamplingRuleInput) SetTags added in v1.34.10

SetTags sets the Tags field's value.

func (CreateSamplingRuleInput) String added in v1.15.23

func (s CreateSamplingRuleInput) String() string

String returns the string representation

func (*CreateSamplingRuleInput) Validate added in v1.15.23

func (s *CreateSamplingRuleInput) Validate() error

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

type CreateSamplingRuleOutput added in v1.15.23

type CreateSamplingRuleOutput struct {

	// The saved rule definition and metadata.
	SamplingRuleRecord *SamplingRuleRecord `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSamplingRuleOutput) GoString added in v1.15.23

func (s CreateSamplingRuleOutput) GoString() string

GoString returns the string representation

func (*CreateSamplingRuleOutput) SetSamplingRuleRecord added in v1.15.23

SetSamplingRuleRecord sets the SamplingRuleRecord field's value.

func (CreateSamplingRuleOutput) String added in v1.15.23

func (s CreateSamplingRuleOutput) String() string

String returns the string representation

type DeleteGroupInput added in v1.15.80

type DeleteGroupInput struct {

	// The ARN of the group that was generated on creation.
	GroupARN *string `min:"1" type:"string"`

	// The case-sensitive name of the group.
	GroupName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteGroupInput) GoString added in v1.15.80

func (s DeleteGroupInput) GoString() string

GoString returns the string representation

func (*DeleteGroupInput) SetGroupARN added in v1.15.80

func (s *DeleteGroupInput) SetGroupARN(v string) *DeleteGroupInput

SetGroupARN sets the GroupARN field's value.

func (*DeleteGroupInput) SetGroupName added in v1.15.80

func (s *DeleteGroupInput) SetGroupName(v string) *DeleteGroupInput

SetGroupName sets the GroupName field's value.

func (DeleteGroupInput) String added in v1.15.80

func (s DeleteGroupInput) String() string

String returns the string representation

func (*DeleteGroupInput) Validate added in v1.15.80

func (s *DeleteGroupInput) Validate() error

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

type DeleteGroupOutput added in v1.15.80

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

func (DeleteGroupOutput) GoString added in v1.15.80

func (s DeleteGroupOutput) GoString() string

GoString returns the string representation

func (DeleteGroupOutput) String added in v1.15.80

func (s DeleteGroupOutput) String() string

String returns the string representation

type DeleteSamplingRuleInput added in v1.15.23

type DeleteSamplingRuleInput struct {

	// The ARN of the sampling rule. Specify a rule by either name or ARN, but not
	// both.
	RuleARN *string `type:"string"`

	// The name of the sampling rule. Specify a rule by either name or ARN, but
	// not both.
	RuleName *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSamplingRuleInput) GoString added in v1.15.23

func (s DeleteSamplingRuleInput) GoString() string

GoString returns the string representation

func (*DeleteSamplingRuleInput) SetRuleARN added in v1.15.23

SetRuleARN sets the RuleARN field's value.

func (*DeleteSamplingRuleInput) SetRuleName added in v1.15.23

SetRuleName sets the RuleName field's value.

func (DeleteSamplingRuleInput) String added in v1.15.23

func (s DeleteSamplingRuleInput) String() string

String returns the string representation

type DeleteSamplingRuleOutput added in v1.15.23

type DeleteSamplingRuleOutput struct {

	// The deleted rule definition and metadata.
	SamplingRuleRecord *SamplingRuleRecord `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteSamplingRuleOutput) GoString added in v1.15.23

func (s DeleteSamplingRuleOutput) GoString() string

GoString returns the string representation

func (*DeleteSamplingRuleOutput) SetSamplingRuleRecord added in v1.15.23

SetSamplingRuleRecord sets the SamplingRuleRecord field's value.

func (DeleteSamplingRuleOutput) String added in v1.15.23

func (s DeleteSamplingRuleOutput) 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"`

	// 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"`

	// 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 added in v1.13.37

type EncryptionConfig struct {

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

	// The encryption status. While the status is UPDATING, X-Ray may encrypt data
	// with a combination of the new and old settings.
	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 added in v1.13.37

func (s EncryptionConfig) GoString() string

GoString returns the string representation

func (*EncryptionConfig) SetKeyId added in v1.13.37

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

SetKeyId sets the KeyId field's value.

func (*EncryptionConfig) SetStatus added in v1.13.37

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

SetStatus sets the Status field's value.

func (*EncryptionConfig) SetType added in v1.13.37

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

SetType sets the Type field's value.

func (EncryptionConfig) String added in v1.13.37

func (s EncryptionConfig) String() string

String returns the string representation

type ErrorRootCause added in v1.15.87

type ErrorRootCause struct {

	// A flag that denotes that the root cause impacts the trace client.
	ClientImpacting *bool `type:"boolean"`

	// A list of services corresponding to an error. A service identifies a segment
	// and it contains a name, account ID, type, and inferred flag.
	Services []*ErrorRootCauseService `type:"list"`
	// contains filtered or unexported fields
}

The root cause of a trace summary error.

func (ErrorRootCause) GoString added in v1.15.87

func (s ErrorRootCause) GoString() string

GoString returns the string representation

func (*ErrorRootCause) SetClientImpacting added in v1.29.32

func (s *ErrorRootCause) SetClientImpacting(v bool) *ErrorRootCause

SetClientImpacting sets the ClientImpacting field's value.

func (*ErrorRootCause) SetServices added in v1.15.87

func (s *ErrorRootCause) SetServices(v []*ErrorRootCauseService) *ErrorRootCause

SetServices sets the Services field's value.

func (ErrorRootCause) String added in v1.15.87

func (s ErrorRootCause) String() string

String returns the string representation

type ErrorRootCauseEntity added in v1.15.87

type ErrorRootCauseEntity struct {

	// The types and messages of the exceptions.
	Exceptions []*RootCauseException `type:"list"`

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

	// A flag that denotes a remote subsegment.
	Remote *bool `type:"boolean"`
	// contains filtered or unexported fields
}

A collection of segments and corresponding subsegments associated to a trace summary error.

func (ErrorRootCauseEntity) GoString added in v1.15.87

func (s ErrorRootCauseEntity) GoString() string

GoString returns the string representation

func (*ErrorRootCauseEntity) SetExceptions added in v1.15.87

SetExceptions sets the Exceptions field's value.

func (*ErrorRootCauseEntity) SetName added in v1.15.87

SetName sets the Name field's value.

func (*ErrorRootCauseEntity) SetRemote added in v1.15.87

SetRemote sets the Remote field's value.

func (ErrorRootCauseEntity) String added in v1.15.87

func (s ErrorRootCauseEntity) String() string

String returns the string representation

type ErrorRootCauseService added in v1.15.87

type ErrorRootCauseService struct {

	// The account ID associated to the service.
	AccountId *string `type:"string"`

	// The path of root cause entities found on the service.
	EntityPath []*ErrorRootCauseEntity `type:"list"`

	// A Boolean value indicating if the service is inferred from the trace.
	Inferred *bool `type:"boolean"`

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

	// A collection of associated service names.
	Names []*string `type:"list"`

	// The type associated to the service.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A collection of fields identifying the services in a trace summary error.

func (ErrorRootCauseService) GoString added in v1.15.87

func (s ErrorRootCauseService) GoString() string

GoString returns the string representation

func (*ErrorRootCauseService) SetAccountId added in v1.15.87

SetAccountId sets the AccountId field's value.

func (*ErrorRootCauseService) SetEntityPath added in v1.15.87

SetEntityPath sets the EntityPath field's value.

func (*ErrorRootCauseService) SetInferred added in v1.15.87

SetInferred sets the Inferred field's value.

func (*ErrorRootCauseService) SetName added in v1.15.87

SetName sets the Name field's value.

func (*ErrorRootCauseService) SetNames added in v1.15.87

SetNames sets the Names field's value.

func (*ErrorRootCauseService) SetType added in v1.15.87

SetType sets the Type field's value.

func (ErrorRootCauseService) String added in v1.15.87

func (s ErrorRootCauseService) 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 FaultRootCause added in v1.15.87

type FaultRootCause struct {

	// A flag that denotes that the root cause impacts the trace client.
	ClientImpacting *bool `type:"boolean"`

	// A list of corresponding services. A service identifies a segment and it contains
	// a name, account ID, type, and inferred flag.
	Services []*FaultRootCauseService `type:"list"`
	// contains filtered or unexported fields
}

The root cause information for a trace summary fault.

func (FaultRootCause) GoString added in v1.15.87

func (s FaultRootCause) GoString() string

GoString returns the string representation

func (*FaultRootCause) SetClientImpacting added in v1.29.32

func (s *FaultRootCause) SetClientImpacting(v bool) *FaultRootCause

SetClientImpacting sets the ClientImpacting field's value.

func (*FaultRootCause) SetServices added in v1.15.87

func (s *FaultRootCause) SetServices(v []*FaultRootCauseService) *FaultRootCause

SetServices sets the Services field's value.

func (FaultRootCause) String added in v1.15.87

func (s FaultRootCause) String() string

String returns the string representation

type FaultRootCauseEntity added in v1.15.87

type FaultRootCauseEntity struct {

	// The types and messages of the exceptions.
	Exceptions []*RootCauseException `type:"list"`

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

	// A flag that denotes a remote subsegment.
	Remote *bool `type:"boolean"`
	// contains filtered or unexported fields
}

A collection of segments and corresponding subsegments associated to a trace summary fault error.

func (FaultRootCauseEntity) GoString added in v1.15.87

func (s FaultRootCauseEntity) GoString() string

GoString returns the string representation

func (*FaultRootCauseEntity) SetExceptions added in v1.15.87

SetExceptions sets the Exceptions field's value.

func (*FaultRootCauseEntity) SetName added in v1.15.87

SetName sets the Name field's value.

func (*FaultRootCauseEntity) SetRemote added in v1.15.87

SetRemote sets the Remote field's value.

func (FaultRootCauseEntity) String added in v1.15.87

func (s FaultRootCauseEntity) String() string

String returns the string representation

type FaultRootCauseService added in v1.15.87

type FaultRootCauseService struct {

	// The account ID associated to the service.
	AccountId *string `type:"string"`

	// The path of root cause entities found on the service.
	EntityPath []*FaultRootCauseEntity `type:"list"`

	// A Boolean value indicating if the service is inferred from the trace.
	Inferred *bool `type:"boolean"`

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

	// A collection of associated service names.
	Names []*string `type:"list"`

	// The type associated to the service.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A collection of fields identifying the services in a trace summary fault.

func (FaultRootCauseService) GoString added in v1.15.87

func (s FaultRootCauseService) GoString() string

GoString returns the string representation

func (*FaultRootCauseService) SetAccountId added in v1.15.87

SetAccountId sets the AccountId field's value.

func (*FaultRootCauseService) SetEntityPath added in v1.15.87

SetEntityPath sets the EntityPath field's value.

func (*FaultRootCauseService) SetInferred added in v1.15.87

SetInferred sets the Inferred field's value.

func (*FaultRootCauseService) SetName added in v1.15.87

SetName sets the Name field's value.

func (*FaultRootCauseService) SetNames added in v1.15.87

SetNames sets the Names field's value.

func (*FaultRootCauseService) SetType added in v1.15.87

SetType sets the Type field's value.

func (FaultRootCauseService) String added in v1.15.87

func (s FaultRootCauseService) 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 ForecastStatistics added in v1.35.21

type ForecastStatistics struct {

	// The upper limit of fault counts for a service.
	FaultCountHigh *int64 `type:"long"`

	// The lower limit of fault counts for a service.
	FaultCountLow *int64 `type:"long"`
	// contains filtered or unexported fields
}

The predicted high and low fault count. This is used to determine if a service has become anomalous and if an insight should be created.

func (ForecastStatistics) GoString added in v1.35.21

func (s ForecastStatistics) GoString() string

GoString returns the string representation

func (*ForecastStatistics) SetFaultCountHigh added in v1.35.21

func (s *ForecastStatistics) SetFaultCountHigh(v int64) *ForecastStatistics

SetFaultCountHigh sets the FaultCountHigh field's value.

func (*ForecastStatistics) SetFaultCountLow added in v1.35.21

func (s *ForecastStatistics) SetFaultCountLow(v int64) *ForecastStatistics

SetFaultCountLow sets the FaultCountLow field's value.

func (ForecastStatistics) String added in v1.35.21

func (s ForecastStatistics) String() string

String returns the string representation

type GetEncryptionConfigInput added in v1.13.37

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

func (GetEncryptionConfigInput) GoString added in v1.13.37

func (s GetEncryptionConfigInput) GoString() string

GoString returns the string representation

func (GetEncryptionConfigInput) String added in v1.13.37

func (s GetEncryptionConfigInput) String() string

String returns the string representation

type GetEncryptionConfigOutput added in v1.13.37

type GetEncryptionConfigOutput struct {

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

func (GetEncryptionConfigOutput) GoString added in v1.13.37

func (s GetEncryptionConfigOutput) GoString() string

GoString returns the string representation

func (*GetEncryptionConfigOutput) SetEncryptionConfig added in v1.13.37

SetEncryptionConfig sets the EncryptionConfig field's value.

func (GetEncryptionConfigOutput) String added in v1.13.37

func (s GetEncryptionConfigOutput) String() string

String returns the string representation

type GetGroupInput added in v1.15.80

type GetGroupInput struct {

	// The ARN of the group that was generated on creation.
	GroupARN *string `min:"1" type:"string"`

	// The case-sensitive name of the group.
	GroupName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetGroupInput) GoString added in v1.15.80

func (s GetGroupInput) GoString() string

GoString returns the string representation

func (*GetGroupInput) SetGroupARN added in v1.15.80

func (s *GetGroupInput) SetGroupARN(v string) *GetGroupInput

SetGroupARN sets the GroupARN field's value.

func (*GetGroupInput) SetGroupName added in v1.15.80

func (s *GetGroupInput) SetGroupName(v string) *GetGroupInput

SetGroupName sets the GroupName field's value.

func (GetGroupInput) String added in v1.15.80

func (s GetGroupInput) String() string

String returns the string representation

func (*GetGroupInput) Validate added in v1.15.80

func (s *GetGroupInput) Validate() error

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

type GetGroupOutput added in v1.15.80

type GetGroupOutput struct {

	// The group that was requested. Contains the name of the group, the ARN of
	// the group, the filter expression, and the insight configuration assigned
	// to the group.
	Group *Group `type:"structure"`
	// contains filtered or unexported fields
}

func (GetGroupOutput) GoString added in v1.15.80

func (s GetGroupOutput) GoString() string

GoString returns the string representation

func (*GetGroupOutput) SetGroup added in v1.15.80

func (s *GetGroupOutput) SetGroup(v *Group) *GetGroupOutput

SetGroup sets the Group field's value.

func (GetGroupOutput) String added in v1.15.80

func (s GetGroupOutput) String() string

String returns the string representation

type GetGroupsInput added in v1.15.80

type GetGroupsInput struct {

	// Pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetGroupsInput) GoString added in v1.15.80

func (s GetGroupsInput) GoString() string

GoString returns the string representation

func (*GetGroupsInput) SetNextToken added in v1.15.80

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

SetNextToken sets the NextToken field's value.

func (GetGroupsInput) String added in v1.15.80

func (s GetGroupsInput) String() string

String returns the string representation

func (*GetGroupsInput) Validate added in v1.15.80

func (s *GetGroupsInput) Validate() error

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

type GetGroupsOutput added in v1.15.80

type GetGroupsOutput struct {

	// The collection of all active groups.
	Groups []*GroupSummary `type:"list"`

	// Pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetGroupsOutput) GoString added in v1.15.80

func (s GetGroupsOutput) GoString() string

GoString returns the string representation

func (*GetGroupsOutput) SetGroups added in v1.15.80

func (s *GetGroupsOutput) SetGroups(v []*GroupSummary) *GetGroupsOutput

SetGroups sets the Groups field's value.

func (*GetGroupsOutput) SetNextToken added in v1.15.80

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

SetNextToken sets the NextToken field's value.

func (GetGroupsOutput) String added in v1.15.80

func (s GetGroupsOutput) String() string

String returns the string representation

type GetInsightEventsInput added in v1.35.21

type GetInsightEventsInput struct {

	// The insight's unique identifier. Use the GetInsightSummaries action to retrieve
	// an InsightId.
	//
	// InsightId is a required field
	InsightId *string `type:"string" required:"true"`

	// Used to retrieve at most the specified value of events.
	MaxResults *int64 `min:"1" type:"integer"`

	// Specify the pagination token returned by a previous request to retrieve the
	// next page of events.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetInsightEventsInput) GoString added in v1.35.21

func (s GetInsightEventsInput) GoString() string

GoString returns the string representation

func (*GetInsightEventsInput) SetInsightId added in v1.35.21

SetInsightId sets the InsightId field's value.

func (*GetInsightEventsInput) SetMaxResults added in v1.35.21

func (s *GetInsightEventsInput) SetMaxResults(v int64) *GetInsightEventsInput

SetMaxResults sets the MaxResults field's value.

func (*GetInsightEventsInput) SetNextToken added in v1.35.21

SetNextToken sets the NextToken field's value.

func (GetInsightEventsInput) String added in v1.35.21

func (s GetInsightEventsInput) String() string

String returns the string representation

func (*GetInsightEventsInput) Validate added in v1.35.21

func (s *GetInsightEventsInput) Validate() error

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

type GetInsightEventsOutput added in v1.35.21

type GetInsightEventsOutput struct {

	// A detailed description of the event. This includes the time of the event,
	// client and root cause impact statistics, and the top anomalous service at
	// the time of the event.
	InsightEvents []*InsightEvent `type:"list"`

	// Use this token to retrieve the next page of insight events.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetInsightEventsOutput) GoString added in v1.35.21

func (s GetInsightEventsOutput) GoString() string

GoString returns the string representation

func (*GetInsightEventsOutput) SetInsightEvents added in v1.35.21

func (s *GetInsightEventsOutput) SetInsightEvents(v []*InsightEvent) *GetInsightEventsOutput

SetInsightEvents sets the InsightEvents field's value.

func (*GetInsightEventsOutput) SetNextToken added in v1.35.21

SetNextToken sets the NextToken field's value.

func (GetInsightEventsOutput) String added in v1.35.21

func (s GetInsightEventsOutput) String() string

String returns the string representation

type GetInsightImpactGraphInput added in v1.35.21

type GetInsightImpactGraphInput struct {

	// The estimated end time of the insight, in Unix time seconds. The EndTime
	// is exclusive of the value provided. The time range between the start time
	// and end time can't be more than six hours.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// The insight's unique identifier. Use the GetInsightSummaries action to retrieve
	// an InsightId.
	//
	// InsightId is a required field
	InsightId *string `type:"string" required:"true"`

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

	// The estimated start time of the insight, in Unix time seconds. The StartTime
	// is inclusive of the value provided and can't be more than 30 days old.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (GetInsightImpactGraphInput) GoString added in v1.35.21

func (s GetInsightImpactGraphInput) GoString() string

GoString returns the string representation

func (*GetInsightImpactGraphInput) SetEndTime added in v1.35.21

SetEndTime sets the EndTime field's value.

func (*GetInsightImpactGraphInput) SetInsightId added in v1.35.21

SetInsightId sets the InsightId field's value.

func (*GetInsightImpactGraphInput) SetNextToken added in v1.35.21

SetNextToken sets the NextToken field's value.

func (*GetInsightImpactGraphInput) SetStartTime added in v1.35.21

SetStartTime sets the StartTime field's value.

func (GetInsightImpactGraphInput) String added in v1.35.21

String returns the string representation

func (*GetInsightImpactGraphInput) Validate added in v1.35.21

func (s *GetInsightImpactGraphInput) Validate() error

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

type GetInsightImpactGraphOutput added in v1.35.21

type GetInsightImpactGraphOutput struct {

	// The provided end time.
	EndTime *time.Time `type:"timestamp"`

	// The insight's unique identifier.
	InsightId *string `type:"string"`

	// Pagination token.
	NextToken *string `min:"1" type:"string"`

	// The time, in Unix seconds, at which the service graph ended.
	ServiceGraphEndTime *time.Time `type:"timestamp"`

	// The time, in Unix seconds, at which the service graph started.
	ServiceGraphStartTime *time.Time `type:"timestamp"`

	// The AWS instrumented services related to the insight.
	Services []*InsightImpactGraphService `type:"list"`

	// The provided start time.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetInsightImpactGraphOutput) GoString added in v1.35.21

func (s GetInsightImpactGraphOutput) GoString() string

GoString returns the string representation

func (*GetInsightImpactGraphOutput) SetEndTime added in v1.35.21

SetEndTime sets the EndTime field's value.

func (*GetInsightImpactGraphOutput) SetInsightId added in v1.35.21

SetInsightId sets the InsightId field's value.

func (*GetInsightImpactGraphOutput) SetNextToken added in v1.35.21

SetNextToken sets the NextToken field's value.

func (*GetInsightImpactGraphOutput) SetServiceGraphEndTime added in v1.35.21

func (s *GetInsightImpactGraphOutput) SetServiceGraphEndTime(v time.Time) *GetInsightImpactGraphOutput

SetServiceGraphEndTime sets the ServiceGraphEndTime field's value.

func (*GetInsightImpactGraphOutput) SetServiceGraphStartTime added in v1.35.21

func (s *GetInsightImpactGraphOutput) SetServiceGraphStartTime(v time.Time) *GetInsightImpactGraphOutput

SetServiceGraphStartTime sets the ServiceGraphStartTime field's value.

func (*GetInsightImpactGraphOutput) SetServices added in v1.35.21

SetServices sets the Services field's value.

func (*GetInsightImpactGraphOutput) SetStartTime added in v1.35.21

SetStartTime sets the StartTime field's value.

func (GetInsightImpactGraphOutput) String added in v1.35.21

String returns the string representation

type GetInsightInput added in v1.35.21

type GetInsightInput struct {

	// The insight's unique identifier. Use the GetInsightSummaries action to retrieve
	// an InsightId.
	//
	// InsightId is a required field
	InsightId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInsightInput) GoString added in v1.35.21

func (s GetInsightInput) GoString() string

GoString returns the string representation

func (*GetInsightInput) SetInsightId added in v1.35.21

func (s *GetInsightInput) SetInsightId(v string) *GetInsightInput

SetInsightId sets the InsightId field's value.

func (GetInsightInput) String added in v1.35.21

func (s GetInsightInput) String() string

String returns the string representation

func (*GetInsightInput) Validate added in v1.35.21

func (s *GetInsightInput) Validate() error

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

type GetInsightOutput added in v1.35.21

type GetInsightOutput struct {

	// The summary information of an insight.
	Insight *Insight `type:"structure"`
	// contains filtered or unexported fields
}

func (GetInsightOutput) GoString added in v1.35.21

func (s GetInsightOutput) GoString() string

GoString returns the string representation

func (*GetInsightOutput) SetInsight added in v1.35.21

func (s *GetInsightOutput) SetInsight(v *Insight) *GetInsightOutput

SetInsight sets the Insight field's value.

func (GetInsightOutput) String added in v1.35.21

func (s GetInsightOutput) String() string

String returns the string representation

type GetInsightSummariesInput added in v1.35.21

type GetInsightSummariesInput struct {

	// The end of the time frame in which the insights ended. The end time can't
	// be more than 30 days old.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't
	// provided.
	GroupARN *string `min:"1" type:"string"`

	// The name of the group. Required if the GroupARN isn't provided.
	GroupName *string `min:"1" type:"string"`

	// The maximum number of results to display.
	MaxResults *int64 `min:"1" type:"integer"`

	// Pagination token.
	NextToken *string `min:"1" type:"string"`

	// The beginning of the time frame in which the insights started. The start
	// time can't be more than 30 days old.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`

	// The list of insight states.
	States []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetInsightSummariesInput) GoString added in v1.35.21

func (s GetInsightSummariesInput) GoString() string

GoString returns the string representation

func (*GetInsightSummariesInput) SetEndTime added in v1.35.21

SetEndTime sets the EndTime field's value.

func (*GetInsightSummariesInput) SetGroupARN added in v1.35.21

SetGroupARN sets the GroupARN field's value.

func (*GetInsightSummariesInput) SetGroupName added in v1.35.21

SetGroupName sets the GroupName field's value.

func (*GetInsightSummariesInput) SetMaxResults added in v1.35.21

SetMaxResults sets the MaxResults field's value.

func (*GetInsightSummariesInput) SetNextToken added in v1.35.21

SetNextToken sets the NextToken field's value.

func (*GetInsightSummariesInput) SetStartTime added in v1.35.21

SetStartTime sets the StartTime field's value.

func (*GetInsightSummariesInput) SetStates added in v1.35.21

SetStates sets the States field's value.

func (GetInsightSummariesInput) String added in v1.35.21

func (s GetInsightSummariesInput) String() string

String returns the string representation

func (*GetInsightSummariesInput) Validate added in v1.35.21

func (s *GetInsightSummariesInput) Validate() error

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

type GetInsightSummariesOutput added in v1.35.21

type GetInsightSummariesOutput struct {

	// The summary of each insight within the group matching the provided filters.
	// The summary contains the InsightID, start and end time, the root cause service,
	// the root cause and client impact statistics, the top anomalous services,
	// and the status of the insight.
	InsightSummaries []*InsightSummary `type:"list"`

	// Pagination token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetInsightSummariesOutput) GoString added in v1.35.21

func (s GetInsightSummariesOutput) GoString() string

GoString returns the string representation

func (*GetInsightSummariesOutput) SetInsightSummaries added in v1.35.21

SetInsightSummaries sets the InsightSummaries field's value.

func (*GetInsightSummariesOutput) SetNextToken added in v1.35.21

SetNextToken sets the NextToken field's value.

func (GetInsightSummariesOutput) String added in v1.35.21

func (s GetInsightSummariesOutput) String() string

String returns the string representation

type GetSamplingRulesInput added in v1.15.23

type GetSamplingRulesInput struct {

	// Pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetSamplingRulesInput) GoString added in v1.15.23

func (s GetSamplingRulesInput) GoString() string

GoString returns the string representation

func (*GetSamplingRulesInput) SetNextToken added in v1.15.23

SetNextToken sets the NextToken field's value.

func (GetSamplingRulesInput) String added in v1.15.23

func (s GetSamplingRulesInput) String() string

String returns the string representation

type GetSamplingRulesOutput added in v1.15.23

type GetSamplingRulesOutput struct {

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

	// Rule definitions and metadata.
	SamplingRuleRecords []*SamplingRuleRecord `type:"list"`
	// contains filtered or unexported fields
}

func (GetSamplingRulesOutput) GoString added in v1.15.23

func (s GetSamplingRulesOutput) GoString() string

GoString returns the string representation

func (*GetSamplingRulesOutput) SetNextToken added in v1.15.23

SetNextToken sets the NextToken field's value.

func (*GetSamplingRulesOutput) SetSamplingRuleRecords added in v1.15.23

func (s *GetSamplingRulesOutput) SetSamplingRuleRecords(v []*SamplingRuleRecord) *GetSamplingRulesOutput

SetSamplingRuleRecords sets the SamplingRuleRecords field's value.

func (GetSamplingRulesOutput) String added in v1.15.23

func (s GetSamplingRulesOutput) String() string

String returns the string representation

type GetSamplingStatisticSummariesInput added in v1.15.23

type GetSamplingStatisticSummariesInput struct {

	// Pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetSamplingStatisticSummariesInput) GoString added in v1.15.23

GoString returns the string representation

func (*GetSamplingStatisticSummariesInput) SetNextToken added in v1.15.23

SetNextToken sets the NextToken field's value.

func (GetSamplingStatisticSummariesInput) String added in v1.15.23

String returns the string representation

type GetSamplingStatisticSummariesOutput added in v1.15.23

type GetSamplingStatisticSummariesOutput struct {

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

	// Information about the number of requests instrumented for each sampling rule.
	SamplingStatisticSummaries []*SamplingStatisticSummary `type:"list"`
	// contains filtered or unexported fields
}

func (GetSamplingStatisticSummariesOutput) GoString added in v1.15.23

GoString returns the string representation

func (*GetSamplingStatisticSummariesOutput) SetNextToken added in v1.15.23

SetNextToken sets the NextToken field's value.

func (*GetSamplingStatisticSummariesOutput) SetSamplingStatisticSummaries added in v1.15.23

SetSamplingStatisticSummaries sets the SamplingStatisticSummaries field's value.

func (GetSamplingStatisticSummariesOutput) String added in v1.15.23

String returns the string representation

type GetSamplingTargetsInput added in v1.15.23

type GetSamplingTargetsInput struct {

	// Information about rules that the service is using to sample requests.
	//
	// SamplingStatisticsDocuments is a required field
	SamplingStatisticsDocuments []*SamplingStatisticsDocument `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetSamplingTargetsInput) GoString added in v1.15.23

func (s GetSamplingTargetsInput) GoString() string

GoString returns the string representation

func (*GetSamplingTargetsInput) SetSamplingStatisticsDocuments added in v1.15.23

func (s *GetSamplingTargetsInput) SetSamplingStatisticsDocuments(v []*SamplingStatisticsDocument) *GetSamplingTargetsInput

SetSamplingStatisticsDocuments sets the SamplingStatisticsDocuments field's value.

func (GetSamplingTargetsInput) String added in v1.15.23

func (s GetSamplingTargetsInput) String() string

String returns the string representation

func (*GetSamplingTargetsInput) Validate added in v1.15.23

func (s *GetSamplingTargetsInput) Validate() error

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

type GetSamplingTargetsOutput added in v1.15.23

type GetSamplingTargetsOutput struct {

	// The last time a user changed the sampling rule configuration. If the sampling
	// rule configuration changed since the service last retrieved it, the service
	// should call GetSamplingRules to get the latest version.
	LastRuleModification *time.Time `type:"timestamp"`

	// Updated rules that the service should use to sample requests.
	SamplingTargetDocuments []*SamplingTargetDocument `type:"list"`

	// Information about SamplingStatisticsDocument that X-Ray could not process.
	UnprocessedStatistics []*UnprocessedStatistics `type:"list"`
	// contains filtered or unexported fields
}

func (GetSamplingTargetsOutput) GoString added in v1.15.23

func (s GetSamplingTargetsOutput) GoString() string

GoString returns the string representation

func (*GetSamplingTargetsOutput) SetLastRuleModification added in v1.15.23

func (s *GetSamplingTargetsOutput) SetLastRuleModification(v time.Time) *GetSamplingTargetsOutput

SetLastRuleModification sets the LastRuleModification field's value.

func (*GetSamplingTargetsOutput) SetSamplingTargetDocuments added in v1.15.23

func (s *GetSamplingTargetsOutput) SetSamplingTargetDocuments(v []*SamplingTargetDocument) *GetSamplingTargetsOutput

SetSamplingTargetDocuments sets the SamplingTargetDocuments field's value.

func (*GetSamplingTargetsOutput) SetUnprocessedStatistics added in v1.15.23

func (s *GetSamplingTargetsOutput) SetUnprocessedStatistics(v []*UnprocessedStatistics) *GetSamplingTargetsOutput

SetUnprocessedStatistics sets the UnprocessedStatistics field's value.

func (GetSamplingTargetsOutput) String added in v1.15.23

func (s GetSamplingTargetsOutput) String() string

String returns the string representation

type GetServiceGraphInput

type GetServiceGraphInput struct {

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

	// The Amazon Resource Name (ARN) of a group based on which you want to generate
	// a graph.
	GroupARN *string `min:"1" type:"string"`

	// The name of a group based on which you want to generate a graph.
	GroupName *string `min:"1" type:"string"`

	// Pagination token.
	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" required:"true"`
	// contains filtered or unexported fields
}

func (GetServiceGraphInput) GoString

func (s GetServiceGraphInput) GoString() string

GoString returns the string representation

func (*GetServiceGraphInput) SetEndTime

SetEndTime sets the EndTime field's value.

func (*GetServiceGraphInput) SetGroupARN added in v1.15.80

SetGroupARN sets the GroupARN field's value.

func (*GetServiceGraphInput) SetGroupName added in v1.15.80

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

SetGroupName sets the GroupName 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 {

	// A flag indicating whether the group's filter expression has been consistent,
	// or if the returned service graph may show traces from an older version of
	// the group's filter expression.
	ContainsOldGroupVersions *bool `type:"boolean"`

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

	// Pagination token.
	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"`
	// contains filtered or unexported fields
}

func (GetServiceGraphOutput) GoString

func (s GetServiceGraphOutput) GoString() string

GoString returns the string representation

func (*GetServiceGraphOutput) SetContainsOldGroupVersions added in v1.15.80

func (s *GetServiceGraphOutput) SetContainsOldGroupVersions(v bool) *GetServiceGraphOutput

SetContainsOldGroupVersions sets the ContainsOldGroupVersions field's value.

func (*GetServiceGraphOutput) SetEndTime

SetEndTime sets the EndTime field's value.

func (*GetServiceGraphOutput) SetNextToken

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

SetStartTime sets the StartTime field's value.

func (GetServiceGraphOutput) String

func (s GetServiceGraphOutput) String() string

String returns the string representation

type GetTimeSeriesServiceStatisticsInput added in v1.19.22

type GetTimeSeriesServiceStatisticsInput struct {

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

	// A filter expression defining entities that will be aggregated for statistics.
	// Supports ID, service, and edge functions. If no selector expression is specified,
	// edge statistics are returned.
	EntitySelectorExpression *string `min:"1" type:"string"`

	// The forecasted high and low fault count values. Forecast enabled requests
	// require the EntitySelectorExpression ID be provided.
	ForecastStatistics *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the group for which to pull statistics
	// from.
	GroupARN *string `min:"1" type:"string"`

	// The case-sensitive name of the group for which to pull statistics from.
	GroupName *string `min:"1" type:"string"`

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

	// Aggregation period in seconds.
	Period *int64 `type:"integer"`

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

func (GetTimeSeriesServiceStatisticsInput) GoString added in v1.19.22

GoString returns the string representation

func (*GetTimeSeriesServiceStatisticsInput) SetEndTime added in v1.19.22

SetEndTime sets the EndTime field's value.

func (*GetTimeSeriesServiceStatisticsInput) SetEntitySelectorExpression added in v1.19.22

SetEntitySelectorExpression sets the EntitySelectorExpression field's value.

func (*GetTimeSeriesServiceStatisticsInput) SetForecastStatistics added in v1.35.21

SetForecastStatistics sets the ForecastStatistics field's value.

func (*GetTimeSeriesServiceStatisticsInput) SetGroupARN added in v1.19.22

SetGroupARN sets the GroupARN field's value.

func (*GetTimeSeriesServiceStatisticsInput) SetGroupName added in v1.19.22

SetGroupName sets the GroupName field's value.

func (*GetTimeSeriesServiceStatisticsInput) SetNextToken added in v1.19.22

SetNextToken sets the NextToken field's value.

func (*GetTimeSeriesServiceStatisticsInput) SetPeriod added in v1.19.22

SetPeriod sets the Period field's value.

func (*GetTimeSeriesServiceStatisticsInput) SetStartTime added in v1.19.22

SetStartTime sets the StartTime field's value.

func (GetTimeSeriesServiceStatisticsInput) String added in v1.19.22

String returns the string representation

func (*GetTimeSeriesServiceStatisticsInput) Validate added in v1.19.22

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

type GetTimeSeriesServiceStatisticsOutput added in v1.19.22

type GetTimeSeriesServiceStatisticsOutput struct {

	// A flag indicating whether or not a group's filter expression has been consistent,
	// or if a returned aggregation might show statistics from an older version
	// of the group's filter expression.
	ContainsOldGroupVersions *bool `type:"boolean"`

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

	// The collection of statistics.
	TimeSeriesServiceStatistics []*TimeSeriesServiceStatistics `type:"list"`
	// contains filtered or unexported fields
}

func (GetTimeSeriesServiceStatisticsOutput) GoString added in v1.19.22

GoString returns the string representation

func (*GetTimeSeriesServiceStatisticsOutput) SetContainsOldGroupVersions added in v1.19.22

SetContainsOldGroupVersions sets the ContainsOldGroupVersions field's value.

func (*GetTimeSeriesServiceStatisticsOutput) SetNextToken added in v1.19.22

SetNextToken sets the NextToken field's value.

func (*GetTimeSeriesServiceStatisticsOutput) SetTimeSeriesServiceStatistics added in v1.19.22

SetTimeSeriesServiceStatistics sets the TimeSeriesServiceStatistics field's value.

func (GetTimeSeriesServiceStatisticsOutput) String added in v1.19.22

String returns the string representation

type GetTraceGraphInput

type GetTraceGraphInput struct {

	// Pagination token.
	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.
	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" required:"true"`

	// Specify a filter expression to retrieve trace summaries for services or requests
	// that meet certain requirements.
	FilterExpression *string `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"`

	// A parameter to indicate whether to enable sampling on trace summaries. Input
	// parameters are Name and Value.
	SamplingStrategy *SamplingStrategy `type:"structure"`

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

	// A parameter to indicate whether to query trace summaries by TraceId or Event
	// time.
	TimeRangeType *string `type:"string" enum:"TimeRangeType"`
	// contains filtered or unexported fields
}

func (GetTraceSummariesInput) GoString

func (s GetTraceSummariesInput) GoString() string

GoString returns the string representation

func (*GetTraceSummariesInput) SetEndTime

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

SetNextToken sets the NextToken field's value.

func (*GetTraceSummariesInput) SetSampling

SetSampling sets the Sampling field's value.

func (*GetTraceSummariesInput) SetSamplingStrategy added in v1.19.22

SetSamplingStrategy sets the SamplingStrategy field's value.

func (*GetTraceSummariesInput) SetStartTime

SetStartTime sets the StartTime field's value.

func (*GetTraceSummariesInput) SetTimeRangeType added in v1.19.22

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

SetTimeRangeType sets the TimeRangeType 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"`

	// 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 recent results, closest to the end of the time frame.
	NextToken *string `type:"string"`

	// Trace IDs and annotations 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

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 Group added in v1.15.80

type Group struct {

	// The filter expression defining the parameters to include traces.
	FilterExpression *string `type:"string"`

	// The Amazon Resource Name (ARN) of the group generated based on the GroupName.
	GroupARN *string `type:"string"`

	// The unique case-sensitive name of the group.
	GroupName *string `type:"string"`

	// The structure containing configurations related to insights.
	//
	//    * The InsightsEnabled boolean can be set to true to enable insights for
	//    the group or false to disable insights for the group.
	//
	//    * The NotifcationsEnabled boolean can be set to true to enable insights
	//    notifications through Amazon EventBridge for the group.
	InsightsConfiguration *InsightsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Details and metadata for a group.

func (Group) GoString added in v1.15.80

func (s Group) GoString() string

GoString returns the string representation

func (*Group) SetFilterExpression added in v1.15.80

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

SetFilterExpression sets the FilterExpression field's value.

func (*Group) SetGroupARN added in v1.15.80

func (s *Group) SetGroupARN(v string) *Group

SetGroupARN sets the GroupARN field's value.

func (*Group) SetGroupName added in v1.15.80

func (s *Group) SetGroupName(v string) *Group

SetGroupName sets the GroupName field's value.

func (*Group) SetInsightsConfiguration added in v1.34.18

func (s *Group) SetInsightsConfiguration(v *InsightsConfiguration) *Group

SetInsightsConfiguration sets the InsightsConfiguration field's value.

func (Group) String added in v1.15.80

func (s Group) String() string

String returns the string representation

type GroupSummary added in v1.15.80

type GroupSummary struct {

	// The filter expression defining the parameters to include traces.
	FilterExpression *string `type:"string"`

	// The ARN of the group generated based on the GroupName.
	GroupARN *string `type:"string"`

	// The unique case-sensitive name of the group.
	GroupName *string `type:"string"`

	// The structure containing configurations related to insights.
	//
	//    * The InsightsEnabled boolean can be set to true to enable insights for
	//    the group or false to disable insights for the group.
	//
	//    * The NotificationsEnabled boolean can be set to true to enable insights
	//    notifications. Notifications can only be enabled on a group with InsightsEnabled
	//    set to true.
	InsightsConfiguration *InsightsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Details for a group without metadata.

func (GroupSummary) GoString added in v1.15.80

func (s GroupSummary) GoString() string

GoString returns the string representation

func (*GroupSummary) SetFilterExpression added in v1.15.80

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

SetFilterExpression sets the FilterExpression field's value.

func (*GroupSummary) SetGroupARN added in v1.15.80

func (s *GroupSummary) SetGroupARN(v string) *GroupSummary

SetGroupARN sets the GroupARN field's value.

func (*GroupSummary) SetGroupName added in v1.15.80

func (s *GroupSummary) SetGroupName(v string) *GroupSummary

SetGroupName sets the GroupName field's value.

func (*GroupSummary) SetInsightsConfiguration added in v1.34.18

func (s *GroupSummary) SetInsightsConfiguration(v *InsightsConfiguration) *GroupSummary

SetInsightsConfiguration sets the InsightsConfiguration field's value.

func (GroupSummary) String added in v1.15.80

func (s GroupSummary) 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 Insight added in v1.35.21

type Insight struct {

	// The categories that label and describe the type of insight.
	Categories []*string `type:"list"`

	// The impact statistics of the client side service. This includes the number
	// of requests to the client service and whether the requests were faults or
	// okay.
	ClientRequestImpactStatistics *RequestImpactStatistics `type:"structure"`

	// The time, in Unix seconds, at which the insight ended.
	EndTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the group that the insight belongs to.
	GroupARN *string `min:"1" type:"string"`

	// The name of the group that the insight belongs to.
	GroupName *string `min:"1" type:"string"`

	// The insights unique identifier.
	InsightId *string `type:"string"`

	RootCauseServiceId *ServiceId `type:"structure"`

	// The impact statistics of the root cause service. This includes the number
	// of requests to the client service and whether the requests were faults or
	// okay.
	RootCauseServiceRequestImpactStatistics *RequestImpactStatistics `type:"structure"`

	// The time, in Unix seconds, at which the insight began.
	StartTime *time.Time `type:"timestamp"`

	// The current state of the insight.
	State *string `type:"string" enum:"InsightState"`

	// A brief description of the insight.
	Summary *string `type:"string"`

	// The service within the insight that is most impacted by the incident.
	TopAnomalousServices []*AnomalousService `type:"list"`
	// contains filtered or unexported fields
}

When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.

func (Insight) GoString added in v1.35.21

func (s Insight) GoString() string

GoString returns the string representation

func (*Insight) SetCategories added in v1.35.21

func (s *Insight) SetCategories(v []*string) *Insight

SetCategories sets the Categories field's value.

func (*Insight) SetClientRequestImpactStatistics added in v1.35.21

func (s *Insight) SetClientRequestImpactStatistics(v *RequestImpactStatistics) *Insight

SetClientRequestImpactStatistics sets the ClientRequestImpactStatistics field's value.

func (*Insight) SetEndTime added in v1.35.21

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

SetEndTime sets the EndTime field's value.

func (*Insight) SetGroupARN added in v1.35.21

func (s *Insight) SetGroupARN(v string) *Insight

SetGroupARN sets the GroupARN field's value.

func (*Insight) SetGroupName added in v1.35.21

func (s *Insight) SetGroupName(v string) *Insight

SetGroupName sets the GroupName field's value.

func (*Insight) SetInsightId added in v1.35.21

func (s *Insight) SetInsightId(v string) *Insight

SetInsightId sets the InsightId field's value.

func (*Insight) SetRootCauseServiceId added in v1.35.21

func (s *Insight) SetRootCauseServiceId(v *ServiceId) *Insight

SetRootCauseServiceId sets the RootCauseServiceId field's value.

func (*Insight) SetRootCauseServiceRequestImpactStatistics added in v1.35.21

func (s *Insight) SetRootCauseServiceRequestImpactStatistics(v *RequestImpactStatistics) *Insight

SetRootCauseServiceRequestImpactStatistics sets the RootCauseServiceRequestImpactStatistics field's value.

func (*Insight) SetStartTime added in v1.35.21

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

SetStartTime sets the StartTime field's value.

func (*Insight) SetState added in v1.35.21

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

SetState sets the State field's value.

func (*Insight) SetSummary added in v1.35.21

func (s *Insight) SetSummary(v string) *Insight

SetSummary sets the Summary field's value.

func (*Insight) SetTopAnomalousServices added in v1.35.21

func (s *Insight) SetTopAnomalousServices(v []*AnomalousService) *Insight

SetTopAnomalousServices sets the TopAnomalousServices field's value.

func (Insight) String added in v1.35.21

func (s Insight) String() string

String returns the string representation

type InsightEvent added in v1.35.21

type InsightEvent struct {

	// The impact statistics of the client side service. This includes the number
	// of requests to the client service and whether the requests were faults or
	// okay.
	ClientRequestImpactStatistics *RequestImpactStatistics `type:"structure"`

	// The time, in Unix seconds, at which the event was recorded.
	EventTime *time.Time `type:"timestamp"`

	// The impact statistics of the root cause service. This includes the number
	// of requests to the client service and whether the requests were faults or
	// okay.
	RootCauseServiceRequestImpactStatistics *RequestImpactStatistics `type:"structure"`

	// A brief description of the event.
	Summary *string `type:"string"`

	// The service during the event that is most impacted by the incident.
	TopAnomalousServices []*AnomalousService `type:"list"`
	// contains filtered or unexported fields
}

X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.

func (InsightEvent) GoString added in v1.35.21

func (s InsightEvent) GoString() string

GoString returns the string representation

func (*InsightEvent) SetClientRequestImpactStatistics added in v1.35.21

func (s *InsightEvent) SetClientRequestImpactStatistics(v *RequestImpactStatistics) *InsightEvent

SetClientRequestImpactStatistics sets the ClientRequestImpactStatistics field's value.

func (*InsightEvent) SetEventTime added in v1.35.21

func (s *InsightEvent) SetEventTime(v time.Time) *InsightEvent

SetEventTime sets the EventTime field's value.

func (*InsightEvent) SetRootCauseServiceRequestImpactStatistics added in v1.35.21

func (s *InsightEvent) SetRootCauseServiceRequestImpactStatistics(v *RequestImpactStatistics) *InsightEvent

SetRootCauseServiceRequestImpactStatistics sets the RootCauseServiceRequestImpactStatistics field's value.

func (*InsightEvent) SetSummary added in v1.35.21

func (s *InsightEvent) SetSummary(v string) *InsightEvent

SetSummary sets the Summary field's value.

func (*InsightEvent) SetTopAnomalousServices added in v1.35.21

func (s *InsightEvent) SetTopAnomalousServices(v []*AnomalousService) *InsightEvent

SetTopAnomalousServices sets the TopAnomalousServices field's value.

func (InsightEvent) String added in v1.35.21

func (s InsightEvent) String() string

String returns the string representation

type InsightImpactGraphEdge added in v1.35.21

type InsightImpactGraphEdge struct {

	// Identifier of the edge. Unique within a service map.
	ReferenceId *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The connection between two service in an insight impact graph.

func (InsightImpactGraphEdge) GoString added in v1.35.21

func (s InsightImpactGraphEdge) GoString() string

GoString returns the string representation

func (*InsightImpactGraphEdge) SetReferenceId added in v1.35.21

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

SetReferenceId sets the ReferenceId field's value.

func (InsightImpactGraphEdge) String added in v1.35.21

func (s InsightImpactGraphEdge) String() string

String returns the string representation

type InsightImpactGraphService added in v1.35.21

type InsightImpactGraphService struct {

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

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

	// 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"`

	// Identifier for the service. Unique within the service map.
	//
	//    * AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance
	//    for an application running on Amazon EC2 or AWS::DynamoDB::Table for an
	//    Amazon DynamoDB table that the application used.
	//
	//    * 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.
	//
	//    * 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.
	//
	//    * 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 (InsightImpactGraphService) GoString added in v1.35.21

func (s InsightImpactGraphService) GoString() string

GoString returns the string representation

func (*InsightImpactGraphService) SetAccountId added in v1.35.21

SetAccountId sets the AccountId field's value.

func (*InsightImpactGraphService) SetEdges added in v1.35.21

SetEdges sets the Edges field's value.

func (*InsightImpactGraphService) SetName added in v1.35.21

SetName sets the Name field's value.

func (*InsightImpactGraphService) SetNames added in v1.35.21

SetNames sets the Names field's value.

func (*InsightImpactGraphService) SetReferenceId added in v1.35.21

SetReferenceId sets the ReferenceId field's value.

func (*InsightImpactGraphService) SetType added in v1.35.21

SetType sets the Type field's value.

func (InsightImpactGraphService) String added in v1.35.21

func (s InsightImpactGraphService) String() string

String returns the string representation

type InsightSummary added in v1.35.21

type InsightSummary struct {

	// Categories The categories that label and describe the type of insight.
	Categories []*string `type:"list"`

	// The impact statistics of the client side service. This includes the number
	// of requests to the client service and whether the requests were faults or
	// okay.
	ClientRequestImpactStatistics *RequestImpactStatistics `type:"structure"`

	// The time, in Unix seconds, at which the insight ended.
	EndTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the group that the insight belongs to.
	GroupARN *string `min:"1" type:"string"`

	// The name of the group that the insight belongs to.
	GroupName *string `min:"1" type:"string"`

	// The insights unique identifier.
	InsightId *string `type:"string"`

	// The time, in Unix seconds, that the insight was last updated.
	LastUpdateTime *time.Time `type:"timestamp"`

	RootCauseServiceId *ServiceId `type:"structure"`

	// The impact statistics of the root cause service. This includes the number
	// of requests to the client service and whether the requests were faults or
	// okay.
	RootCauseServiceRequestImpactStatistics *RequestImpactStatistics `type:"structure"`

	// The time, in Unix seconds, at which the insight began.
	StartTime *time.Time `type:"timestamp"`

	// The current state of the insight.
	State *string `type:"string" enum:"InsightState"`

	// A brief description of the insight.
	Summary *string `type:"string"`

	// The service within the insight that is most impacted by the incident.
	TopAnomalousServices []*AnomalousService `type:"list"`
	// contains filtered or unexported fields
}

Information that describes an insight.

func (InsightSummary) GoString added in v1.35.21

func (s InsightSummary) GoString() string

GoString returns the string representation

func (*InsightSummary) SetCategories added in v1.35.21

func (s *InsightSummary) SetCategories(v []*string) *InsightSummary

SetCategories sets the Categories field's value.

func (*InsightSummary) SetClientRequestImpactStatistics added in v1.35.21

func (s *InsightSummary) SetClientRequestImpactStatistics(v *RequestImpactStatistics) *InsightSummary

SetClientRequestImpactStatistics sets the ClientRequestImpactStatistics field's value.

func (*InsightSummary) SetEndTime added in v1.35.21

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

SetEndTime sets the EndTime field's value.

func (*InsightSummary) SetGroupARN added in v1.35.21

func (s *InsightSummary) SetGroupARN(v string) *InsightSummary

SetGroupARN sets the GroupARN field's value.

func (*InsightSummary) SetGroupName added in v1.35.21

func (s *InsightSummary) SetGroupName(v string) *InsightSummary

SetGroupName sets the GroupName field's value.

func (*InsightSummary) SetInsightId added in v1.35.21

func (s *InsightSummary) SetInsightId(v string) *InsightSummary

SetInsightId sets the InsightId field's value.

func (*InsightSummary) SetLastUpdateTime added in v1.35.21

func (s *InsightSummary) SetLastUpdateTime(v time.Time) *InsightSummary

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*InsightSummary) SetRootCauseServiceId added in v1.35.21

func (s *InsightSummary) SetRootCauseServiceId(v *ServiceId) *InsightSummary

SetRootCauseServiceId sets the RootCauseServiceId field's value.

func (*InsightSummary) SetRootCauseServiceRequestImpactStatistics added in v1.35.21

func (s *InsightSummary) SetRootCauseServiceRequestImpactStatistics(v *RequestImpactStatistics) *InsightSummary

SetRootCauseServiceRequestImpactStatistics sets the RootCauseServiceRequestImpactStatistics field's value.

func (*InsightSummary) SetStartTime added in v1.35.21

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

SetStartTime sets the StartTime field's value.

func (*InsightSummary) SetState added in v1.35.21

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

SetState sets the State field's value.

func (*InsightSummary) SetSummary added in v1.35.21

func (s *InsightSummary) SetSummary(v string) *InsightSummary

SetSummary sets the Summary field's value.

func (*InsightSummary) SetTopAnomalousServices added in v1.35.21

func (s *InsightSummary) SetTopAnomalousServices(v []*AnomalousService) *InsightSummary

SetTopAnomalousServices sets the TopAnomalousServices field's value.

func (InsightSummary) String added in v1.35.21

func (s InsightSummary) String() string

String returns the string representation

type InsightsConfiguration added in v1.34.18

type InsightsConfiguration struct {

	// Set the InsightsEnabled value to true to enable insights or false to disable
	// insights.
	InsightsEnabled *bool `type:"boolean"`

	// Set the NotificationsEnabled value to true to enable insights notifications.
	// Notifications can only be enabled on a group with InsightsEnabled set to
	// true.
	NotificationsEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The structure containing configurations related to insights.

func (InsightsConfiguration) GoString added in v1.34.18

func (s InsightsConfiguration) GoString() string

GoString returns the string representation

func (*InsightsConfiguration) SetInsightsEnabled added in v1.34.18

func (s *InsightsConfiguration) SetInsightsEnabled(v bool) *InsightsConfiguration

SetInsightsEnabled sets the InsightsEnabled field's value.

func (*InsightsConfiguration) SetNotificationsEnabled added in v1.35.8

func (s *InsightsConfiguration) SetNotificationsEnabled(v bool) *InsightsConfiguration

SetNotificationsEnabled sets the NotificationsEnabled field's value.

func (InsightsConfiguration) String added in v1.34.18

func (s InsightsConfiguration) String() string

String returns the string representation

type InstanceIdDetail added in v1.15.87

type InstanceIdDetail struct {

	// The ID of a corresponding EC2 instance.
	Id *string `type:"string"`
	// contains filtered or unexported fields
}

A list of EC2 instance IDs corresponding to the segments in a trace.

func (InstanceIdDetail) GoString added in v1.15.87

func (s InstanceIdDetail) GoString() string

GoString returns the string representation

func (*InstanceIdDetail) SetId added in v1.15.87

SetId sets the Id field's value.

func (InstanceIdDetail) String added in v1.15.87

func (s InstanceIdDetail) String() string

String returns the string representation

type InvalidRequestException added in v1.28.0

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request is missing required parameters or has invalid parameters.

func (*InvalidRequestException) Code added in v1.28.0

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0

func (s InvalidRequestException) GoString() string

GoString returns the string representation

func (*InvalidRequestException) Message added in v1.28.0

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0

func (s InvalidRequestException) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.34.10

type ListTagsForResourceInput struct {

	// A pagination token. If multiple pages of results are returned, use the NextToken
	// value returned with the current page of results as the value of this parameter
	// to get the next page of results.
	NextToken *string `type:"string"`

	// The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.34.10

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetNextToken added in v1.34.10

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceARN added in v1.34.10

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.34.10

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.34.10

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.34.10

type ListTagsForResourceOutput struct {

	// A pagination token. If multiple pages of results are returned, use the NextToken
	// value returned with the current page of results to get the next page of results.
	NextToken *string `type:"string"`

	// A list of tags, as key and value pairs, that is associated with the specified
	// X-Ray group or sampling rule.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.34.10

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetNextToken added in v1.34.10

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.34.10

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.34.10

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type PutEncryptionConfigInput added in v1.13.37

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.
	//    AWS X-Ray does not support asymmetric CMKs.
	//
	//    * 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 added in v1.13.37

func (s PutEncryptionConfigInput) GoString() string

GoString returns the string representation

func (*PutEncryptionConfigInput) SetKeyId added in v1.13.37

SetKeyId sets the KeyId field's value.

func (*PutEncryptionConfigInput) SetType added in v1.13.37

SetType sets the Type field's value.

func (PutEncryptionConfigInput) String added in v1.13.37

func (s PutEncryptionConfigInput) String() string

String returns the string representation

func (*PutEncryptionConfigInput) Validate added in v1.13.37

func (s *PutEncryptionConfigInput) Validate() error

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

type PutEncryptionConfigOutput added in v1.13.37

type PutEncryptionConfigOutput struct {

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

func (PutEncryptionConfigOutput) GoString added in v1.13.37

func (s PutEncryptionConfigOutput) GoString() string

GoString returns the string representation

func (*PutEncryptionConfigOutput) SetEncryptionConfig added in v1.13.37

SetEncryptionConfig sets the EncryptionConfig field's value.

func (PutEncryptionConfigOutput) String added in v1.13.37

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

SetEC2InstanceId sets the EC2InstanceId field's value.

func (*PutTelemetryRecordsInput) SetHostname

SetHostname sets the Hostname field's value.

func (*PutTelemetryRecordsInput) SetResourceARN

SetResourceARN sets the ResourceARN field's value.

func (*PutTelemetryRecordsInput) SetTelemetryRecords

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 RequestImpactStatistics added in v1.35.21

type RequestImpactStatistics struct {

	// The number of requests that have resulted in a fault,
	FaultCount *int64 `type:"long"`

	// The number of successful requests.
	OkCount *int64 `type:"long"`

	// The total number of requests to the service.
	TotalCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

Statistics that describe how the incident has impacted a service.

func (RequestImpactStatistics) GoString added in v1.35.21

func (s RequestImpactStatistics) GoString() string

GoString returns the string representation

func (*RequestImpactStatistics) SetFaultCount added in v1.35.21

SetFaultCount sets the FaultCount field's value.

func (*RequestImpactStatistics) SetOkCount added in v1.35.21

SetOkCount sets the OkCount field's value.

func (*RequestImpactStatistics) SetTotalCount added in v1.35.21

SetTotalCount sets the TotalCount field's value.

func (RequestImpactStatistics) String added in v1.35.21

func (s RequestImpactStatistics) String() string

String returns the string representation

type ResourceARNDetail added in v1.15.87

type ResourceARNDetail struct {

	// The ARN of a corresponding resource.
	ARN *string `type:"string"`
	// contains filtered or unexported fields
}

A list of resources ARNs corresponding to the segments in a trace.

func (ResourceARNDetail) GoString added in v1.15.87

func (s ResourceARNDetail) GoString() string

GoString returns the string representation

func (*ResourceARNDetail) SetARN added in v1.15.87

SetARN sets the ARN field's value.

func (ResourceARNDetail) String added in v1.15.87

func (s ResourceARNDetail) String() string

String returns the string representation

type ResourceNotFoundException added in v1.34.10

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	ResourceName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

func (*ResourceNotFoundException) Code added in v1.34.10

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.34.10

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.34.10

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.34.10

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.34.10

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.34.10

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.34.10

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.34.10

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResponseTimeRootCause added in v1.15.87

type ResponseTimeRootCause struct {

	// A flag that denotes that the root cause impacts the trace client.
	ClientImpacting *bool `type:"boolean"`

	// A list of corresponding services. A service identifies a segment and contains
	// a name, account ID, type, and inferred flag.
	Services []*ResponseTimeRootCauseService `type:"list"`
	// contains filtered or unexported fields
}

The root cause information for a response time warning.

func (ResponseTimeRootCause) GoString added in v1.15.87

func (s ResponseTimeRootCause) GoString() string

GoString returns the string representation

func (*ResponseTimeRootCause) SetClientImpacting added in v1.29.32

func (s *ResponseTimeRootCause) SetClientImpacting(v bool) *ResponseTimeRootCause

SetClientImpacting sets the ClientImpacting field's value.

func (*ResponseTimeRootCause) SetServices added in v1.15.87

SetServices sets the Services field's value.

func (ResponseTimeRootCause) String added in v1.15.87

func (s ResponseTimeRootCause) String() string

String returns the string representation

type ResponseTimeRootCauseEntity added in v1.15.87

type ResponseTimeRootCauseEntity struct {

	// The type and messages of the exceptions.
	Coverage *float64 `type:"double"`

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

	// A flag that denotes a remote subsegment.
	Remote *bool `type:"boolean"`
	// contains filtered or unexported fields
}

A collection of segments and corresponding subsegments associated to a response time warning.

func (ResponseTimeRootCauseEntity) GoString added in v1.15.87

func (s ResponseTimeRootCauseEntity) GoString() string

GoString returns the string representation

func (*ResponseTimeRootCauseEntity) SetCoverage added in v1.15.87

SetCoverage sets the Coverage field's value.

func (*ResponseTimeRootCauseEntity) SetName added in v1.15.87

SetName sets the Name field's value.

func (*ResponseTimeRootCauseEntity) SetRemote added in v1.15.87

SetRemote sets the Remote field's value.

func (ResponseTimeRootCauseEntity) String added in v1.15.87

String returns the string representation

type ResponseTimeRootCauseService added in v1.15.87

type ResponseTimeRootCauseService struct {

	// The account ID associated to the service.
	AccountId *string `type:"string"`

	// The path of root cause entities found on the service.
	EntityPath []*ResponseTimeRootCauseEntity `type:"list"`

	// A Boolean value indicating if the service is inferred from the trace.
	Inferred *bool `type:"boolean"`

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

	// A collection of associated service names.
	Names []*string `type:"list"`

	// The type associated to the service.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

A collection of fields identifying the service in a response time warning.

func (ResponseTimeRootCauseService) GoString added in v1.15.87

func (s ResponseTimeRootCauseService) GoString() string

GoString returns the string representation

func (*ResponseTimeRootCauseService) SetAccountId added in v1.15.87

SetAccountId sets the AccountId field's value.

func (*ResponseTimeRootCauseService) SetEntityPath added in v1.15.87

SetEntityPath sets the EntityPath field's value.

func (*ResponseTimeRootCauseService) SetInferred added in v1.15.87

SetInferred sets the Inferred field's value.

func (*ResponseTimeRootCauseService) SetName added in v1.15.87

SetName sets the Name field's value.

func (*ResponseTimeRootCauseService) SetNames added in v1.15.87

SetNames sets the Names field's value.

func (*ResponseTimeRootCauseService) SetType added in v1.15.87

SetType sets the Type field's value.

func (ResponseTimeRootCauseService) String added in v1.15.87

String returns the string representation

type RootCauseException added in v1.15.87

type RootCauseException struct {

	// The message of the exception.
	Message *string `type:"string"`

	// The name of the exception.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

The exception associated with a root cause.

func (RootCauseException) GoString added in v1.15.87

func (s RootCauseException) GoString() string

GoString returns the string representation

func (*RootCauseException) SetMessage added in v1.15.87

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

SetMessage sets the Message field's value.

func (*RootCauseException) SetName added in v1.15.87

SetName sets the Name field's value.

func (RootCauseException) String added in v1.15.87

func (s RootCauseException) String() string

String returns the string representation

type RuleLimitExceededException added in v1.28.0

type RuleLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You have reached the maximum number of sampling rules.

func (*RuleLimitExceededException) Code added in v1.28.0

Code returns the exception type name.

func (*RuleLimitExceededException) Error added in v1.28.0

func (RuleLimitExceededException) GoString added in v1.28.0

func (s RuleLimitExceededException) GoString() string

GoString returns the string representation

func (*RuleLimitExceededException) Message added in v1.28.0

func (s *RuleLimitExceededException) Message() string

Message returns the exception's message.

func (*RuleLimitExceededException) OrigErr added in v1.28.0

func (s *RuleLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RuleLimitExceededException) RequestID added in v1.28.0

func (s *RuleLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RuleLimitExceededException) StatusCode added in v1.28.0

func (s *RuleLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RuleLimitExceededException) String added in v1.28.0

String returns the string representation

type SamplingRule added in v1.15.23

type SamplingRule struct {

	// Matches attributes derived from the request.
	Attributes map[string]*string `type:"map"`

	// The percentage of matching requests to instrument, after the reservoir is
	// exhausted.
	//
	// FixedRate is a required field
	FixedRate *float64 `type:"double" required:"true"`

	// Matches the HTTP method of a request.
	//
	// HTTPMethod is a required field
	HTTPMethod *string `type:"string" required:"true"`

	// Matches the hostname from a request URL.
	//
	// Host is a required field
	Host *string `type:"string" required:"true"`

	// The priority of the sampling rule.
	//
	// Priority is a required field
	Priority *int64 `min:"1" type:"integer" required:"true"`

	// A fixed number of matching requests to instrument per second, prior to applying
	// the fixed rate. The reservoir is not used directly by services, but applies
	// to all services using the rule collectively.
	//
	// ReservoirSize is a required field
	ReservoirSize *int64 `type:"integer" required:"true"`

	// Matches the ARN of the AWS resource on which the service runs.
	//
	// ResourceARN is a required field
	ResourceARN *string `type:"string" required:"true"`

	// The ARN of the sampling rule. Specify a rule by either name or ARN, but not
	// both.
	RuleARN *string `type:"string"`

	// The name of the sampling rule. Specify a rule by either name or ARN, but
	// not both.
	RuleName *string `min:"1" type:"string"`

	// Matches the name that the service uses to identify itself in segments.
	//
	// ServiceName is a required field
	ServiceName *string `type:"string" required:"true"`

	// Matches the origin that the service uses to identify its type in segments.
	//
	// ServiceType is a required field
	ServiceType *string `type:"string" required:"true"`

	// Matches the path from a request URL.
	//
	// URLPath is a required field
	URLPath *string `type:"string" required:"true"`

	// The version of the sampling rule format (1).
	//
	// Version is a required field
	Version *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

func (SamplingRule) GoString added in v1.15.23

func (s SamplingRule) GoString() string

GoString returns the string representation

func (*SamplingRule) SetAttributes added in v1.15.23

func (s *SamplingRule) SetAttributes(v map[string]*string) *SamplingRule

SetAttributes sets the Attributes field's value.

func (*SamplingRule) SetFixedRate added in v1.15.23

func (s *SamplingRule) SetFixedRate(v float64) *SamplingRule

SetFixedRate sets the FixedRate field's value.

func (*SamplingRule) SetHTTPMethod added in v1.15.23

func (s *SamplingRule) SetHTTPMethod(v string) *SamplingRule

SetHTTPMethod sets the HTTPMethod field's value.

func (*SamplingRule) SetHost added in v1.15.23

func (s *SamplingRule) SetHost(v string) *SamplingRule

SetHost sets the Host field's value.

func (*SamplingRule) SetPriority added in v1.15.23

func (s *SamplingRule) SetPriority(v int64) *SamplingRule

SetPriority sets the Priority field's value.

func (*SamplingRule) SetReservoirSize added in v1.15.23

func (s *SamplingRule) SetReservoirSize(v int64) *SamplingRule

SetReservoirSize sets the ReservoirSize field's value.

func (*SamplingRule) SetResourceARN added in v1.15.23

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

SetResourceARN sets the ResourceARN field's value.

func (*SamplingRule) SetRuleARN added in v1.15.23

func (s *SamplingRule) SetRuleARN(v string) *SamplingRule

SetRuleARN sets the RuleARN field's value.

func (*SamplingRule) SetRuleName added in v1.15.23

func (s *SamplingRule) SetRuleName(v string) *SamplingRule

SetRuleName sets the RuleName field's value.

func (*SamplingRule) SetServiceName added in v1.15.23

func (s *SamplingRule) SetServiceName(v string) *SamplingRule

SetServiceName sets the ServiceName field's value.

func (*SamplingRule) SetServiceType added in v1.15.23

func (s *SamplingRule) SetServiceType(v string) *SamplingRule

SetServiceType sets the ServiceType field's value.

func (*SamplingRule) SetURLPath added in v1.15.23

func (s *SamplingRule) SetURLPath(v string) *SamplingRule

SetURLPath sets the URLPath field's value.

func (*SamplingRule) SetVersion added in v1.15.23

func (s *SamplingRule) SetVersion(v int64) *SamplingRule

SetVersion sets the Version field's value.

func (SamplingRule) String added in v1.15.23

func (s SamplingRule) String() string

String returns the string representation

func (*SamplingRule) Validate added in v1.15.23

func (s *SamplingRule) Validate() error

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

type SamplingRuleRecord added in v1.15.23

type SamplingRuleRecord struct {

	// When the rule was created.
	CreatedAt *time.Time `type:"timestamp"`

	// When the rule was last modified.
	ModifiedAt *time.Time `type:"timestamp"`

	// The sampling rule.
	SamplingRule *SamplingRule `type:"structure"`
	// contains filtered or unexported fields
}

A SamplingRule and its metadata.

func (SamplingRuleRecord) GoString added in v1.15.23

func (s SamplingRuleRecord) GoString() string

GoString returns the string representation

func (*SamplingRuleRecord) SetCreatedAt added in v1.15.23

func (s *SamplingRuleRecord) SetCreatedAt(v time.Time) *SamplingRuleRecord

SetCreatedAt sets the CreatedAt field's value.

func (*SamplingRuleRecord) SetModifiedAt added in v1.15.23

func (s *SamplingRuleRecord) SetModifiedAt(v time.Time) *SamplingRuleRecord

SetModifiedAt sets the ModifiedAt field's value.

func (*SamplingRuleRecord) SetSamplingRule added in v1.15.23

func (s *SamplingRuleRecord) SetSamplingRule(v *SamplingRule) *SamplingRuleRecord

SetSamplingRule sets the SamplingRule field's value.

func (SamplingRuleRecord) String added in v1.15.23

func (s SamplingRuleRecord) String() string

String returns the string representation

type SamplingRuleUpdate added in v1.15.23

type SamplingRuleUpdate struct {

	// Matches attributes derived from the request.
	Attributes map[string]*string `type:"map"`

	// The percentage of matching requests to instrument, after the reservoir is
	// exhausted.
	FixedRate *float64 `type:"double"`

	// Matches the HTTP method of a request.
	HTTPMethod *string `type:"string"`

	// Matches the hostname from a request URL.
	Host *string `type:"string"`

	// The priority of the sampling rule.
	Priority *int64 `type:"integer"`

	// A fixed number of matching requests to instrument per second, prior to applying
	// the fixed rate. The reservoir is not used directly by services, but applies
	// to all services using the rule collectively.
	ReservoirSize *int64 `type:"integer"`

	// Matches the ARN of the AWS resource on which the service runs.
	ResourceARN *string `type:"string"`

	// The ARN of the sampling rule. Specify a rule by either name or ARN, but not
	// both.
	RuleARN *string `type:"string"`

	// The name of the sampling rule. Specify a rule by either name or ARN, but
	// not both.
	RuleName *string `min:"1" type:"string"`

	// Matches the name that the service uses to identify itself in segments.
	ServiceName *string `type:"string"`

	// Matches the origin that the service uses to identify its type in segments.
	ServiceType *string `type:"string"`

	// Matches the path from a request URL.
	URLPath *string `type:"string"`
	// contains filtered or unexported fields
}

A document specifying changes to a sampling rule's configuration.

func (SamplingRuleUpdate) GoString added in v1.15.23

func (s SamplingRuleUpdate) GoString() string

GoString returns the string representation

func (*SamplingRuleUpdate) SetAttributes added in v1.15.23

func (s *SamplingRuleUpdate) SetAttributes(v map[string]*string) *SamplingRuleUpdate

SetAttributes sets the Attributes field's value.

func (*SamplingRuleUpdate) SetFixedRate added in v1.15.23

func (s *SamplingRuleUpdate) SetFixedRate(v float64) *SamplingRuleUpdate

SetFixedRate sets the FixedRate field's value.

func (*SamplingRuleUpdate) SetHTTPMethod added in v1.15.23

func (s *SamplingRuleUpdate) SetHTTPMethod(v string) *SamplingRuleUpdate

SetHTTPMethod sets the HTTPMethod field's value.

func (*SamplingRuleUpdate) SetHost added in v1.15.23

SetHost sets the Host field's value.

func (*SamplingRuleUpdate) SetPriority added in v1.15.23

func (s *SamplingRuleUpdate) SetPriority(v int64) *SamplingRuleUpdate

SetPriority sets the Priority field's value.

func (*SamplingRuleUpdate) SetReservoirSize added in v1.15.23

func (s *SamplingRuleUpdate) SetReservoirSize(v int64) *SamplingRuleUpdate

SetReservoirSize sets the ReservoirSize field's value.

func (*SamplingRuleUpdate) SetResourceARN added in v1.15.23

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

SetResourceARN sets the ResourceARN field's value.

func (*SamplingRuleUpdate)