xray

package
v1.18.2 Latest Latest
Warning

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

 Go to latest Published: Aug 27, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

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 (

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

	// 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"
)
View Source 
const (
	ServiceName = "xray"      // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "XRay"      // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

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 AvailabilityZoneDetail added in v1.17.5 

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.17.5 

func (s AvailabilityZoneDetail) GoString() string

GoString returns the string representation

func (*AvailabilityZoneDetail) SetName added in v1.17.5 

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

SetName sets the Name field's value.

func (AvailabilityZoneDetail) String added in v1.17.5 

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 

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

SetOtherCount sets the OtherCount field's value.

func (*BackendConnectionErrors) SetTimeoutCount 

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

SetTimeoutCount sets the TimeoutCount field's value.

func (*BackendConnectionErrors) SetUnknownHostCount 

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

SetUnknownHostCount sets the UnknownHostCount field's value.

func (BackendConnectionErrors) String 

func (s BackendConnectionErrors) String() string

String returns the string representation

type BatchGetTracesInput 

type BatchGetTracesInput struct {

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

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

func (BatchGetTracesInput) GoString 

func (s BatchGetTracesInput) GoString() string

GoString returns the string representation

func (*BatchGetTracesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*BatchGetTracesInput) SetTraceIds 

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

SetTraceIds sets the TraceIds field's value.

func (BatchGetTracesInput) String 

func (s BatchGetTracesInput) String() string

String returns the string representation

func (*BatchGetTracesInput) Validate 

func (s *BatchGetTracesInput) Validate() error

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

type BatchGetTracesOutput 

type BatchGetTracesOutput struct {

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

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

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

func (BatchGetTracesOutput) GoString 

func (s BatchGetTracesOutput) GoString() string

GoString returns the string representation

func (*BatchGetTracesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*BatchGetTracesOutput) SetTraces 

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

SetTraces sets the Traces field's value.

func (*BatchGetTracesOutput) SetUnprocessedTraceIds 

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

SetUnprocessedTraceIds sets the UnprocessedTraceIds field's value.

func (BatchGetTracesOutput) String 

func (s BatchGetTracesOutput) String() string

String returns the string representation

type CreateGroupInput added in v1.17.5 

type CreateGroupInput struct {

	// The filter expression defining criteria by which to group traces.
	FilterExpression *string `min:"1" 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"`
	// contains filtered or unexported fields
}

func (CreateGroupInput) GoString added in v1.17.5 

func (s CreateGroupInput) GoString() string

GoString returns the string representation

func (*CreateGroupInput) SetFilterExpression added in v1.17.5 

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

SetFilterExpression sets the FilterExpression field's value.

func (*CreateGroupInput) SetGroupName added in v1.17.5 

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

SetGroupName sets the GroupName field's value.

func (CreateGroupInput) String added in v1.17.5 

func (s CreateGroupInput) String() string

String returns the string representation

func (*CreateGroupInput) Validate added in v1.17.5 

func (s *CreateGroupInput) Validate() error

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

type CreateGroupOutput added in v1.17.5 

type CreateGroupOutput struct {

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

func (CreateGroupOutput) GoString added in v1.17.5 

func (s CreateGroupOutput) GoString() string

GoString returns the string representation

func (*CreateGroupOutput) SetGroup added in v1.17.5 

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

SetGroup sets the Group field's value.

func (CreateGroupOutput) String added in v1.17.5 

func (s CreateGroupOutput) String() string

String returns the string representation

type CreateSamplingRuleInput added in v1.17.5 

type CreateSamplingRuleInput struct {

	// The rule definition.
	//
	// SamplingRule is a required field
	SamplingRule *SamplingRule `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSamplingRuleInput) GoString added in v1.17.5 

func (s CreateSamplingRuleInput) GoString() string

GoString returns the string representation

func (*CreateSamplingRuleInput) SetSamplingRule added in v1.17.5 

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

SetSamplingRule sets the SamplingRule field's value.

func (CreateSamplingRuleInput) String added in v1.17.5 

func (s CreateSamplingRuleInput) String() string

String returns the string representation

func (*CreateSamplingRuleInput) Validate added in v1.17.5 

func (s *CreateSamplingRuleInput) Validate() error

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

type CreateSamplingRuleOutput added in v1.17.5 

type CreateSamplingRuleOutput struct {

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

func (CreateSamplingRuleOutput) GoString added in v1.17.5 

func (s CreateSamplingRuleOutput) GoString() string

GoString returns the string representation

func (*CreateSamplingRuleOutput) SetSamplingRuleRecord added in v1.17.5 

func (s *CreateSamplingRuleOutput) SetSamplingRuleRecord(v *SamplingRuleRecord) *CreateSamplingRuleOutput

SetSamplingRuleRecord sets the SamplingRuleRecord field's value.

func (CreateSamplingRuleOutput) String added in v1.17.5 

func (s CreateSamplingRuleOutput) String() string

String returns the string representation

type DeleteGroupInput added in v1.17.5 

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.17.5 

func (s DeleteGroupInput) GoString() string

GoString returns the string representation

func (*DeleteGroupInput) SetGroupARN added in v1.17.5 

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

SetGroupARN sets the GroupARN field's value.

func (*DeleteGroupInput) SetGroupName added in v1.17.5 

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

SetGroupName sets the GroupName field's value.

func (DeleteGroupInput) String added in v1.17.5 

func (s DeleteGroupInput) String() string

String returns the string representation

func (*DeleteGroupInput) Validate added in v1.17.5 

func (s *DeleteGroupInput) Validate() error

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

type DeleteGroupOutput added in v1.17.5 

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

func (DeleteGroupOutput) GoString added in v1.17.5 

func (s DeleteGroupOutput) GoString() string

GoString returns the string representation

func (DeleteGroupOutput) String added in v1.17.5 

func (s DeleteGroupOutput) String() string

String returns the string representation

type DeleteSamplingRuleInput added in v1.17.5 

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.17.5 

func (s DeleteSamplingRuleInput) GoString() string

GoString returns the string representation

func (*DeleteSamplingRuleInput) SetRuleARN added in v1.17.5 

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

SetRuleARN sets the RuleARN field's value.

func (*DeleteSamplingRuleInput) SetRuleName added in v1.17.5 

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

SetRuleName sets the RuleName field's value.

func (DeleteSamplingRuleInput) String added in v1.17.5 

func (s DeleteSamplingRuleInput) String() string

String returns the string representation

type DeleteSamplingRuleOutput added in v1.17.5 

type DeleteSamplingRuleOutput struct {

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

func (DeleteSamplingRuleOutput) GoString added in v1.17.5 

func (s DeleteSamplingRuleOutput) GoString() string

GoString returns the string representation

func (*DeleteSamplingRuleOutput) SetSamplingRuleRecord added in v1.17.5 

func (s *DeleteSamplingRuleOutput) SetSamplingRuleRecord(v *SamplingRuleRecord) *DeleteSamplingRuleOutput

SetSamplingRuleRecord sets the SamplingRuleRecord field's value.

func (DeleteSamplingRuleOutput) String added in v1.17.5 

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.17.5 

type ErrorRootCause struct {

	// 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.17.5 

func (s ErrorRootCause) GoString() string

GoString returns the string representation

func (*ErrorRootCause) SetServices added in v1.17.5 

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

SetServices sets the Services field's value.

func (ErrorRootCause) String added in v1.17.5 

func (s ErrorRootCause) String() string

String returns the string representation

type ErrorRootCauseEntity added in v1.17.5 

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.17.5 

func (s ErrorRootCauseEntity) GoString() string

GoString returns the string representation

func (*ErrorRootCauseEntity) SetExceptions added in v1.17.5 

func (s *ErrorRootCauseEntity) SetExceptions(v []*RootCauseException) *ErrorRootCauseEntity

SetExceptions sets the Exceptions field's value.

func (*ErrorRootCauseEntity) SetName added in v1.17.5 

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

SetName sets the Name field's value.

func (*ErrorRootCauseEntity) SetRemote added in v1.17.5 

func (s *ErrorRootCauseEntity) SetRemote(v bool) *ErrorRootCauseEntity

SetRemote sets the Remote field's value.

func (ErrorRootCauseEntity) String added in v1.17.5 

func (s ErrorRootCauseEntity) String() string

String returns the string representation

type ErrorRootCauseService added in v1.17.5 

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.17.5 

func (s ErrorRootCauseService) GoString() string

GoString returns the string representation

func (*ErrorRootCauseService) SetAccountId added in v1.17.5 

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

SetAccountId sets the AccountId field's value.

func (*ErrorRootCauseService) SetEntityPath added in v1.17.5 

func (s *ErrorRootCauseService) SetEntityPath(v []*ErrorRootCauseEntity) *ErrorRootCauseService

SetEntityPath sets the EntityPath field's value.

func (*ErrorRootCauseService) SetInferred added in v1.17.5 

func (s *ErrorRootCauseService) SetInferred(v bool) *ErrorRootCauseService

SetInferred sets the Inferred field's value.

func (*ErrorRootCauseService) SetName added in v1.17.5 

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

SetName sets the Name field's value.

func (*ErrorRootCauseService) SetNames added in v1.17.5 

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

SetNames sets the Names field's value.

func (*ErrorRootCauseService) SetType added in v1.17.5 

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

SetType sets the Type field's value.

func (ErrorRootCauseService) String added in v1.17.5 

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.17.5 

type FaultRootCause struct {

	// 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.17.5 

func (s FaultRootCause) GoString() string

GoString returns the string representation

func (*FaultRootCause) SetServices added in v1.17.5 

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

SetServices sets the Services field's value.

func (FaultRootCause) String added in v1.17.5 

func (s FaultRootCause) String() string

String returns the string representation

type FaultRootCauseEntity added in v1.17.5 

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.17.5 

func (s FaultRootCauseEntity) GoString() string

GoString returns the string representation

func (*FaultRootCauseEntity) SetExceptions added in v1.17.5 

func (s *FaultRootCauseEntity) SetExceptions(v []*RootCauseException) *FaultRootCauseEntity

SetExceptions sets the Exceptions field's value.

func (*FaultRootCauseEntity) SetName added in v1.17.5 

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

SetName sets the Name field's value.

func (*FaultRootCauseEntity) SetRemote added in v1.17.5 

func (s *FaultRootCauseEntity) SetRemote(v bool) *FaultRootCauseEntity

SetRemote sets the Remote field's value.

func (FaultRootCauseEntity) String added in v1.17.5 

func (s FaultRootCauseEntity) String() string

String returns the string representation

type FaultRootCauseService added in v1.17.5 

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.17.5 

func (s FaultRootCauseService) GoString() string

GoString returns the string representation

func (*FaultRootCauseService) SetAccountId added in v1.17.5 

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

SetAccountId sets the AccountId field's value.

func (*FaultRootCauseService) SetEntityPath added in v1.17.5 

func (s *FaultRootCauseService) SetEntityPath(v []*FaultRootCauseEntity) *FaultRootCauseService

SetEntityPath sets the EntityPath field's value.

func (*FaultRootCauseService) SetInferred added in v1.17.5 

func (s *FaultRootCauseService) SetInferred(v bool) *FaultRootCauseService

SetInferred sets the Inferred field's value.

func (*FaultRootCauseService) SetName added in v1.17.5 

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

SetName sets the Name field's value.

func (*FaultRootCauseService) SetNames added in v1.17.5 

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

SetNames sets the Names field's value.

func (*FaultRootCauseService) SetType added in v1.17.5 

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

SetType sets the Type field's value.

func (FaultRootCauseService) String added in v1.17.5 

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 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 

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

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.17.5 

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.17.5 

func (s GetGroupInput) GoString() string

GoString returns the string representation

func (*GetGroupInput) SetGroupARN added in v1.17.5 

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

SetGroupARN sets the GroupARN field's value.

func (*GetGroupInput) SetGroupName added in v1.17.5 

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

SetGroupName sets the GroupName field's value.

func (GetGroupInput) String added in v1.17.5 

func (s GetGroupInput) String() string

String returns the string representation

func (*GetGroupInput) Validate added in v1.17.5 

func (s *GetGroupInput) Validate() error

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

type GetGroupOutput added in v1.17.5 

type GetGroupOutput struct {

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

func (GetGroupOutput) GoString added in v1.17.5 

func (s GetGroupOutput) GoString() string

GoString returns the string representation

func (*GetGroupOutput) SetGroup added in v1.17.5 

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

SetGroup sets the Group field's value.

func (GetGroupOutput) String added in v1.17.5 

func (s GetGroupOutput) String() string

String returns the string representation

type GetGroupsInput added in v1.17.5 

type GetGroupsInput struct {

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

func (GetGroupsInput) GoString added in v1.17.5 

func (s GetGroupsInput) GoString() string

GoString returns the string representation

func (*GetGroupsInput) SetNextToken added in v1.17.5 

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

SetNextToken sets the NextToken field's value.

func (GetGroupsInput) String added in v1.17.5 

func (s GetGroupsInput) String() string

String returns the string representation

func (*GetGroupsInput) Validate added in v1.17.5 

func (s *GetGroupsInput) Validate() error

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

type GetGroupsOutput added in v1.17.5 

type GetGroupsOutput struct {

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

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

func (GetGroupsOutput) GoString added in v1.17.5 

func (s GetGroupsOutput) GoString() string

GoString returns the string representation

func (*GetGroupsOutput) SetGroups added in v1.17.5 

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

SetGroups sets the Groups field's value.

func (*GetGroupsOutput) SetNextToken added in v1.17.5 

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

SetNextToken sets the NextToken field's value.

func (GetGroupsOutput) String added in v1.17.5 

func (s GetGroupsOutput) String() string

String returns the string representation

type GetSamplingRulesInput added in v1.17.5 

type GetSamplingRulesInput struct {

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

func (GetSamplingRulesInput) GoString added in v1.17.5 

func (s GetSamplingRulesInput) GoString() string

GoString returns the string representation

func (*GetSamplingRulesInput) SetNextToken added in v1.17.5 

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

SetNextToken sets the NextToken field's value.

func (GetSamplingRulesInput) String added in v1.17.5 

func (s GetSamplingRulesInput) String() string

String returns the string representation

type GetSamplingRulesOutput added in v1.17.5 

type GetSamplingRulesOutput struct {

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

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

func (GetSamplingRulesOutput) GoString added in v1.17.5 

func (s GetSamplingRulesOutput) GoString() string

GoString returns the string representation

func (*GetSamplingRulesOutput) SetNextToken added in v1.17.5 

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

SetNextToken sets the NextToken field's value.

func (*GetSamplingRulesOutput) SetSamplingRuleRecords added in v1.17.5 

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

SetSamplingRuleRecords sets the SamplingRuleRecords field's value.

func (GetSamplingRulesOutput) String added in v1.17.5 

func (s GetSamplingRulesOutput) String() string

String returns the string representation

type GetSamplingStatisticSummariesInput added in v1.17.5 

type GetSamplingStatisticSummariesInput struct {

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

func (GetSamplingStatisticSummariesInput) GoString added in v1.17.5 

func (s GetSamplingStatisticSummariesInput) GoString() string

GoString returns the string representation

func (*GetSamplingStatisticSummariesInput) SetNextToken added in v1.17.5 

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

SetNextToken sets the NextToken field's value.

func (GetSamplingStatisticSummariesInput) String added in v1.17.5 

func (s GetSamplingStatisticSummariesInput) String() string

String returns the string representation

type GetSamplingStatisticSummariesOutput added in v1.17.5 

type GetSamplingStatisticSummariesOutput struct {

	// Pagination token. Not used.
	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.17.5 

func (s GetSamplingStatisticSummariesOutput) GoString() string

GoString returns the string representation

func (*GetSamplingStatisticSummariesOutput) SetNextToken added in v1.17.5 

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

SetNextToken sets the NextToken field's value.

func (*GetSamplingStatisticSummariesOutput) SetSamplingStatisticSummaries added in v1.17.5 

func (s *GetSamplingStatisticSummariesOutput) SetSamplingStatisticSummaries(v []*SamplingStatisticSummary) *GetSamplingStatisticSummariesOutput

SetSamplingStatisticSummaries sets the SamplingStatisticSummaries field's value.

func (GetSamplingStatisticSummariesOutput) String added in v1.17.5 

func (s GetSamplingStatisticSummariesOutput) String() string

String returns the string representation

type GetSamplingTargetsInput added in v1.17.5 

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.17.5 

func (s GetSamplingTargetsInput) GoString() string

GoString returns the string representation

func (*GetSamplingTargetsInput) SetSamplingStatisticsDocuments added in v1.17.5 

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

SetSamplingStatisticsDocuments sets the SamplingStatisticsDocuments field's value.

func (GetSamplingTargetsInput) String added in v1.17.5 

func (s GetSamplingTargetsInput) String() string

String returns the string representation

func (*GetSamplingTargetsInput) Validate added in v1.17.5 

func (s *GetSamplingTargetsInput) Validate() error

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

type GetSamplingTargetsOutput added in v1.17.5 

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.17.5 

func (s GetSamplingTargetsOutput) GoString() string

GoString returns the string representation

func (*GetSamplingTargetsOutput) SetLastRuleModification added in v1.17.5 

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

SetLastRuleModification sets the LastRuleModification field's value.

func (*GetSamplingTargetsOutput) SetSamplingTargetDocuments added in v1.17.5 

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

SetSamplingTargetDocuments sets the SamplingTargetDocuments field's value.

func (*GetSamplingTargetsOutput) SetUnprocessedStatistics added in v1.17.5 

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

SetUnprocessedStatistics sets the UnprocessedStatistics field's value.

func (GetSamplingTargetsOutput) String added in v1.17.5 

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 ARN of a group to generate a graph based on.
	GroupARN *string `min:"1" type:"string"`

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

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

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

func (GetServiceGraphInput) GoString 

func (s GetServiceGraphInput) GoString() string

GoString returns the string representation

func (*GetServiceGraphInput) SetEndTime 

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

SetEndTime sets the EndTime field's value.

func (*GetServiceGraphInput) SetGroupARN added in v1.17.5 

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

SetGroupARN sets the GroupARN field's value.

func (*GetServiceGraphInput) SetGroupName added in v1.17.5 

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. Not used.
	NextToken *string `type:"string"`

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

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

func (GetServiceGraphOutput) GoString 

func (s GetServiceGraphOutput) GoString() string

GoString returns the string representation

func (*GetServiceGraphOutput) SetContainsOldGroupVersions added in v1.17.5 

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

SetContainsOldGroupVersions sets the ContainsOldGroupVersions field's value.

func (*GetServiceGraphOutput) SetEndTime 

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

SetEndTime sets the EndTime field's value.

func (*GetServiceGraphOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetServiceGraphOutput) SetServices 

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

SetServices sets the Services field's value.

func (*GetServiceGraphOutput) SetStartTime 

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

SetStartTime sets the StartTime field's value.

func (GetServiceGraphOutput) String 

func (s GetServiceGraphOutput) String() string

String returns the string representation

type GetTraceGraphInput 

type GetTraceGraphInput struct {

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

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

func (GetTraceGraphInput) GoString 

func (s GetTraceGraphInput) GoString() string

GoString returns the string representation

func (*GetTraceGraphInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetTraceGraphInput) SetTraceIds 

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

SetTraceIds sets the TraceIds field's value.

func (GetTraceGraphInput) String 

func (s GetTraceGraphInput) String() string

String returns the string representation

func (*GetTraceGraphInput) Validate 

func (s *GetTraceGraphInput) Validate() error

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

type GetTraceGraphOutput 

type GetTraceGraphOutput struct {

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

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

func (GetTraceGraphOutput) GoString 

func (s GetTraceGraphOutput) GoString() string

GoString returns the string representation

func (*GetTraceGraphOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetTraceGraphOutput) SetServices 

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

SetServices sets the Services field's value.

func (GetTraceGraphOutput) String 

func (s GetTraceGraphOutput) String() string

String returns the string representation

type GetTraceSummariesInput 

type GetTraceSummariesInput struct {

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

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

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

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

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

func (GetTraceSummariesInput) GoString 

func (s GetTraceSummariesInput) GoString() string

GoString returns the string representation

func (*GetTraceSummariesInput) SetEndTime 

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

SetEndTime sets the EndTime field's value.

func (*GetTraceSummariesInput) SetFilterExpression 

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

SetFilterExpression sets the FilterExpression field's value.

func (*GetTraceSummariesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetTraceSummariesInput) SetSampling 

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

SetSampling sets the Sampling field's value.

func (*GetTraceSummariesInput) SetStartTime 

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

SetStartTime sets the StartTime field's value.

func (GetTraceSummariesInput) String 

func (s GetTraceSummariesInput) String() string

String returns the string representation

func (*GetTraceSummariesInput) Validate 

func (s *GetTraceSummariesInput) Validate() error

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

type GetTraceSummariesOutput 

type GetTraceSummariesOutput struct {

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

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

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

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

func (GetTraceSummariesOutput) GoString 

func (s GetTraceSummariesOutput) GoString() string

GoString returns the string representation

func (*GetTraceSummariesOutput) SetApproximateTime 

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

SetApproximateTime sets the ApproximateTime field's value.

func (*GetTraceSummariesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetTraceSummariesOutput) SetTraceSummaries 

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

SetTraceSummaries sets the TraceSummaries field's value.

func (*GetTraceSummariesOutput) SetTracesProcessedCount 

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

SetTracesProcessedCount sets the TracesProcessedCount field's value.

func (GetTraceSummariesOutput) String 

func (s GetTraceSummariesOutput) String() string

String returns the string representation

type Group added in v1.17.5 

type Group 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"`
	// contains filtered or unexported fields
}

Details and metadata for a group.

func (Group) GoString added in v1.17.5 

func (s Group) GoString() string

GoString returns the string representation

func (*Group) SetFilterExpression added in v1.17.5 

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

SetFilterExpression sets the FilterExpression field's value.

func (*Group) SetGroupARN added in v1.17.5 

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

SetGroupARN sets the GroupARN field's value.

func (*Group) SetGroupName added in v1.17.5 

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

SetGroupName sets the GroupName field's value.

func (Group) String added in v1.17.5 

func (s Group) String() string

String returns the string representation

type GroupSummary added in v1.17.5 

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

Details for a group without metadata.

func (GroupSummary) GoString added in v1.17.5 

func (s GroupSummary) GoString() string

GoString returns the string representation

func (*GroupSummary) SetFilterExpression added in v1.17.5 

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

SetFilterExpression sets the FilterExpression field's value.

func (*GroupSummary) SetGroupARN added in v1.17.5 

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

SetGroupARN sets the GroupARN field's value.

func (*GroupSummary) SetGroupName added in v1.17.5 

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

SetGroupName sets the GroupName field's value.

func (GroupSummary) String added in v1.17.5 

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 InstanceIdDetail added in v1.17.5 

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.17.5 

func (s InstanceIdDetail) GoString() string

GoString returns the string representation

func (*InstanceIdDetail) SetId added in v1.17.5 

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

SetId sets the Id field's value.

func (InstanceIdDetail) String added in v1.17.5 

func (s InstanceIdDetail) 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.
	//
	//    * 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 

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

SetKeyId sets the KeyId field's value.

func (*PutEncryptionConfigInput) SetType added in v1.13.37 

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

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 

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

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 

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

SetEC2InstanceId sets the EC2InstanceId field's value.

func (*PutTelemetryRecordsInput) SetHostname 

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

SetHostname sets the Hostname field's value.

func (*PutTelemetryRecordsInput) SetResourceARN 

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

SetResourceARN sets the ResourceARN field's value.

func (*PutTelemetryRecordsInput) SetTelemetryRecords 

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

SetTelemetryRecords sets the TelemetryRecords field's value.

func (PutTelemetryRecordsInput) String 

func (s PutTelemetryRecordsInput) String() string

String returns the string representation

func (*PutTelemetryRecordsInput) Validate 

func (s *PutTelemetryRecordsInput) Validate() error

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

type PutTelemetryRecordsOutput 

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

func (PutTelemetryRecordsOutput) GoString 

func (s PutTelemetryRecordsOutput) GoString() string

GoString returns the string representation

func (PutTelemetryRecordsOutput) String 

func (s PutTelemetryRecordsOutput) String() string

String returns the string representation

type PutTraceSegmentsInput 

type PutTraceSegmentsInput struct {

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

func (PutTraceSegmentsInput) GoString 

func (s PutTraceSegmentsInput) GoString() string

GoString returns the string representation

func (*PutTraceSegmentsInput) SetTraceSegmentDocuments 

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

SetTraceSegmentDocuments sets the TraceSegmentDocuments field's value.

func (PutTraceSegmentsInput) String 

func (s PutTraceSegmentsInput) String() string

String returns the string representation

func (*PutTraceSegmentsInput) Validate 

func (s *PutTraceSegmentsInput) Validate() error

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

type PutTraceSegmentsOutput 

type PutTraceSegmentsOutput struct {

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

func (PutTraceSegmentsOutput) GoString 

func (s PutTraceSegmentsOutput) GoString() string

GoString returns the string representation

func (*PutTraceSegmentsOutput) SetUnprocessedTraceSegments 

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

SetUnprocessedTraceSegments sets the UnprocessedTraceSegments field's value.

func (PutTraceSegmentsOutput) String 

func (s PutTraceSegmentsOutput) String() string

String returns the string representation

type ResourceARNDetail added in v1.17.5 

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.17.5 

func (s ResourceARNDetail) GoString() string

GoString returns the string representation

func (*ResourceARNDetail) SetARN added in v1.17.5 

func (s *ResourceARNDetail) SetARN(v string) *ResourceARNDetail

SetARN sets the ARN field's value.

func (ResourceARNDetail) String added in v1.17.5 

func (s ResourceARNDetail) String() string

String returns the string representation

type ResponseTimeRootCause added in v1.17.5 

type ResponseTimeRootCause struct {

	// 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.17.5 

func (s ResponseTimeRootCause) GoString() string

GoString returns the string representation

func (*ResponseTimeRootCause) SetServices added in v1.17.5 

func (s *ResponseTimeRootCause) SetServices(v []*ResponseTimeRootCauseService) *ResponseTimeRootCause

SetServices sets the Services field's value.

func (ResponseTimeRootCause) String added in v1.17.5 

func (s ResponseTimeRootCause) String() string

String returns the string representation

type ResponseTimeRootCauseEntity added in v1.17.5 

type ResponseTimeRootCauseEntity struct {

	// The types 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.17.5 

func (s ResponseTimeRootCauseEntity) GoString() string

GoString returns the string representation

func (*ResponseTimeRootCauseEntity) SetCoverage added in v1.17.5 

func (s *ResponseTimeRootCauseEntity) SetCoverage(v float64) *ResponseTimeRootCauseEntity

SetCoverage sets the Coverage field's value.

func (*ResponseTimeRootCauseEntity) SetName added in v1.17.5 

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

SetName sets the Name field's value.

func (*ResponseTimeRootCauseEntity) SetRemote added in v1.17.5 

func (s *ResponseTimeRootCauseEntity) SetRemote(v bool) *ResponseTimeRootCauseEntity

SetRemote sets the Remote field's value.

func (ResponseTimeRootCauseEntity) String added in v1.17.5 

func (s ResponseTimeRootCauseEntity) String() string

String returns the string representation

type ResponseTimeRootCauseService added in v1.17.5 

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.17.5 

func (s ResponseTimeRootCauseService) GoString() string

GoString returns the string representation

func (*ResponseTimeRootCauseService) SetAccountId added in v1.17.5 

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

SetAccountId sets the AccountId field's value.

func (*ResponseTimeRootCauseService) SetEntityPath added in v1.17.5 

func (s *ResponseTimeRootCauseService) SetEntityPath(v []*ResponseTimeRootCauseEntity) *ResponseTimeRootCauseService

SetEntityPath sets the EntityPath field's value.

func (*ResponseTimeRootCauseService) SetInferred added in v1.17.5 

func (s *ResponseTimeRootCauseService) SetInferred(v bool) *ResponseTimeRootCauseService

SetInferred sets the Inferred field's value.

func (*ResponseTimeRootCauseService) SetName added in v1.17.5 

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

SetName sets the Name field's value.

func (*ResponseTimeRootCauseService) SetNames added in v1.17.5 

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

SetNames sets the Names field's value.

func (*ResponseTimeRootCauseService) SetType added in v1.17.5 

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

SetType sets the Type field's value.

func (ResponseTimeRootCauseService) String added in v1.17.5 

func (s ResponseTimeRootCauseService) String() string

String returns the string representation

type RootCauseException added in v1.17.5 

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.17.5 

func (s RootCauseException) GoString() string

GoString returns the string representation

func (*RootCauseException) SetMessage added in v1.17.5 

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

SetMessage sets the Message field's value.

func (*RootCauseException) SetName added in v1.17.5 

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

SetName sets the Name field's value.

func (RootCauseException) String added in v1.17.5 

func (s RootCauseException) String() string

String returns the string representation

type SamplingRule added in v1.17.5 

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.17.5 

func (s SamplingRule) GoString() string

GoString returns the string representation

func (*SamplingRule) SetAttributes added in v1.17.5 

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

SetAttributes sets the Attributes field's value.

func (*SamplingRule) SetFixedRate added in v1.17.5 

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

SetFixedRate sets the FixedRate field's value.

func (*SamplingRule) SetHTTPMethod added in v1.17.5 

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

SetHTTPMethod sets the HTTPMethod field's value.

func (*SamplingRule) SetHost added in v1.17.5 

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

SetHost sets the Host field's value.

func (*SamplingRule) SetPriority added in v1.17.5 

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

SetPriority sets the Priority field's value.

func (*SamplingRule) SetReservoirSize added in v1.17.5 

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

SetReservoirSize sets the ReservoirSize field's value.

func (*SamplingRule) SetResourceARN added in v1.17.5 

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

SetResourceARN sets the ResourceARN field's value.

func (*SamplingRule) SetRuleARN added in v1.17.5 

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

SetRuleARN sets the RuleARN field's value.

func (*SamplingRule) SetRuleName added in v1.17.5 

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

SetRuleName sets the RuleName field's value.

func (*SamplingRule) SetServiceName added in v1.17.5 

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

SetServiceName sets the ServiceName field's value.

func (*SamplingRule) SetServiceType added in v1.17.5 

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

SetServiceType sets the ServiceType field's value.

func (*SamplingRule) SetURLPath added in v1.17.5 

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

SetURLPath sets the URLPath field's value.

func (*SamplingRule) SetVersion added in v1.17.5 

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

SetVersion sets the Version field's value.

func (SamplingRule) String added in v1.17.5 

func (s SamplingRule) String() string

String returns the string representation

func (*SamplingRule) Validate added in v1.17.5 

func (s *SamplingRule) Validate() error

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

type SamplingRuleRecord added in v1.17.5 

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.17.5 

func (s SamplingRuleRecord) GoString() string

GoString returns the string representation

func (*SamplingRuleRecord) SetCreatedAt added in v1.17.5 

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

SetCreatedAt sets the CreatedAt field's value.

func (*SamplingRuleRecord) SetModifiedAt added in v1.17.5 

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

SetModifiedAt sets the ModifiedAt field's value.

func (*SamplingRuleRecord) SetSamplingRule added in v1.17.5 

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

SetSamplingRule sets the SamplingRule field's value.

func (SamplingRuleRecord) String added in v1.17.5 

func (s SamplingRuleRecord) String() string

String returns the string representation

type SamplingRuleUpdate added in v1.17.5 

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.17.5 

func (s SamplingRuleUpdate) GoString() string

GoString returns the string representation

func (*SamplingRuleUpdate) SetAttributes added in v1.17.5 

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

SetAttributes sets the Attributes field's value.

func (*SamplingRuleUpdate) SetFixedRate added in v1.17.5 

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

SetFixedRate sets the FixedRate field's value.

func (*SamplingRuleUpdate) SetHTTPMethod added in v1.17.5 

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

SetHTTPMethod sets the HTTPMethod field's value.

func (*SamplingRuleUpdate) SetHost added in v1.17.5 

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

SetHost sets the Host field's value.

func (*SamplingRuleUpdate) SetPriority added in v1.17.5 

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

SetPriority sets the Priority field's value.

func (*SamplingRuleUpdate) SetReservoirSize added in v1.17.5 

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

SetReservoirSize sets the ReservoirSize field's value.

func (*SamplingRuleUpdate) SetResourceARN added in v1.17.5 

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

SetResourceARN sets the ResourceARN field's value.

func (*SamplingRuleUpdate) SetRuleARN added in v1.17.5 

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

SetRuleARN sets the RuleARN field's value.

func (*SamplingRuleUpdate) SetRuleName added in v1.17.5 

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

SetRuleName sets the RuleName field's value.

func (*SamplingRuleUpdate) SetServiceName added in v1.17.5 

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

SetServiceName sets the ServiceName field's value.

func (*SamplingRuleUpdate) SetServiceType added in v1.17.5 

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

SetServiceType sets the ServiceType field's value.

func (*SamplingRuleUpdate) SetURLPath added in v1.17.5 

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

SetURLPath sets the URLPath field's value.

func (SamplingRuleUpdate) String added in v1.17.5 

func (s SamplingRuleUpdate) String() string

String returns the string representation

func (*SamplingRuleUpdate) Validate added in v1.17.5 

func (s *SamplingRuleUpdate) Validate() error

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

type SamplingStatisticSummary added in v1.17.5 

type SamplingStatisticSummary struct {

	// The number of requests recorded with borrowed reservoir quota.
	BorrowCount *int64 `type:"integer"`

	// The number of requests that matched the rule.
	RequestCount *int64 `type:"integer"`

	// The name of the sampling rule.
	RuleName *string `type:"string"`

	// The number of requests recorded.
	SampledCount *int64 `type:"integer"`

	// The start time of the reporting window.
	Timestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Aggregated request sampling data for a sampling rule across all services for a 10 second window.

func (SamplingStatisticSummary) GoString added in v1.17.5 

func (s SamplingStatisticSummary) GoString() string

GoString returns the string representation

func (*SamplingStatisticSummary) SetBorrowCount added in v1.17.5 

func (s *SamplingStatisticSummary) SetBorrowCount(v int64) *SamplingStatisticSummary

SetBorrowCount sets the BorrowCount field's value.

func (*SamplingStatisticSummary) SetRequestCount added in v1.17.5 

func (s *SamplingStatisticSummary) SetRequestCount(v int64) *SamplingStatisticSummary

SetRequestCount sets the RequestCount field's value.

func (*SamplingStatisticSummary) SetRuleName added in v1.17.5 

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

SetRuleName sets the RuleName field's value.

func (*SamplingStatisticSummary) SetSampledCount added in v1.17.5 

func (s *SamplingStatisticSummary) SetSampledCount(v int64) *SamplingStatisticSummary

SetSampledCount sets the SampledCount field's value.

func (*SamplingStatisticSummary) SetTimestamp added in v1.17.5 

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

SetTimestamp sets the Timestamp field's value.

func (SamplingStatisticSummary) String added in v1.17.5 

func (s SamplingStatisticSummary) String() string

String returns the string representation

type SamplingStatisticsDocument added in v1.17.5 

type SamplingStatisticsDocument struct {

	// The number of requests recorded with borrowed reservoir quota.
	BorrowCount *int64 `type:"integer"`

	// A unique identifier for the service in hexadecimal.
	//
	// ClientID is a required field
	ClientID *string `min:"24" type:"string" required:"true"`

	// The number of requests that matched the rule.
	//
	// RequestCount is a required field
	RequestCount *int64 `type:"integer" required:"true"`

	// The name of the sampling rule.
	//
	// RuleName is a required field
	RuleName *string `min:"1" type:"string" required:"true"`

	// The number of requests recorded.
	//
	// SampledCount is a required field
	SampledCount *int64 `type:"integer" required:"true"`

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

Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.

func (SamplingStatisticsDocument) GoString added in v1.17.5 

func (s SamplingStatisticsDocument) GoString() string

GoString returns the string representation

func (*SamplingStatisticsDocument) SetBorrowCount added in v1.17.5 

func (s *SamplingStatisticsDocument) SetBorrowCount(v int64) *SamplingStatisticsDocument

SetBorrowCount sets the BorrowCount field's value.

func (*SamplingStatisticsDocument) SetClientID added in v1.17.5 

func (s *SamplingStatisticsDocument) SetClientID(v string) *SamplingStatisticsDocument

SetClientID sets the ClientID field's value.

func (*SamplingStatisticsDocument) SetRequestCount added in v1.17.5 

func (s *SamplingStatisticsDocument) SetRequestCount(v int64) *SamplingStatisticsDocument

SetRequestCount sets the RequestCount field's value.

func (*SamplingStatisticsDocument) SetRuleName added in v1.17.5 

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

SetRuleName sets the RuleName field's value.

func (*SamplingStatisticsDocument) SetSampledCount added in v1.17.5 

func (s *SamplingStatisticsDocument) SetSampledCount(v int64) *SamplingStatisticsDocument

SetSampledCount sets the SampledCount field's value.

func (*SamplingStatisticsDocument) SetTimestamp added in v1.17.5 

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

SetTimestamp sets the Timestamp field's value.

func (SamplingStatisticsDocument) String added in v1.17.5 

func (s SamplingStatisticsDocument) String() string

String returns the string representation

func (*SamplingStatisticsDocument) Validate added in v1.17.5 

func (s *SamplingStatisticsDocument) Validate() error

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

type SamplingTargetDocument added in v1.17.5 

type SamplingTargetDocument struct {

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

	// The number of seconds for the service to wait before getting sampling targets
	// again.
	Interval *int64 `type:"integer"`

	// The number of requests per second that X-Ray allocated this service.
	ReservoirQuota *int64 `type:"integer"`

	// When the reservoir quota expires.
	ReservoirQuotaTTL *time.Time `type:"timestamp"`

	// The name of the sampling rule.
	RuleName *string `type:"string"`
	// contains filtered or unexported fields
}

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

func (SamplingTargetDocument) GoString added in v1.17.5 

func (s SamplingTargetDocument) GoString() string

GoString returns the string representation

func (*SamplingTargetDocument) SetFixedRate added in v1.17.5 

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

SetFixedRate sets the FixedRate field's value.

func (*SamplingTargetDocument) SetInterval added in v1.17.5 

func (s *SamplingTargetDocument) SetInterval(v int64) *SamplingTargetDocument

SetInterval sets the Interval field's value.

func (*SamplingTargetDocument) SetReservoirQuota added in v1.17.5 

func (s *SamplingTargetDocument) SetReservoirQuota(v int64) *SamplingTargetDocument

SetReservoirQuota sets the ReservoirQuota field's value.

func (*SamplingTargetDocument) SetReservoirQuotaTTL added in v1.17.5 

func (s *SamplingTargetDocument) SetReservoirQuotaTTL(v time.Time) *SamplingTargetDocument

SetReservoirQuotaTTL sets the ReservoirQuotaTTL field's value.

func (*SamplingTargetDocument) SetRuleName added in v1.17.5 

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

SetRuleName sets the RuleName field's value.

func (SamplingTargetDocument) String added in v1.17.5 

func (s SamplingTargetDocument) String() string

String returns the string representation

type Segment 

type Segment struct {

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

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

A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.

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

func (Segment) GoString 

func (s Segment) GoString() string

GoString returns the string representation

func (*Segment) SetDocument 

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

SetDocument sets the Document field's value.

func (*Segment) SetId 

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

SetId sets the Id field's value.

func (Segment) String 

func (s Segment) String() string

String returns the string representation

type Service 

type Service struct {

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

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

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

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

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

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

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

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

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

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

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

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

	// The type of service.
	//
	//    * AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance
	//    for a application running on Amazon EC2 or AWS::DynamoDB::Table for an
	//    Amazon DynamoDB table that the application used.
	//
	//    * AWS Service - The type of an AWS service. For example, AWS::DynamoDB
	//    for downstream calls to Amazon DynamoDB that didn't target a specific
	//    table.
	//
	//    * client - Represents the clients that sent requests to a root service.
	//
	//    * remote - A downstream service of indeterminate type.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (Service) GoString 

func (s Service) GoString() string

GoString returns the string representation

func (*Service) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*Service) SetDurationHistogram 

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

SetDurationHistogram sets the DurationHistogram field's value.

func (*Service) SetEdges 

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

SetEdges sets the Edges field's value.

func (*Service) SetEndTime 

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

SetEndTime sets the EndTime field's value.

func (*Service) SetName 

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

SetName sets the Name field's value.

func (*Service) SetNames 

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

SetNames sets the Names field's value.

func (*Service) SetReferenceId 

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

SetReferenceId sets the ReferenceId field's value.

func (*Service) SetResponseTimeHistogram added in v1.8.44 

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

SetResponseTimeHistogram sets the ResponseTimeHistogram field's value.

func (*Service) SetRoot 

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

SetRoot sets the Root field's value.

func (*Service) SetStartTime 

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

SetStartTime sets the StartTime field's value.

func (*Service) SetState 

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

SetState sets the State field's value.

func (*Service) SetSummaryStatistics 

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

SetSummaryStatistics sets the SummaryStatistics field's value.

func (*Service) SetType 

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

SetType sets the Type field's value.

func (Service) String 

func (s Service) String() string

String returns the string representation

type ServiceId 

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

	Name *string `type:"string"`

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

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

func (ServiceId) GoString 

func (s ServiceId) GoString() string

GoString returns the string representation

func (*ServiceId) SetAccountId 

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

SetAccountId sets the AccountId field's value.

func (*ServiceId) SetName 

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

SetName sets the Name field's value.

func (*ServiceId) SetNames 

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

SetNames sets the Names field's value.

func (*ServiceId) SetType 

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

SetType sets the Type field's value.

func (ServiceId) String 

func (s ServiceId) String() string

String returns the string representation

type ServiceStatistics 

type ServiceStatistics struct {

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

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

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

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

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

Response statistics for a service.

func (ServiceStatistics) GoString 

func (s ServiceStatistics) GoString() string

GoString returns the string representation

func (*ServiceStatistics) SetErrorStatistics 

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

SetErrorStatistics sets the ErrorStatistics field's value.

func (*ServiceStatistics) SetFaultStatistics 

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

SetFaultStatistics sets the FaultStatistics field's value.

func (*ServiceStatistics) SetOkCount 

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

SetOkCount sets the OkCount field's value.

func (*ServiceStatistics) SetTotalCount 

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

SetTotalCount sets the TotalCount field's value.

func (*ServiceStatistics) SetTotalResponseTime 

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

SetTotalResponseTime sets the TotalResponseTime field's value.

func (ServiceStatistics) String 

func (s ServiceStatistics) String() string

String returns the string representation

type TelemetryRecord 

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

	SegmentsReceivedCount *int64 `type:"integer"`

	SegmentsRejectedCount *int64 `type:"integer"`

	SegmentsSentCount *int64 `type:"integer"`

	SegmentsSpilloverCount *int64 `type:"integer"`

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

func (TelemetryRecord) GoString 

func (s TelemetryRecord) GoString() string

GoString returns the string representation

func (*TelemetryRecord) SetBackendConnectionErrors 

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

SetBackendConnectionErrors sets the BackendConnectionErrors field's value.

func (*TelemetryRecord) SetSegmentsReceivedCount 

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

SetSegmentsReceivedCount sets the SegmentsReceivedCount field's value.

func (*TelemetryRecord) SetSegmentsRejectedCount 

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

SetSegmentsRejectedCount sets the SegmentsRejectedCount field's value.

func (*TelemetryRecord) SetSegmentsSentCount 

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

SetSegmentsSentCount sets the SegmentsSentCount field's value.

func (*TelemetryRecord) SetSegmentsSpilloverCount 

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

SetSegmentsSpilloverCount sets the SegmentsSpilloverCount field's value.

func (*TelemetryRecord) SetTimestamp 

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

SetTimestamp sets the Timestamp field's value.

func (TelemetryRecord) String 

func (s TelemetryRecord) String() string

String returns the string representation

func (*TelemetryRecord) Validate added in v1.12.32 

func (s *TelemetryRecord) Validate() error

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

type Trace 

type Trace struct {

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

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

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

A collection of segment documents with matching trace IDs.

func (Trace) GoString 

func (s Trace) GoString() string

GoString returns the string representation

func (*Trace) SetDuration 

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

SetDuration sets the Duration field's value.

func (*Trace) SetId 

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

SetId sets the Id field's value.

func (*Trace) SetSegments 

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

SetSegments sets the Segments field's value.

func (Trace) String 

func (s Trace) String() string

String returns the string representation

type TraceSummary 

type TraceSummary struct {

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

	// A list of availability zones for any zone corresponding to the trace segments.
	AvailabilityZones []*AvailabilityZoneDetail `type:"list"`

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

	// The root of a trace.
	EntryPoint *ServiceId `type:"structure"`

	// A collection of ErrorRootCause structures corresponding to the trace segments.
	ErrorRootCauses []*ErrorRootCause `type:"list"`

	// A collection of FaultRootCause structures corresponding to the the trace
	// segments.
	FaultRootCauses []*FaultRootCause `type:"list"`

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

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

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

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

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

	// A list of EC2 instance IDs for any instance corresponding to the trace segments.
	InstanceIds []*InstanceIdDetail `type:"list"`

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

	// A list of resource ARNs for any resource corresponding to the trace segments.
	ResourceARNs []*ResourceARNDetail `type:"list"`

	// The length of time in seconds between the start and end times of the root
	// segment. If the service performs work asynchronously, the response time measures
	// the time before the response is sent to the user, while the duration measures
	// the amount of time before the last traced activity completes.
	ResponseTime *float64 `type:"double"`

	// A collection of ResponseTimeRootCause structures corresponding to the trace
	// segments.
	ResponseTimeRootCauses []*ResponseTimeRootCause `type:"list"`

	// The revision number of a trace.
	Revision *int64 `type:"integer"`

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

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

Metadata generated from the segment documents in a trace.

func (TraceSummary) GoString 

func (s TraceSummary) GoString() string

GoString returns the string representation

func (*TraceSummary) SetAnnotations 

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

SetAnnotations sets the Annotations field's value.

func (*TraceSummary) SetAvailabilityZones added in v1.17.5 

func (s *TraceSummary) SetAvailabilityZones(v []*AvailabilityZoneDetail) *TraceSummary

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*TraceSummary) SetDuration 

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

SetDuration sets the Duration field's value.

func (*TraceSummary) SetEntryPoint added in v1.17.5 

func (s *TraceSummary) SetEntryPoint(v *ServiceId) *TraceSummary

SetEntryPoint sets the EntryPoint field's value.

func (*TraceSummary) SetErrorRootCauses added in v1.17.5 

func (s *TraceSummary) SetErrorRootCauses(v []*ErrorRootCause) *TraceSummary

SetErrorRootCauses sets the ErrorRootCauses field's value.

func (*TraceSummary) SetFaultRootCauses added in v1.17.5 

func (s *TraceSummary) SetFaultRootCauses(v []*FaultRootCause) *TraceSummary

SetFaultRootCauses sets the FaultRootCauses field's value.

func (*TraceSummary) SetHasError 

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

SetHasError sets the HasError field's value.

func (*TraceSummary) SetHasFault 

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

SetHasFault sets the HasFault field's value.

func (*TraceSummary) SetHasThrottle 

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

SetHasThrottle sets the HasThrottle field's value.

func (*TraceSummary) SetHttp 

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

SetHttp sets the Http field's value.

func (*TraceSummary) SetId 

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

SetId sets the Id field's value.

func (*TraceSummary) SetInstanceIds added in v1.17.5 

func (s *TraceSummary) SetInstanceIds(v []*InstanceIdDetail) *TraceSummary

SetInstanceIds sets the InstanceIds field's value.

func (*TraceSummary) SetIsPartial 

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

SetIsPartial sets the IsPartial field's value.

func (*TraceSummary) SetResourceARNs added in v1.17.5 

func (s *TraceSummary) SetResourceARNs(v []*ResourceARNDetail) *TraceSummary

SetResourceARNs sets the ResourceARNs field's value.

func (*TraceSummary) SetResponseTime 

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

SetResponseTime sets the ResponseTime field's value.

func (*TraceSummary) SetResponseTimeRootCauses added in v1.17.5 

func (s *TraceSummary) SetResponseTimeRootCauses(v []*ResponseTimeRootCause) *TraceSummary

SetResponseTimeRootCauses sets the ResponseTimeRootCauses field's value.

func (*TraceSummary) SetRevision added in v1.17.5 

func (s *TraceSummary) SetRevision(v int64) *TraceSummary

SetRevision sets the Revision field's value.

func (*TraceSummary) SetServiceIds 

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

SetServiceIds sets the ServiceIds field's value.

func (*TraceSummary) SetUsers 

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

SetUsers sets the Users field's value.

func (TraceSummary) String 

func (s TraceSummary) String() string

String returns the string representation

type TraceUser 

type TraceUser struct {

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

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

Information about a user recorded in segment documents.

func (TraceUser) GoString 

func (s TraceUser) GoString() string

GoString returns the string representation

func (*TraceUser) SetServiceIds 

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

SetServiceIds sets the ServiceIds field's value.

func (*TraceUser) SetUserName 

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

SetUserName sets the UserName field's value.

func (TraceUser) String 

func (s TraceUser) String() string

String returns the string representation

type UnprocessedStatistics added in v1.17.5 

type UnprocessedStatistics struct {

	// The error code.
	ErrorCode *string `type:"string"`

	// The error message.
	Message *string `type:"string"`

	// The name of the sampling rule.
	RuleName *string `type:"string"`
	// contains filtered or unexported fields
}

Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.

func (UnprocessedStatistics) GoString added in v1.17.5 

func (s UnprocessedStatistics) GoString() string

GoString returns the string representation

func (*UnprocessedStatistics) SetErrorCode added in v1.17.5 

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

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedStatistics) SetMessage added in v1.17.5 

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

SetMessage sets the Message field's value.

func (*UnprocessedStatistics) SetRuleName added in v1.17.5 

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

SetRuleName sets the RuleName field's value.

func (UnprocessedStatistics) String added in v1.17.5 

func (s UnprocessedStatistics) String() string

String returns the string representation

type UnprocessedTraceSegment 

type UnprocessedTraceSegment struct {

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

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

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

Information about a segment that failed processing.

func (UnprocessedTraceSegment) GoString 

func (s UnprocessedTraceSegment) GoString() string

GoString returns the string representation

func (*UnprocessedTraceSegment) SetErrorCode 

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

SetErrorCode sets the ErrorCode field's value.

func (*UnprocessedTraceSegment) SetId 

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

SetId sets the Id field's value.

func (*UnprocessedTraceSegment) SetMessage 

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

SetMessage sets the Message field's value.

func (UnprocessedTraceSegment) String 

func (s UnprocessedTraceSegment) String() string

String returns the string representation

type UpdateGroupInput added in v1.17.5 

type UpdateGroupInput struct {

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

	// The ARN that was generated upon 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 (UpdateGroupInput) GoString added in v1.17.5 

func (s UpdateGroupInput) GoString() string

GoString returns the string representation

func (*UpdateGroupInput) SetFilterExpression added in v1.17.5 

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

SetFilterExpression sets the FilterExpression field's value.

func (*UpdateGroupInput) SetGroupARN added in v1.17.5 

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

SetGroupARN sets the GroupARN field's value.

func (*UpdateGroupInput) SetGroupName added in v1.17.5 

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

SetGroupName sets the GroupName field's value.

func (UpdateGroupInput) String added in v1.17.5 

func (s UpdateGroupInput) String() string

String returns the string representation

func (*UpdateGroupInput) Validate added in v1.17.5 

func (s *UpdateGroupInput) Validate() error

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

type UpdateGroupOutput added in v1.17.5 

type UpdateGroupOutput struct {

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

func (UpdateGroupOutput) GoString added in v1.17.5 

func (s UpdateGroupOutput) GoString() string

GoString returns the string representation

func (*UpdateGroupOutput) SetGroup added in v1.17.5 

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

SetGroup sets the Group field's value.

func (UpdateGroupOutput) String added in v1.17.5 

func (s UpdateGroupOutput) String() string

String returns the string representation

type UpdateSamplingRuleInput added in v1.17.5 

type UpdateSamplingRuleInput struct {

	// The rule and fields to change.
	//
	// SamplingRuleUpdate is a required field
	SamplingRuleUpdate *SamplingRuleUpdate `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSamplingRuleInput) GoString added in v1.17.5 

func (s UpdateSamplingRuleInput) GoString() string

GoString returns the string representation

func (*UpdateSamplingRuleInput) SetSamplingRuleUpdate added in v1.17.5 

func (s *UpdateSamplingRuleInput) SetSamplingRuleUpdate(v *SamplingRuleUpdate) *UpdateSamplingRuleInput

SetSamplingRuleUpdate sets the SamplingRuleUpdate field's value.

func (UpdateSamplingRuleInput) String added in v1.17.5 

func (s UpdateSamplingRuleInput) String() string

String returns the string representation

func (*UpdateSamplingRuleInput) Validate added in v1.17.5 

func (s *UpdateSamplingRuleInput) Validate() error

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

type UpdateSamplingRuleOutput added in v1.17.5 

type UpdateSamplingRuleOutput struct {

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

func (UpdateSamplingRuleOutput) GoString added in v1.17.5 

func (s UpdateSamplingRuleOutput) GoString() string

GoString returns the string representation

func (*UpdateSamplingRuleOutput) SetSamplingRuleRecord added in v1.17.5 

func (s *UpdateSamplingRuleOutput) SetSamplingRuleRecord(v *SamplingRuleRecord) *UpdateSamplingRuleOutput

SetSamplingRuleRecord sets the SamplingRuleRecord field's value.

func (UpdateSamplingRuleOutput) String added in v1.17.5 

func (s UpdateSamplingRuleOutput) String() string

String returns the string representation

type ValueWithServiceIds 

type ValueWithServiceIds struct {

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

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

Information about a segment annotation.

func (ValueWithServiceIds) GoString 

func (s ValueWithServiceIds) GoString() string

GoString returns the string representation

func (*ValueWithServiceIds) SetAnnotationValue 

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

SetAnnotationValue sets the AnnotationValue field's value.

func (*ValueWithServiceIds) SetServiceIds 

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

SetServiceIds sets the ServiceIds field's value.

func (ValueWithServiceIds) String 

func (s ValueWithServiceIds) String() string

String returns the string representation

type XRay 

type XRay struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

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

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

func (*XRay) BatchGetTraces 

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

BatchGetTraces API operation for AWS X-Ray.

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

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

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

Returned Error Codes:

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

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

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

func (*XRay) BatchGetTracesPages added in v1.12.32 

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

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

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

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

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

func (*XRay) BatchGetTracesPagesWithContext added in v1.12.32 

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

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

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

func (*XRay) BatchGetTracesRequest 

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

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

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

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

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

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

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

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

func (*XRay) BatchGetTracesWithContext added in v1.8.0 

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

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

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

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

func (*XRay) CreateGroup added in v1.17.5 

func (c *XRay) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)

CreateGroup API operation for AWS X-Ray.

Creates a group resource with a name and a filter expression.

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

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

Returned Error Codes:

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

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

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

func (*XRay) CreateGroupRequest added in v1.17.5 

func (c *XRay) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)

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

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

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

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

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

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

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

func (*XRay) CreateGroupWithContext added in v1.17.5 

func (c *XRay) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)

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

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

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

func (*XRay) CreateSamplingRule added in v1.17.5 

func (c *XRay) CreateSamplingRule(input *CreateSamplingRuleInput) (*CreateSamplingRuleOutput, error)

CreateSamplingRule API operation for AWS X-Ray.

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

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

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

Returned Error Codes:

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

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

  • ErrCodeRuleLimitExceededException "RuleLimitExceededException" You have reached the maximum number of sampling rules.

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

func (*XRay) CreateSamplingRuleRequest added in v1.17.5 

func (c *XRay) CreateSamplingRuleRequest(input *CreateSamplingRuleInput) (req *request.Request, output *CreateSamplingRuleOutput)

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

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

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

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

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

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

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

func (*XRay) CreateSamplingRuleWithContext added in v1.17.5 

func (c *XRay) CreateSamplingRuleWithContext(ctx aws.Context, input *CreateSamplingRuleInput, opts ...request.Option) (*CreateSamplingRuleOutput, error)

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

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

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

func (*XRay) DeleteGroup added in v1.17.5 

func (c *XRay) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)

DeleteGroup API operation for AWS X-Ray.

Deletes a group resource.

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

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

Returned Error Codes:

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

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

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

func (*XRay) DeleteGroupRequest added in v1.17.5 

func (c *XRay) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)

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

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

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

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

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

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

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

func (*XRay) DeleteGroupWithContext added in v1.17.5 

func (c *XRay) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)

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

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

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

func (*XRay) DeleteSamplingRule added in v1.17.5 

func (c *XRay) DeleteSamplingRule(input *DeleteSamplingRuleInput) (*DeleteSamplingRuleOutput, error)

DeleteSamplingRule API operation for AWS X-Ray.

Deletes a sampling rule.

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

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

Returned Error Codes:

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

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

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

func (*XRay) DeleteSamplingRuleRequest added in v1.17.5 

func (c *XRay) DeleteSamplingRuleRequest(input *DeleteSamplingRuleInput) (req *request.Request, output *DeleteSamplingRuleOutput)

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

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

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

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

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

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

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

func (*XRay) DeleteSamplingRuleWithContext added in v1.17.5 

func (c *XRay) DeleteSamplingRuleWithContext(ctx aws.Context, input *DeleteSamplingRuleInput, opts ...request.Option) (*DeleteSamplingRuleOutput, error)

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

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

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

func (*XRay) GetEncryptionConfig added in v1.13.37 

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

GetEncryptionConfig API operation for AWS X-Ray.

Retrieves the current encryption configuration for X-Ray data.

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetEncryptionConfigRequest added in v1.13.37 

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

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

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

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

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

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

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

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

func (*XRay) GetEncryptionConfigWithContext added in v1.13.37 

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

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

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

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

func (*XRay) GetGroup added in v1.17.5 

func (c *XRay) GetGroup(input *GetGroupInput) (*GetGroupOutput, error)

GetGroup API operation for AWS X-Ray.

Retrieves group resource details.

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetGroupRequest added in v1.17.5 

func (c *XRay) GetGroupRequest(input *GetGroupInput) (req *request.Request, output *GetGroupOutput)

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

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

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

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

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

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

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

func (*XRay) GetGroupWithContext added in v1.17.5 

func (c *XRay) GetGroupWithContext(ctx aws.Context, input *GetGroupInput, opts ...request.Option) (*GetGroupOutput, error)

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

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

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

func (*XRay) GetGroups added in v1.17.5 

func (c *XRay) GetGroups(input *GetGroupsInput) (*GetGroupsOutput, error)

GetGroups API operation for AWS X-Ray.

Retrieves all active group details.

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetGroupsRequest added in v1.17.5 

func (c *XRay) GetGroupsRequest(input *GetGroupsInput) (req *request.Request, output *GetGroupsOutput)

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

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

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

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

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

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

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

func (*XRay) GetGroupsWithContext added in v1.17.5 

func (c *XRay) GetGroupsWithContext(ctx aws.Context, input *GetGroupsInput, opts ...request.Option) (*GetGroupsOutput, error)

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

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

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

func (*XRay) GetSamplingRules added in v1.17.5 

func (c *XRay) GetSamplingRules(input *GetSamplingRulesInput) (*GetSamplingRulesOutput, error)

GetSamplingRules API operation for AWS X-Ray.

Retrieves all sampling rules.

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetSamplingRulesRequest added in v1.17.5 

func (c *XRay) GetSamplingRulesRequest(input *GetSamplingRulesInput) (req *request.Request, output *GetSamplingRulesOutput)

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

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

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

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

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

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

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

func (*XRay) GetSamplingRulesWithContext added in v1.17.5 

func (c *XRay) GetSamplingRulesWithContext(ctx aws.Context, input *GetSamplingRulesInput, opts ...request.Option) (*GetSamplingRulesOutput, error)

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

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

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

func (*XRay) GetSamplingStatisticSummaries added in v1.17.5 

func (c *XRay) GetSamplingStatisticSummaries(input *GetSamplingStatisticSummariesInput) (*GetSamplingStatisticSummariesOutput, error)

GetSamplingStatisticSummaries API operation for AWS X-Ray.

Retrieves information about recent sampling results for all sampling rules.

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetSamplingStatisticSummariesRequest added in v1.17.5 

func (c *XRay) GetSamplingStatisticSummariesRequest(input *GetSamplingStatisticSummariesInput) (req *request.Request, output *GetSamplingStatisticSummariesOutput)

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

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

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

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

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

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

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

func (*XRay) GetSamplingStatisticSummariesWithContext added in v1.17.5 

func (c *XRay) GetSamplingStatisticSummariesWithContext(ctx aws.Context, input *GetSamplingStatisticSummariesInput, opts ...request.Option) (*GetSamplingStatisticSummariesOutput, error)

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

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

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

func (*XRay) GetSamplingTargets added in v1.17.5 

func (c *XRay) GetSamplingTargets(input *GetSamplingTargetsInput) (*GetSamplingTargetsOutput, error)

GetSamplingTargets API operation for AWS X-Ray.

Requests a sampling quota for rules that the service is using to sample requests.

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetSamplingTargetsRequest added in v1.17.5 

func (c *XRay) GetSamplingTargetsRequest(input *GetSamplingTargetsInput) (req *request.Request, output *GetSamplingTargetsOutput)

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

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

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

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

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

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

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

func (*XRay) GetSamplingTargetsWithContext added in v1.17.5 

func (c *XRay) GetSamplingTargetsWithContext(ctx aws.Context, input *GetSamplingTargetsInput, opts ...request.Option) (*GetSamplingTargetsOutput, error)

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

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

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

func (*XRay) GetServiceGraph 

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

GetServiceGraph API operation for AWS X-Ray.

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

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetServiceGraphPages added in v1.12.32 

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

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

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

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

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

func (*XRay) GetServiceGraphPagesWithContext added in v1.12.32 

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

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

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

func (*XRay) GetServiceGraphRequest 

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

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

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

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

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

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

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

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

func (*XRay) GetServiceGraphWithContext added in v1.8.0 

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

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

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

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

func (*XRay) GetTraceGraph 

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

GetTraceGraph API operation for AWS X-Ray.

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

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetTraceGraphPages added in v1.12.32 

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

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

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

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

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

func (*XRay) GetTraceGraphPagesWithContext added in v1.12.32 

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

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

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

func (*XRay) GetTraceGraphRequest 

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

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

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

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

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

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

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

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

func (*XRay) GetTraceGraphWithContext added in v1.8.0 

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

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

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

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

func (*XRay) GetTraceSummaries 

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

GetTraceSummaries API operation for AWS X-Ray.

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

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

service("api.example.com")

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

annotation.account = "12345"

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

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

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

Returned Error Codes:

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

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

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

func (*XRay) GetTraceSummariesPages added in v1.12.32 

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

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

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

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

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

func (*XRay) GetTraceSummariesPagesWithContext added in v1.12.32 

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

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

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

func (*XRay) GetTraceSummariesRequest 

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

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

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

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

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

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

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

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

func (*XRay) GetTraceSummariesWithContext added in v1.8.0 

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

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

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

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

func (*XRay) PutEncryptionConfig added in v1.13.37 

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

PutEncryptionConfig API operation for AWS X-Ray.

Updates the encryption configuration for X-Ray data.

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

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

Returned Error Codes:

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

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

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

func (*XRay) PutEncryptionConfigRequest added in v1.13.37 

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

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

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

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

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

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

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

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

func (*XRay) PutEncryptionConfigWithContext added in v1.13.37 

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

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

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

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

func (*XRay) PutTelemetryRecords 

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

PutTelemetryRecords API operation for AWS X-Ray.

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

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

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

Returned Error Codes:

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

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

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

func (*XRay) PutTelemetryRecordsRequest 

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

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

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

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

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

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

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

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

func (*XRay) PutTelemetryRecordsWithContext added in v1.8.0 

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

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

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

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

func (*XRay) PutTraceSegments 

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

PutTraceSegments API operation for AWS X-Ray.

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

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

Required Segment Document Fields

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

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

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

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

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

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

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

Trace ID Format

  • The version number, i.e. 1.

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

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

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

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

Returned Error Codes:

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

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

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

func (*XRay) PutTraceSegmentsRequest 

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

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

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

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

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

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

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

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

func (*XRay) PutTraceSegmentsWithContext added in v1.8.0 

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

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

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

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

func (*XRay) UpdateGroup added in v1.17.5 

func (c *XRay) UpdateGroup(input *UpdateGroupInput) (*UpdateGroupOutput, error)

UpdateGroup API operation for AWS X-Ray.

Updates a group resource.

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

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

Returned Error Codes:

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

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

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

func (*XRay) UpdateGroupRequest added in v1.17.5 

func (c *XRay) UpdateGroupRequest(input *UpdateGroupInput) (req *request.Request, output *UpdateGroupOutput)

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

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

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

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

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

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

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

func (*XRay) UpdateGroupWithContext added in v1.17.5 

func (c *XRay) UpdateGroupWithContext(ctx aws.Context, input *UpdateGroupInput, opts ...request.Option) (*UpdateGroupOutput, error)

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

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

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

func (*XRay) UpdateSamplingRule added in v1.17.5 

func (c *XRay) UpdateSamplingRule(input *UpdateSamplingRuleInput) (*UpdateSamplingRuleOutput, error)

UpdateSamplingRule API operation for AWS X-Ray.

Modifies a sampling rule's configuration.

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

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

Returned Error Codes:

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

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

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

func (*XRay) UpdateSamplingRuleRequest added in v1.17.5 

func (c *XRay) UpdateSamplingRuleRequest(input *UpdateSamplingRuleInput) (req *request.Request, output *UpdateSamplingRuleOutput)

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

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

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

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

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

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

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

func (*XRay) UpdateSamplingRuleWithContext added in v1.17.5 

func (c *XRay) UpdateSamplingRuleWithContext(ctx aws.Context, input *UpdateSamplingRuleInput, opts ...request.Option) (*UpdateSamplingRuleOutput, error)

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

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

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

Source Files

View all Source files

Directories

Path Synopsis
Package xrayiface provides an interface to enable mocking the AWS X-Ray service client for testing your code.
 Package xrayiface provides an interface to enable mocking the AWS X-Ray service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.