xray

package
v0.23.3 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2020 License: Apache-2.0 Imports: 9 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 use 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 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 (
	ServiceName = "AWS X-Ray" // Service's name
	ServiceID   = "XRay"      // Service's identifier
	EndpointsID = "xray"      // Service's Endpoint identifier
)
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"
)

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) MarshalFields added in v0.3.0 

func (s Alias) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s AnnotationValue) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AnnotationValue) String 

func (s AnnotationValue) String() string

String returns the string representation

type AvailabilityZoneDetail added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s AvailabilityZoneDetail) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AvailabilityZoneDetail) String added in v0.23.2 

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) MarshalFields added in v0.3.0 

func (s BackendConnectionErrors) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BackendConnectionErrors) String 

func (s BackendConnectionErrors) String() string

String returns the string representation

type BatchGetTracesInput 

type BatchGetTracesInput struct {

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

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

func (BatchGetTracesInput) MarshalFields added in v0.3.0 

func (s BatchGetTracesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchGetTracesInput) String 

func (s BatchGetTracesInput) String() string

String returns the string representation

func (*BatchGetTracesInput) Validate 

func (s *BatchGetTracesInput) Validate() error

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

type BatchGetTracesOutput 

type BatchGetTracesOutput struct {

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

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

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

func (BatchGetTracesOutput) MarshalFields added in v0.3.0 

func (s BatchGetTracesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchGetTracesOutput) String 

func (s BatchGetTracesOutput) String() string

String returns the string representation

type BatchGetTracesPaginator added in v0.23.2 

type BatchGetTracesPaginator struct {
	aws.Pager
}

BatchGetTracesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewBatchGetTracesPaginator added in v0.23.2 

func NewBatchGetTracesPaginator(req BatchGetTracesRequest) BatchGetTracesPaginator

NewBatchGetTracesRequestPaginator returns a paginator for BatchGetTraces. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.BatchGetTracesRequest(input)
p := xray.NewBatchGetTracesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*BatchGetTracesPaginator) CurrentPage added in v0.23.2 

func (p *BatchGetTracesPaginator) CurrentPage() *BatchGetTracesOutput

type BatchGetTracesRequest 

type BatchGetTracesRequest struct {
	*aws.Request
	Input *BatchGetTracesInput
	Copy  func(*BatchGetTracesInput) BatchGetTracesRequest
}

BatchGetTracesRequest is the request type for the BatchGetTraces API operation.

func (BatchGetTracesRequest) Send 

func (r BatchGetTracesRequest) Send(ctx context.Context) (*BatchGetTracesResponse, error)

Send marshals and sends the BatchGetTraces API request.

type BatchGetTracesResponse added in v0.23.2 

type BatchGetTracesResponse struct {
	*BatchGetTracesOutput
	// contains filtered or unexported fields
}

BatchGetTracesResponse is the response type for the BatchGetTraces API operation.

func (*BatchGetTracesResponse) SDKResponseMetdata added in v0.23.2 

func (r *BatchGetTracesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchGetTraces request.

type Client added in v0.23.2 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := xray.New(myConfig)

func (*Client) BatchGetTracesRequest added in v0.23.2 

func (c *Client) BatchGetTracesRequest(input *BatchGetTracesInput) BatchGetTracesRequest

BatchGetTracesRequest returns a request value for making 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. 

// Example sending a request using BatchGetTracesRequest.
req := client.BatchGetTracesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateGroupRequest added in v0.23.2 

func (c *Client) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest

CreateGroupRequest returns a request value for making API operation for AWS X-Ray.

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

// Example sending a request using CreateGroupRequest.
req := client.CreateGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateSamplingRuleRequest added in v0.23.2 

func (c *Client) CreateSamplingRuleRequest(input *CreateSamplingRuleInput) CreateSamplingRuleRequest

CreateSamplingRuleRequest returns a request value for making 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. 

// Example sending a request using CreateSamplingRuleRequest.
req := client.CreateSamplingRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteGroupRequest added in v0.23.2 

func (c *Client) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest

DeleteGroupRequest returns a request value for making API operation for AWS X-Ray.

Deletes a group resource. 

// Example sending a request using DeleteGroupRequest.
req := client.DeleteGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteSamplingRuleRequest added in v0.23.2 

func (c *Client) DeleteSamplingRuleRequest(input *DeleteSamplingRuleInput) DeleteSamplingRuleRequest

DeleteSamplingRuleRequest returns a request value for making API operation for AWS X-Ray.

Deletes a sampling rule. 

// Example sending a request using DeleteSamplingRuleRequest.
req := client.DeleteSamplingRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetEncryptionConfigRequest added in v0.23.2 

func (c *Client) GetEncryptionConfigRequest(input *GetEncryptionConfigInput) GetEncryptionConfigRequest

GetEncryptionConfigRequest returns a request value for making API operation for AWS X-Ray.

Retrieves the current encryption configuration for X-Ray data. 

// Example sending a request using GetEncryptionConfigRequest.
req := client.GetEncryptionConfigRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetGroupRequest added in v0.23.2 

func (c *Client) GetGroupRequest(input *GetGroupInput) GetGroupRequest

GetGroupRequest returns a request value for making API operation for AWS X-Ray.

Retrieves group resource details. 

// Example sending a request using GetGroupRequest.
req := client.GetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetGroupsRequest added in v0.23.2 

func (c *Client) GetGroupsRequest(input *GetGroupsInput) GetGroupsRequest

GetGroupsRequest returns a request value for making API operation for AWS X-Ray.

Retrieves all active group details. 

// Example sending a request using GetGroupsRequest.
req := client.GetGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetSamplingRulesRequest added in v0.23.2 

func (c *Client) GetSamplingRulesRequest(input *GetSamplingRulesInput) GetSamplingRulesRequest

GetSamplingRulesRequest returns a request value for making API operation for AWS X-Ray.

Retrieves all sampling rules. 

// Example sending a request using GetSamplingRulesRequest.
req := client.GetSamplingRulesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetSamplingStatisticSummariesRequest added in v0.23.2 

func (c *Client) GetSamplingStatisticSummariesRequest(input *GetSamplingStatisticSummariesInput) GetSamplingStatisticSummariesRequest

GetSamplingStatisticSummariesRequest returns a request value for making API operation for AWS X-Ray.

Retrieves information about recent sampling results for all sampling rules. 

// Example sending a request using GetSamplingStatisticSummariesRequest.
req := client.GetSamplingStatisticSummariesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetSamplingTargetsRequest added in v0.23.2 

func (c *Client) GetSamplingTargetsRequest(input *GetSamplingTargetsInput) GetSamplingTargetsRequest

GetSamplingTargetsRequest returns a request value for making API operation for AWS X-Ray.

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

// Example sending a request using GetSamplingTargetsRequest.
req := client.GetSamplingTargetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetServiceGraphRequest added in v0.23.2 

func (c *Client) GetServiceGraphRequest(input *GetServiceGraphInput) GetServiceGraphRequest

GetServiceGraphRequest returns a request value for making 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 (https://docs.aws.amazon.com/xray/index.html). Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases. 

// Example sending a request using GetServiceGraphRequest.
req := client.GetServiceGraphRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetTimeSeriesServiceStatisticsRequest added in v0.23.2 

func (c *Client) GetTimeSeriesServiceStatisticsRequest(input *GetTimeSeriesServiceStatisticsInput) GetTimeSeriesServiceStatisticsRequest

GetTimeSeriesServiceStatisticsRequest returns a request value for making API operation for AWS X-Ray.

Get an aggregation of service statistics defined by a specific time range. 

// Example sending a request using GetTimeSeriesServiceStatisticsRequest.
req := client.GetTimeSeriesServiceStatisticsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTimeSeriesServiceStatistics

func (*Client) GetTraceGraphRequest added in v0.23.2 

func (c *Client) GetTraceGraphRequest(input *GetTraceGraphInput) GetTraceGraphRequest

GetTraceGraphRequest returns a request value for making API operation for AWS X-Ray.

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

// Example sending a request using GetTraceGraphRequest.
req := client.GetTraceGraphRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetTraceSummariesRequest added in v0.23.2 

func (c *Client) GetTraceSummariesRequest(input *GetTraceSummariesInput) GetTraceSummariesRequest

GetTraceSummariesRequest returns a request value for making API operation for AWS X-Ray.

Retrieves IDs and annotations 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 (https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html) in the AWS X-Ray Developer Guide. 

// Example sending a request using GetTraceSummariesRequest.
req := client.GetTraceSummariesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutEncryptionConfigRequest added in v0.23.2 

func (c *Client) PutEncryptionConfigRequest(input *PutEncryptionConfigInput) PutEncryptionConfigRequest

PutEncryptionConfigRequest returns a request value for making API operation for AWS X-Ray.

Updates the encryption configuration for X-Ray data. 

// Example sending a request using PutEncryptionConfigRequest.
req := client.PutEncryptionConfigRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutTelemetryRecordsRequest added in v0.23.2 

func (c *Client) PutTelemetryRecordsRequest(input *PutTelemetryRecordsInput) PutTelemetryRecordsRequest

PutTelemetryRecordsRequest returns a request value for making API operation for AWS X-Ray.

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

// Example sending a request using PutTelemetryRecordsRequest.
req := client.PutTelemetryRecordsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutTraceSegmentsRequest added in v0.23.2 

func (c *Client) PutTraceSegmentsRequest(input *PutTraceSegmentsInput) PutTraceSegmentsRequest

PutTraceSegmentsRequest returns a request value for making API operation for AWS X-Ray.

Uploads segment documents to AWS X-Ray. The X-Ray SDK (https://docs.aws.amazon.com/xray/index.html) 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.

    // Example sending a request using PutTraceSegmentsRequest. req := client.PutTraceSegmentsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) UpdateGroupRequest added in v0.23.2 

func (c *Client) UpdateGroupRequest(input *UpdateGroupInput) UpdateGroupRequest

UpdateGroupRequest returns a request value for making API operation for AWS X-Ray.

Updates a group resource. 

// Example sending a request using UpdateGroupRequest.
req := client.UpdateGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UpdateSamplingRuleRequest added in v0.23.2 

func (c *Client) UpdateSamplingRuleRequest(input *UpdateSamplingRuleInput) UpdateSamplingRuleRequest

UpdateSamplingRuleRequest returns a request value for making API operation for AWS X-Ray.

Modifies a sampling rule's configuration. 

// Example sending a request using UpdateSamplingRuleRequest.
req := client.UpdateSamplingRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type CreateGroupInput added in v0.23.2 

type CreateGroupInput struct {

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

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

func (CreateGroupInput) MarshalFields added in v0.23.2 

func (s CreateGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateGroupInput) String added in v0.23.2 

func (s CreateGroupInput) String() string

String returns the string representation

func (*CreateGroupInput) Validate added in v0.23.2 

func (s *CreateGroupInput) Validate() error

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

type CreateGroupOutput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s CreateGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateGroupOutput) String added in v0.23.2 

func (s CreateGroupOutput) String() string

String returns the string representation

type CreateGroupRequest added in v0.23.2 

type CreateGroupRequest struct {
	*aws.Request
	Input *CreateGroupInput
	Copy  func(*CreateGroupInput) CreateGroupRequest
}

CreateGroupRequest is the request type for the CreateGroup API operation.

func (CreateGroupRequest) Send added in v0.23.2 

func (r CreateGroupRequest) Send(ctx context.Context) (*CreateGroupResponse, error)

Send marshals and sends the CreateGroup API request.

type CreateGroupResponse added in v0.23.2 

type CreateGroupResponse struct {
	*CreateGroupOutput
	// contains filtered or unexported fields
}

CreateGroupResponse is the response type for the CreateGroup API operation.

func (*CreateGroupResponse) SDKResponseMetdata added in v0.23.2 

func (r *CreateGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateGroup request.

type CreateSamplingRuleInput added in v0.23.2 

type CreateSamplingRuleInput struct {

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

func (CreateSamplingRuleInput) MarshalFields added in v0.23.2 

func (s CreateSamplingRuleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateSamplingRuleInput) String added in v0.23.2 

func (s CreateSamplingRuleInput) String() string

String returns the string representation

func (*CreateSamplingRuleInput) Validate added in v0.23.2 

func (s *CreateSamplingRuleInput) Validate() error

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

type CreateSamplingRuleOutput added in v0.23.2 

type CreateSamplingRuleOutput struct {

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

func (CreateSamplingRuleOutput) MarshalFields added in v0.23.2 

func (s CreateSamplingRuleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateSamplingRuleOutput) String added in v0.23.2 

func (s CreateSamplingRuleOutput) String() string

String returns the string representation

type CreateSamplingRuleRequest added in v0.23.2 

type CreateSamplingRuleRequest struct {
	*aws.Request
	Input *CreateSamplingRuleInput
	Copy  func(*CreateSamplingRuleInput) CreateSamplingRuleRequest
}

CreateSamplingRuleRequest is the request type for the CreateSamplingRule API operation.

func (CreateSamplingRuleRequest) Send added in v0.23.2 

func (r CreateSamplingRuleRequest) Send(ctx context.Context) (*CreateSamplingRuleResponse, error)

Send marshals and sends the CreateSamplingRule API request.

type CreateSamplingRuleResponse added in v0.23.2 

type CreateSamplingRuleResponse struct {
	*CreateSamplingRuleOutput
	// contains filtered or unexported fields
}

CreateSamplingRuleResponse is the response type for the CreateSamplingRule API operation.

func (*CreateSamplingRuleResponse) SDKResponseMetdata added in v0.23.2 

func (r *CreateSamplingRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSamplingRule request.

type DeleteGroupInput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s DeleteGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteGroupInput) String added in v0.23.2 

func (s DeleteGroupInput) String() string

String returns the string representation

func (*DeleteGroupInput) Validate added in v0.23.2 

func (s *DeleteGroupInput) Validate() error

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

type DeleteGroupOutput added in v0.23.2 

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

func (DeleteGroupOutput) MarshalFields added in v0.23.2 

func (s DeleteGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteGroupOutput) String added in v0.23.2 

func (s DeleteGroupOutput) String() string

String returns the string representation

type DeleteGroupRequest added in v0.23.2 

type DeleteGroupRequest struct {
	*aws.Request
	Input *DeleteGroupInput
	Copy  func(*DeleteGroupInput) DeleteGroupRequest
}

DeleteGroupRequest is the request type for the DeleteGroup API operation.

func (DeleteGroupRequest) Send added in v0.23.2 

func (r DeleteGroupRequest) Send(ctx context.Context) (*DeleteGroupResponse, error)

Send marshals and sends the DeleteGroup API request.

type DeleteGroupResponse added in v0.23.2 

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

DeleteGroupResponse is the response type for the DeleteGroup API operation.

func (*DeleteGroupResponse) SDKResponseMetdata added in v0.23.2 

func (r *DeleteGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteGroup request.

type DeleteSamplingRuleInput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s DeleteSamplingRuleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteSamplingRuleInput) String added in v0.23.2 

func (s DeleteSamplingRuleInput) String() string

String returns the string representation

type DeleteSamplingRuleOutput added in v0.23.2 

type DeleteSamplingRuleOutput struct {

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

func (DeleteSamplingRuleOutput) MarshalFields added in v0.23.2 

func (s DeleteSamplingRuleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteSamplingRuleOutput) String added in v0.23.2 

func (s DeleteSamplingRuleOutput) String() string

String returns the string representation

type DeleteSamplingRuleRequest added in v0.23.2 

type DeleteSamplingRuleRequest struct {
	*aws.Request
	Input *DeleteSamplingRuleInput
	Copy  func(*DeleteSamplingRuleInput) DeleteSamplingRuleRequest
}

DeleteSamplingRuleRequest is the request type for the DeleteSamplingRule API operation.

func (DeleteSamplingRuleRequest) Send added in v0.23.2 

func (r DeleteSamplingRuleRequest) Send(ctx context.Context) (*DeleteSamplingRuleResponse, error)

Send marshals and sends the DeleteSamplingRule API request.

type DeleteSamplingRuleResponse added in v0.23.2 

type DeleteSamplingRuleResponse struct {
	*DeleteSamplingRuleOutput
	// contains filtered or unexported fields
}

DeleteSamplingRuleResponse is the response type for the DeleteSamplingRule API operation.

func (*DeleteSamplingRuleResponse) SDKResponseMetdata added in v0.23.2 

func (r *DeleteSamplingRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSamplingRule request.

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) MarshalFields added in v0.3.0 

func (s Edge) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s EdgeStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EdgeStatistics) String 

func (s EdgeStatistics) String() string

String returns the string representation

type EncryptionConfig added in v0.4.0 

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 EncryptionStatus `type:"string" enum:"true"`

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

A configuration document that specifies encryption configuration settings.

func (EncryptionConfig) MarshalFields added in v0.4.0 

func (s EncryptionConfig) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (EncryptionConfig) String added in v0.4.0 

func (s EncryptionConfig) String() string

String returns the string representation

type EncryptionStatus added in v0.4.0 

type EncryptionStatus string
const (
	EncryptionStatusUpdating EncryptionStatus = "UPDATING"
	EncryptionStatusActive   EncryptionStatus = "ACTIVE"
)

Enum values for EncryptionStatus

func (EncryptionStatus) MarshalValue added in v0.4.0 

func (enum EncryptionStatus) MarshalValue() (string, error)

func (EncryptionStatus) MarshalValueBuf added in v0.4.0 

func (enum EncryptionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type EncryptionType added in v0.4.0 

type EncryptionType string
const (
	EncryptionTypeNone EncryptionType = "NONE"
	EncryptionTypeKms  EncryptionType = "KMS"
)

Enum values for EncryptionType

func (EncryptionType) MarshalValue added in v0.4.0 

func (enum EncryptionType) MarshalValue() (string, error)

func (EncryptionType) MarshalValueBuf added in v0.4.0 

func (enum EncryptionType) MarshalValueBuf(b []byte) ([]byte, error)

type ErrorRootCause added in v0.23.2 

type ErrorRootCause struct {

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

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

The root cause of a trace summary error.

func (ErrorRootCause) MarshalFields added in v0.23.2 

func (s ErrorRootCause) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorRootCause) String added in v0.23.2 

func (s ErrorRootCause) String() string

String returns the string representation

type ErrorRootCauseEntity added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s ErrorRootCauseEntity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorRootCauseEntity) String added in v0.23.2 

func (s ErrorRootCauseEntity) String() string

String returns the string representation

type ErrorRootCauseService added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s ErrorRootCauseService) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorRootCauseService) String added in v0.23.2 

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) MarshalFields added in v0.3.0 

func (s ErrorStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorStatistics) String 

func (s ErrorStatistics) String() string

String returns the string representation

type FaultRootCause added in v0.23.2 

type FaultRootCause struct {

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

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

The root cause information for a trace summary fault.

func (FaultRootCause) MarshalFields added in v0.23.2 

func (s FaultRootCause) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FaultRootCause) String added in v0.23.2 

func (s FaultRootCause) String() string

String returns the string representation

type FaultRootCauseEntity added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s FaultRootCauseEntity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FaultRootCauseEntity) String added in v0.23.2 

func (s FaultRootCauseEntity) String() string

String returns the string representation

type FaultRootCauseService added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s FaultRootCauseService) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FaultRootCauseService) String added in v0.23.2 

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) MarshalFields added in v0.3.0 

func (s FaultStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (FaultStatistics) String 

func (s FaultStatistics) String() string

String returns the string representation

type GetEncryptionConfigInput added in v0.4.0 

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

func (GetEncryptionConfigInput) MarshalFields added in v0.4.0 

func (s GetEncryptionConfigInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetEncryptionConfigInput) String added in v0.4.0 

func (s GetEncryptionConfigInput) String() string

String returns the string representation

type GetEncryptionConfigOutput added in v0.4.0 

type GetEncryptionConfigOutput struct {

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

func (GetEncryptionConfigOutput) MarshalFields added in v0.4.0 

func (s GetEncryptionConfigOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetEncryptionConfigOutput) String added in v0.4.0 

func (s GetEncryptionConfigOutput) String() string

String returns the string representation

type GetEncryptionConfigRequest added in v0.4.0 

type GetEncryptionConfigRequest struct {
	*aws.Request
	Input *GetEncryptionConfigInput
	Copy  func(*GetEncryptionConfigInput) GetEncryptionConfigRequest
}

GetEncryptionConfigRequest is the request type for the GetEncryptionConfig API operation.

func (GetEncryptionConfigRequest) Send added in v0.4.0 

func (r GetEncryptionConfigRequest) Send(ctx context.Context) (*GetEncryptionConfigResponse, error)

Send marshals and sends the GetEncryptionConfig API request.

type GetEncryptionConfigResponse added in v0.23.2 

type GetEncryptionConfigResponse struct {
	*GetEncryptionConfigOutput
	// contains filtered or unexported fields
}

GetEncryptionConfigResponse is the response type for the GetEncryptionConfig API operation.

func (*GetEncryptionConfigResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetEncryptionConfigResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetEncryptionConfig request.

type GetGroupInput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s GetGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetGroupInput) String added in v0.23.2 

func (s GetGroupInput) String() string

String returns the string representation

func (*GetGroupInput) Validate added in v0.23.2 

func (s *GetGroupInput) Validate() error

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

type GetGroupOutput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s GetGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetGroupOutput) String added in v0.23.2 

func (s GetGroupOutput) String() string

String returns the string representation

type GetGroupRequest added in v0.23.2 

type GetGroupRequest struct {
	*aws.Request
	Input *GetGroupInput
	Copy  func(*GetGroupInput) GetGroupRequest
}

GetGroupRequest is the request type for the GetGroup API operation.

func (GetGroupRequest) Send added in v0.23.2 

func (r GetGroupRequest) Send(ctx context.Context) (*GetGroupResponse, error)

Send marshals and sends the GetGroup API request.

type GetGroupResponse added in v0.23.2 

type GetGroupResponse struct {
	*GetGroupOutput
	// contains filtered or unexported fields
}

GetGroupResponse is the response type for the GetGroup API operation.

func (*GetGroupResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetGroup request.

type GetGroupsInput added in v0.23.2 

type GetGroupsInput struct {

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

func (GetGroupsInput) MarshalFields added in v0.23.2 

func (s GetGroupsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetGroupsInput) String added in v0.23.2 

func (s GetGroupsInput) String() string

String returns the string representation

func (*GetGroupsInput) Validate added in v0.23.2 

func (s *GetGroupsInput) Validate() error

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

type GetGroupsOutput added in v0.23.2 

type GetGroupsOutput struct {

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

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

func (GetGroupsOutput) MarshalFields added in v0.23.2 

func (s GetGroupsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetGroupsOutput) String added in v0.23.2 

func (s GetGroupsOutput) String() string

String returns the string representation

type GetGroupsPaginator added in v0.23.2 

type GetGroupsPaginator struct {
	aws.Pager
}

GetGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetGroupsPaginator added in v0.23.2 

func NewGetGroupsPaginator(req GetGroupsRequest) GetGroupsPaginator

NewGetGroupsRequestPaginator returns a paginator for GetGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetGroupsRequest(input)
p := xray.NewGetGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetGroupsPaginator) CurrentPage added in v0.23.2 

func (p *GetGroupsPaginator) CurrentPage() *GetGroupsOutput

type GetGroupsRequest added in v0.23.2 

type GetGroupsRequest struct {
	*aws.Request
	Input *GetGroupsInput
	Copy  func(*GetGroupsInput) GetGroupsRequest
}

GetGroupsRequest is the request type for the GetGroups API operation.

func (GetGroupsRequest) Send added in v0.23.2 

func (r GetGroupsRequest) Send(ctx context.Context) (*GetGroupsResponse, error)

Send marshals and sends the GetGroups API request.

type GetGroupsResponse added in v0.23.2 

type GetGroupsResponse struct {
	*GetGroupsOutput
	// contains filtered or unexported fields
}

GetGroupsResponse is the response type for the GetGroups API operation.

func (*GetGroupsResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetGroups request.

type GetSamplingRulesInput added in v0.23.2 

type GetSamplingRulesInput struct {

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

func (GetSamplingRulesInput) MarshalFields added in v0.23.2 

func (s GetSamplingRulesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSamplingRulesInput) String added in v0.23.2 

func (s GetSamplingRulesInput) String() string

String returns the string representation

type GetSamplingRulesOutput added in v0.23.2 

type GetSamplingRulesOutput struct {

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

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

func (GetSamplingRulesOutput) MarshalFields added in v0.23.2 

func (s GetSamplingRulesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSamplingRulesOutput) String added in v0.23.2 

func (s GetSamplingRulesOutput) String() string

String returns the string representation

type GetSamplingRulesPaginator added in v0.23.2 

type GetSamplingRulesPaginator struct {
	aws.Pager
}

GetSamplingRulesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetSamplingRulesPaginator added in v0.23.2 

func NewGetSamplingRulesPaginator(req GetSamplingRulesRequest) GetSamplingRulesPaginator

NewGetSamplingRulesRequestPaginator returns a paginator for GetSamplingRules. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetSamplingRulesRequest(input)
p := xray.NewGetSamplingRulesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetSamplingRulesPaginator) CurrentPage added in v0.23.2 

func (p *GetSamplingRulesPaginator) CurrentPage() *GetSamplingRulesOutput

type GetSamplingRulesRequest added in v0.23.2 

type GetSamplingRulesRequest struct {
	*aws.Request
	Input *GetSamplingRulesInput
	Copy  func(*GetSamplingRulesInput) GetSamplingRulesRequest
}

GetSamplingRulesRequest is the request type for the GetSamplingRules API operation.

func (GetSamplingRulesRequest) Send added in v0.23.2 

func (r GetSamplingRulesRequest) Send(ctx context.Context) (*GetSamplingRulesResponse, error)

Send marshals and sends the GetSamplingRules API request.

type GetSamplingRulesResponse added in v0.23.2 

type GetSamplingRulesResponse struct {
	*GetSamplingRulesOutput
	// contains filtered or unexported fields
}

GetSamplingRulesResponse is the response type for the GetSamplingRules API operation.

func (*GetSamplingRulesResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetSamplingRulesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSamplingRules request.

type GetSamplingStatisticSummariesInput added in v0.23.2 

type GetSamplingStatisticSummariesInput struct {

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

func (GetSamplingStatisticSummariesInput) MarshalFields added in v0.23.2 

func (s GetSamplingStatisticSummariesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSamplingStatisticSummariesInput) String added in v0.23.2 

func (s GetSamplingStatisticSummariesInput) String() string

String returns the string representation

type GetSamplingStatisticSummariesOutput added in v0.23.2 

type GetSamplingStatisticSummariesOutput struct {

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

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

func (GetSamplingStatisticSummariesOutput) MarshalFields added in v0.23.2 

func (s GetSamplingStatisticSummariesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSamplingStatisticSummariesOutput) String added in v0.23.2 

func (s GetSamplingStatisticSummariesOutput) String() string

String returns the string representation

type GetSamplingStatisticSummariesPaginator added in v0.23.2 

type GetSamplingStatisticSummariesPaginator struct {
	aws.Pager
}

GetSamplingStatisticSummariesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetSamplingStatisticSummariesPaginator added in v0.23.2 

func NewGetSamplingStatisticSummariesPaginator(req GetSamplingStatisticSummariesRequest) GetSamplingStatisticSummariesPaginator

NewGetSamplingStatisticSummariesRequestPaginator returns a paginator for GetSamplingStatisticSummaries. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetSamplingStatisticSummariesRequest(input)
p := xray.NewGetSamplingStatisticSummariesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetSamplingStatisticSummariesPaginator) CurrentPage added in v0.23.2 

func (p *GetSamplingStatisticSummariesPaginator) CurrentPage() *GetSamplingStatisticSummariesOutput

type GetSamplingStatisticSummariesRequest added in v0.23.2 

type GetSamplingStatisticSummariesRequest struct {
	*aws.Request
	Input *GetSamplingStatisticSummariesInput
	Copy  func(*GetSamplingStatisticSummariesInput) GetSamplingStatisticSummariesRequest
}

GetSamplingStatisticSummariesRequest is the request type for the GetSamplingStatisticSummaries API operation.

func (GetSamplingStatisticSummariesRequest) Send added in v0.23.2 

func (r GetSamplingStatisticSummariesRequest) Send(ctx context.Context) (*GetSamplingStatisticSummariesResponse, error)

Send marshals and sends the GetSamplingStatisticSummaries API request.

type GetSamplingStatisticSummariesResponse added in v0.23.2 

type GetSamplingStatisticSummariesResponse struct {
	*GetSamplingStatisticSummariesOutput
	// contains filtered or unexported fields
}

GetSamplingStatisticSummariesResponse is the response type for the GetSamplingStatisticSummaries API operation.

func (*GetSamplingStatisticSummariesResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetSamplingStatisticSummariesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSamplingStatisticSummaries request.

type GetSamplingTargetsInput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s GetSamplingTargetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSamplingTargetsInput) String added in v0.23.2 

func (s GetSamplingTargetsInput) String() string

String returns the string representation

func (*GetSamplingTargetsInput) Validate added in v0.23.2 

func (s *GetSamplingTargetsInput) Validate() error

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

type GetSamplingTargetsOutput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s GetSamplingTargetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetSamplingTargetsOutput) String added in v0.23.2 

func (s GetSamplingTargetsOutput) String() string

String returns the string representation

type GetSamplingTargetsRequest added in v0.23.2 

type GetSamplingTargetsRequest struct {
	*aws.Request
	Input *GetSamplingTargetsInput
	Copy  func(*GetSamplingTargetsInput) GetSamplingTargetsRequest
}

GetSamplingTargetsRequest is the request type for the GetSamplingTargets API operation.

func (GetSamplingTargetsRequest) Send added in v0.23.2 

func (r GetSamplingTargetsRequest) Send(ctx context.Context) (*GetSamplingTargetsResponse, error)

Send marshals and sends the GetSamplingTargets API request.

type GetSamplingTargetsResponse added in v0.23.2 

type GetSamplingTargetsResponse struct {
	*GetSamplingTargetsOutput
	// contains filtered or unexported fields
}

GetSamplingTargetsResponse is the response type for the GetSamplingTargets API operation.

func (*GetSamplingTargetsResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetSamplingTargetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSamplingTargets request.

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.
	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) MarshalFields added in v0.3.0 

func (s GetServiceGraphInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetServiceGraphInput) String 

func (s GetServiceGraphInput) String() string

String returns the string representation

func (*GetServiceGraphInput) Validate 

func (s *GetServiceGraphInput) Validate() error

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

type GetServiceGraphOutput 

type GetServiceGraphOutput struct {

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

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

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

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

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

func (GetServiceGraphOutput) MarshalFields added in v0.3.0 

func (s GetServiceGraphOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetServiceGraphOutput) String 

func (s GetServiceGraphOutput) String() string

String returns the string representation

type GetServiceGraphPaginator added in v0.23.2 

type GetServiceGraphPaginator struct {
	aws.Pager
}

GetServiceGraphPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetServiceGraphPaginator added in v0.23.2 

func NewGetServiceGraphPaginator(req GetServiceGraphRequest) GetServiceGraphPaginator

NewGetServiceGraphRequestPaginator returns a paginator for GetServiceGraph. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetServiceGraphRequest(input)
p := xray.NewGetServiceGraphRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetServiceGraphPaginator) CurrentPage added in v0.23.2 

func (p *GetServiceGraphPaginator) CurrentPage() *GetServiceGraphOutput

type GetServiceGraphRequest 

type GetServiceGraphRequest struct {
	*aws.Request
	Input *GetServiceGraphInput
	Copy  func(*GetServiceGraphInput) GetServiceGraphRequest
}

GetServiceGraphRequest is the request type for the GetServiceGraph API operation.

func (GetServiceGraphRequest) Send 

func (r GetServiceGraphRequest) Send(ctx context.Context) (*GetServiceGraphResponse, error)

Send marshals and sends the GetServiceGraph API request.

type GetServiceGraphResponse added in v0.23.2 

type GetServiceGraphResponse struct {
	*GetServiceGraphOutput
	// contains filtered or unexported fields
}

GetServiceGraphResponse is the response type for the GetServiceGraph API operation.

func (*GetServiceGraphResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetServiceGraphResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetServiceGraph request.

type GetTimeSeriesServiceStatisticsInput added in v0.23.2 

type GetTimeSeriesServiceStatisticsInput struct {

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

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

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

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

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

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

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

func (GetTimeSeriesServiceStatisticsInput) MarshalFields added in v0.23.2 

func (s GetTimeSeriesServiceStatisticsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetTimeSeriesServiceStatisticsInput) String added in v0.23.2 

func (s GetTimeSeriesServiceStatisticsInput) String() string

String returns the string representation

func (*GetTimeSeriesServiceStatisticsInput) Validate added in v0.23.2 

func (s *GetTimeSeriesServiceStatisticsInput) Validate() error

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

type GetTimeSeriesServiceStatisticsOutput added in v0.23.2 

type GetTimeSeriesServiceStatisticsOutput struct {

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

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

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

func (GetTimeSeriesServiceStatisticsOutput) MarshalFields added in v0.23.2 

func (s GetTimeSeriesServiceStatisticsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetTimeSeriesServiceStatisticsOutput) String added in v0.23.2 

func (s GetTimeSeriesServiceStatisticsOutput) String() string

String returns the string representation

type GetTimeSeriesServiceStatisticsPaginator added in v0.23.2 

type GetTimeSeriesServiceStatisticsPaginator struct {
	aws.Pager
}

GetTimeSeriesServiceStatisticsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetTimeSeriesServiceStatisticsPaginator added in v0.23.2 

func NewGetTimeSeriesServiceStatisticsPaginator(req GetTimeSeriesServiceStatisticsRequest) GetTimeSeriesServiceStatisticsPaginator

NewGetTimeSeriesServiceStatisticsRequestPaginator returns a paginator for GetTimeSeriesServiceStatistics. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetTimeSeriesServiceStatisticsRequest(input)
p := xray.NewGetTimeSeriesServiceStatisticsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetTimeSeriesServiceStatisticsPaginator) CurrentPage added in v0.23.2 

func (p *GetTimeSeriesServiceStatisticsPaginator) CurrentPage() *GetTimeSeriesServiceStatisticsOutput

type GetTimeSeriesServiceStatisticsRequest added in v0.23.2 

type GetTimeSeriesServiceStatisticsRequest struct {
	*aws.Request
	Input *GetTimeSeriesServiceStatisticsInput
	Copy  func(*GetTimeSeriesServiceStatisticsInput) GetTimeSeriesServiceStatisticsRequest
}

GetTimeSeriesServiceStatisticsRequest is the request type for the GetTimeSeriesServiceStatistics API operation.

func (GetTimeSeriesServiceStatisticsRequest) Send added in v0.23.2 

func (r GetTimeSeriesServiceStatisticsRequest) Send(ctx context.Context) (*GetTimeSeriesServiceStatisticsResponse, error)

Send marshals and sends the GetTimeSeriesServiceStatistics API request.

type GetTimeSeriesServiceStatisticsResponse added in v0.23.2 

type GetTimeSeriesServiceStatisticsResponse struct {
	*GetTimeSeriesServiceStatisticsOutput
	// contains filtered or unexported fields
}

GetTimeSeriesServiceStatisticsResponse is the response type for the GetTimeSeriesServiceStatistics API operation.

func (*GetTimeSeriesServiceStatisticsResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetTimeSeriesServiceStatisticsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTimeSeriesServiceStatistics request.

type GetTraceGraphInput 

type GetTraceGraphInput struct {

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

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

func (GetTraceGraphInput) MarshalFields added in v0.3.0 

func (s GetTraceGraphInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetTraceGraphInput) String 

func (s GetTraceGraphInput) String() string

String returns the string representation

func (*GetTraceGraphInput) Validate 

func (s *GetTraceGraphInput) Validate() error

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

type GetTraceGraphOutput 

type GetTraceGraphOutput struct {

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

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

func (GetTraceGraphOutput) MarshalFields added in v0.3.0 

func (s GetTraceGraphOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetTraceGraphOutput) String 

func (s GetTraceGraphOutput) String() string

String returns the string representation

type GetTraceGraphPaginator added in v0.23.2 

type GetTraceGraphPaginator struct {
	aws.Pager
}

GetTraceGraphPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetTraceGraphPaginator added in v0.23.2 

func NewGetTraceGraphPaginator(req GetTraceGraphRequest) GetTraceGraphPaginator

NewGetTraceGraphRequestPaginator returns a paginator for GetTraceGraph. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetTraceGraphRequest(input)
p := xray.NewGetTraceGraphRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetTraceGraphPaginator) CurrentPage added in v0.23.2 

func (p *GetTraceGraphPaginator) CurrentPage() *GetTraceGraphOutput

type GetTraceGraphRequest 

type GetTraceGraphRequest struct {
	*aws.Request
	Input *GetTraceGraphInput
	Copy  func(*GetTraceGraphInput) GetTraceGraphRequest
}

GetTraceGraphRequest is the request type for the GetTraceGraph API operation.

func (GetTraceGraphRequest) Send 

func (r GetTraceGraphRequest) Send(ctx context.Context) (*GetTraceGraphResponse, error)

Send marshals and sends the GetTraceGraph API request.

type GetTraceGraphResponse added in v0.23.2 

type GetTraceGraphResponse struct {
	*GetTraceGraphOutput
	// contains filtered or unexported fields
}

GetTraceGraphResponse is the response type for the GetTraceGraph API operation.

func (*GetTraceGraphResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetTraceGraphResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTraceGraph request.

type GetTraceSummariesInput 

type GetTraceSummariesInput struct {

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

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

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

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

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

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

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

func (GetTraceSummariesInput) MarshalFields added in v0.3.0 

func (s GetTraceSummariesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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 annotations for traces that were found in the specified time
	// frame.
	TraceSummaries []TraceSummary `type:"list"`

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

func (GetTraceSummariesOutput) MarshalFields added in v0.3.0 

func (s GetTraceSummariesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetTraceSummariesOutput) String 

func (s GetTraceSummariesOutput) String() string

String returns the string representation

type GetTraceSummariesPaginator added in v0.23.2 

type GetTraceSummariesPaginator struct {
	aws.Pager
}

GetTraceSummariesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetTraceSummariesPaginator added in v0.23.2 

func NewGetTraceSummariesPaginator(req GetTraceSummariesRequest) GetTraceSummariesPaginator

NewGetTraceSummariesRequestPaginator returns a paginator for GetTraceSummaries. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.GetTraceSummariesRequest(input)
p := xray.NewGetTraceSummariesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetTraceSummariesPaginator) CurrentPage added in v0.23.2 

func (p *GetTraceSummariesPaginator) CurrentPage() *GetTraceSummariesOutput

type GetTraceSummariesRequest 

type GetTraceSummariesRequest struct {
	*aws.Request
	Input *GetTraceSummariesInput
	Copy  func(*GetTraceSummariesInput) GetTraceSummariesRequest
}

GetTraceSummariesRequest is the request type for the GetTraceSummaries API operation.

func (GetTraceSummariesRequest) Send 

func (r GetTraceSummariesRequest) Send(ctx context.Context) (*GetTraceSummariesResponse, error)

Send marshals and sends the GetTraceSummaries API request.

type GetTraceSummariesResponse added in v0.23.2 

type GetTraceSummariesResponse struct {
	*GetTraceSummariesOutput
	// contains filtered or unexported fields
}

GetTraceSummariesResponse is the response type for the GetTraceSummaries API operation.

func (*GetTraceSummariesResponse) SDKResponseMetdata added in v0.23.2 

func (r *GetTraceSummariesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTraceSummaries request.

type Group added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s Group) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Group) String added in v0.23.2 

func (s Group) String() string

String returns the string representation

type GroupSummary added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s GroupSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GroupSummary) String added in v0.23.2 

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) MarshalFields added in v0.3.0 

func (s HistogramEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s Http) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Http) String 

func (s Http) String() string

String returns the string representation

type InstanceIdDetail added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s InstanceIdDetail) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (InstanceIdDetail) String added in v0.23.2 

func (s InstanceIdDetail) String() string

String returns the string representation

type PutEncryptionConfigInput added in v0.4.0 

type PutEncryptionConfigInput struct {

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

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

func (PutEncryptionConfigInput) MarshalFields added in v0.4.0 

func (s PutEncryptionConfigInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEncryptionConfigInput) String added in v0.4.0 

func (s PutEncryptionConfigInput) String() string

String returns the string representation

func (*PutEncryptionConfigInput) Validate added in v0.4.0 

func (s *PutEncryptionConfigInput) Validate() error

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

type PutEncryptionConfigOutput added in v0.4.0 

type PutEncryptionConfigOutput struct {

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

func (PutEncryptionConfigOutput) MarshalFields added in v0.4.0 

func (s PutEncryptionConfigOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEncryptionConfigOutput) String added in v0.4.0 

func (s PutEncryptionConfigOutput) String() string

String returns the string representation

type PutEncryptionConfigRequest added in v0.4.0 

type PutEncryptionConfigRequest struct {
	*aws.Request
	Input *PutEncryptionConfigInput
	Copy  func(*PutEncryptionConfigInput) PutEncryptionConfigRequest
}

PutEncryptionConfigRequest is the request type for the PutEncryptionConfig API operation.

func (PutEncryptionConfigRequest) Send added in v0.4.0 

func (r PutEncryptionConfigRequest) Send(ctx context.Context) (*PutEncryptionConfigResponse, error)

Send marshals and sends the PutEncryptionConfig API request.

type PutEncryptionConfigResponse added in v0.23.2 

type PutEncryptionConfigResponse struct {
	*PutEncryptionConfigOutput
	// contains filtered or unexported fields
}

PutEncryptionConfigResponse is the response type for the PutEncryptionConfig API operation.

func (*PutEncryptionConfigResponse) SDKResponseMetdata added in v0.23.2 

func (r *PutEncryptionConfigResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutEncryptionConfig request.

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) MarshalFields added in v0.3.0 

func (s PutTelemetryRecordsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s PutTelemetryRecordsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutTelemetryRecordsOutput) String 

func (s PutTelemetryRecordsOutput) String() string

String returns the string representation

type PutTelemetryRecordsRequest 

type PutTelemetryRecordsRequest struct {
	*aws.Request
	Input *PutTelemetryRecordsInput
	Copy  func(*PutTelemetryRecordsInput) PutTelemetryRecordsRequest
}

PutTelemetryRecordsRequest is the request type for the PutTelemetryRecords API operation.

func (PutTelemetryRecordsRequest) Send 

func (r PutTelemetryRecordsRequest) Send(ctx context.Context) (*PutTelemetryRecordsResponse, error)

Send marshals and sends the PutTelemetryRecords API request.

type PutTelemetryRecordsResponse added in v0.23.2 

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

PutTelemetryRecordsResponse is the response type for the PutTelemetryRecords API operation.

func (*PutTelemetryRecordsResponse) SDKResponseMetdata added in v0.23.2 

func (r *PutTelemetryRecordsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutTelemetryRecords request.

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) MarshalFields added in v0.3.0 

func (s PutTraceSegmentsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s PutTraceSegmentsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutTraceSegmentsOutput) String 

func (s PutTraceSegmentsOutput) String() string

String returns the string representation

type PutTraceSegmentsRequest 

type PutTraceSegmentsRequest struct {
	*aws.Request
	Input *PutTraceSegmentsInput
	Copy  func(*PutTraceSegmentsInput) PutTraceSegmentsRequest
}

PutTraceSegmentsRequest is the request type for the PutTraceSegments API operation.

func (PutTraceSegmentsRequest) Send 

func (r PutTraceSegmentsRequest) Send(ctx context.Context) (*PutTraceSegmentsResponse, error)

Send marshals and sends the PutTraceSegments API request.

type PutTraceSegmentsResponse added in v0.23.2 

type PutTraceSegmentsResponse struct {
	*PutTraceSegmentsOutput
	// contains filtered or unexported fields
}

PutTraceSegmentsResponse is the response type for the PutTraceSegments API operation.

func (*PutTraceSegmentsResponse) SDKResponseMetdata added in v0.23.2 

func (r *PutTraceSegmentsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutTraceSegments request.

type ResourceARNDetail added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s ResourceARNDetail) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResourceARNDetail) String added in v0.23.2 

func (s ResourceARNDetail) String() string

String returns the string representation

type ResponseTimeRootCause added in v0.23.2 

type ResponseTimeRootCause struct {

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

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

The root cause information for a response time warning.

func (ResponseTimeRootCause) MarshalFields added in v0.23.2 

func (s ResponseTimeRootCause) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResponseTimeRootCause) String added in v0.23.2 

func (s ResponseTimeRootCause) String() string

String returns the string representation

type ResponseTimeRootCauseEntity added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s ResponseTimeRootCauseEntity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResponseTimeRootCauseEntity) String added in v0.23.2 

func (s ResponseTimeRootCauseEntity) String() string

String returns the string representation

type ResponseTimeRootCauseService added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s ResponseTimeRootCauseService) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResponseTimeRootCauseService) String added in v0.23.2 

func (s ResponseTimeRootCauseService) String() string

String returns the string representation

type RootCauseException added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s RootCauseException) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RootCauseException) String added in v0.23.2 

func (s RootCauseException) String() string

String returns the string representation

type SamplingRule added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s SamplingRule) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SamplingRule) String added in v0.23.2 

func (s SamplingRule) String() string

String returns the string representation

func (*SamplingRule) Validate added in v0.23.2 

func (s *SamplingRule) Validate() error

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

type SamplingRuleRecord added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s SamplingRuleRecord) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SamplingRuleRecord) String added in v0.23.2 

func (s SamplingRuleRecord) String() string

String returns the string representation

type SamplingRuleUpdate added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s SamplingRuleUpdate) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SamplingRuleUpdate) String added in v0.23.2 

func (s SamplingRuleUpdate) String() string

String returns the string representation

func (*SamplingRuleUpdate) Validate added in v0.23.2 

func (s *SamplingRuleUpdate) Validate() error

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

type SamplingStatisticSummary added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s SamplingStatisticSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SamplingStatisticSummary) String added in v0.23.2 

func (s SamplingStatisticSummary) String() string

String returns the string representation

type SamplingStatisticsDocument added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s SamplingStatisticsDocument) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SamplingStatisticsDocument) String added in v0.23.2 

func (s SamplingStatisticsDocument) String() string

String returns the string representation

func (*SamplingStatisticsDocument) Validate added in v0.23.2 

func (s *SamplingStatisticsDocument) Validate() error

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

type SamplingStrategy added in v0.23.2 

type SamplingStrategy struct {

	// The name of a sampling rule.
	Name SamplingStrategyName `type:"string" enum:"true"`

	// The value of a sampling rule.
	Value *float64 `type:"double"`
	// contains filtered or unexported fields
}

The name and value of a sampling rule to apply to a trace summary.

func (SamplingStrategy) MarshalFields added in v0.23.2 

func (s SamplingStrategy) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SamplingStrategy) String added in v0.23.2 

func (s SamplingStrategy) String() string

String returns the string representation

type SamplingStrategyName added in v0.23.2 

type SamplingStrategyName string
const (
	SamplingStrategyNamePartialScan SamplingStrategyName = "PartialScan"
	SamplingStrategyNameFixedRate   SamplingStrategyName = "FixedRate"
)

Enum values for SamplingStrategyName

func (SamplingStrategyName) MarshalValue added in v0.23.2 

func (enum SamplingStrategyName) MarshalValue() (string, error)

func (SamplingStrategyName) MarshalValueBuf added in v0.23.2 

func (enum SamplingStrategyName) MarshalValueBuf(b []byte) ([]byte, error)

type SamplingTargetDocument added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s SamplingTargetDocument) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SamplingTargetDocument) String added in v0.23.2 

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) MarshalFields added in v0.3.0 

func (s Segment) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s Service) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s ServiceId) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s ServiceStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s TelemetryRecord) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TelemetryRecord) String 

func (s TelemetryRecord) String() string

String returns the string representation

func (*TelemetryRecord) Validate added in v0.2.0 

func (s *TelemetryRecord) Validate() error

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

type TimeRangeType added in v0.23.2 

type TimeRangeType string
const (
	TimeRangeTypeTraceId TimeRangeType = "TraceId"
	TimeRangeTypeEvent   TimeRangeType = "Event"
)

Enum values for TimeRangeType

func (TimeRangeType) MarshalValue added in v0.23.2 

func (enum TimeRangeType) MarshalValue() (string, error)

func (TimeRangeType) MarshalValueBuf added in v0.23.2 

func (enum TimeRangeType) MarshalValueBuf(b []byte) ([]byte, error)

type TimeSeriesServiceStatistics added in v0.23.2 

type TimeSeriesServiceStatistics struct {

	// Response statistics for an edge.
	EdgeSummaryStatistics *EdgeStatistics `type:"structure"`

	// The response time histogram for the selected entities.
	ResponseTimeHistogram []HistogramEntry `type:"list"`

	// Response statistics for a service.
	ServiceSummaryStatistics *ServiceStatistics `type:"structure"`

	// Timestamp of the window for which statistics are aggregated.
	Timestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A list of TimeSeriesStatistic structures.

func (TimeSeriesServiceStatistics) MarshalFields added in v0.23.2 

func (s TimeSeriesServiceStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TimeSeriesServiceStatistics) String added in v0.23.2 

func (s TimeSeriesServiceStatistics) String() string

String returns the string representation

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) MarshalFields added in v0.3.0 

func (s Trace) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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

	// The root segment document has a 400 series error.
	HasError *bool `type:"boolean"`

	// The root segment document 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"`

	// The matched time stamp of a defined event.
	MatchedEventTime *time.Time `type:"timestamp"`

	// 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) MarshalFields added in v0.3.0 

func (s TraceSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields added in v0.3.0 

func (s TraceUser) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TraceUser) String 

func (s TraceUser) String() string

String returns the string representation

type UnprocessedStatistics added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s UnprocessedStatistics) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UnprocessedStatistics) String added in v0.23.2 

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) MarshalFields added in v0.3.0 

func (s UnprocessedTraceSegment) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UnprocessedTraceSegment) String 

func (s UnprocessedTraceSegment) String() string

String returns the string representation

type UpdateGroupInput added in v0.23.2 

type UpdateGroupInput struct {

	// The updated filter expression defining criteria by which to group traces.
	FilterExpression *string `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) MarshalFields added in v0.23.2 

func (s UpdateGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGroupInput) String added in v0.23.2 

func (s UpdateGroupInput) String() string

String returns the string representation

func (*UpdateGroupInput) Validate added in v0.23.2 

func (s *UpdateGroupInput) Validate() error

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

type UpdateGroupOutput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s UpdateGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGroupOutput) String added in v0.23.2 

func (s UpdateGroupOutput) String() string

String returns the string representation

type UpdateGroupRequest added in v0.23.2 

type UpdateGroupRequest struct {
	*aws.Request
	Input *UpdateGroupInput
	Copy  func(*UpdateGroupInput) UpdateGroupRequest
}

UpdateGroupRequest is the request type for the UpdateGroup API operation.

func (UpdateGroupRequest) Send added in v0.23.2 

func (r UpdateGroupRequest) Send(ctx context.Context) (*UpdateGroupResponse, error)

Send marshals and sends the UpdateGroup API request.

type UpdateGroupResponse added in v0.23.2 

type UpdateGroupResponse struct {
	*UpdateGroupOutput
	// contains filtered or unexported fields
}

UpdateGroupResponse is the response type for the UpdateGroup API operation.

func (*UpdateGroupResponse) SDKResponseMetdata added in v0.23.2 

func (r *UpdateGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateGroup request.

type UpdateSamplingRuleInput added in v0.23.2 

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) MarshalFields added in v0.23.2 

func (s UpdateSamplingRuleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateSamplingRuleInput) String added in v0.23.2 

func (s UpdateSamplingRuleInput) String() string

String returns the string representation

func (*UpdateSamplingRuleInput) Validate added in v0.23.2 

func (s *UpdateSamplingRuleInput) Validate() error

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

type UpdateSamplingRuleOutput added in v0.23.2 

type UpdateSamplingRuleOutput struct {

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

func (UpdateSamplingRuleOutput) MarshalFields added in v0.23.2 

func (s UpdateSamplingRuleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateSamplingRuleOutput) String added in v0.23.2 

func (s UpdateSamplingRuleOutput) String() string

String returns the string representation

type UpdateSamplingRuleRequest added in v0.23.2 

type UpdateSamplingRuleRequest struct {
	*aws.Request
	Input *UpdateSamplingRuleInput
	Copy  func(*UpdateSamplingRuleInput) UpdateSamplingRuleRequest
}

UpdateSamplingRuleRequest is the request type for the UpdateSamplingRule API operation.

func (UpdateSamplingRuleRequest) Send added in v0.23.2 

func (r UpdateSamplingRuleRequest) Send(ctx context.Context) (*UpdateSamplingRuleResponse, error)

Send marshals and sends the UpdateSamplingRule API request.

type UpdateSamplingRuleResponse added in v0.23.2 

type UpdateSamplingRuleResponse struct {
	*UpdateSamplingRuleOutput
	// contains filtered or unexported fields
}

UpdateSamplingRuleResponse is the response type for the UpdateSamplingRule API operation.

func (*UpdateSamplingRuleResponse) SDKResponseMetdata added in v0.23.2 

func (r *UpdateSamplingRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateSamplingRule request.

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) MarshalFields added in v0.3.0 

func (s ValueWithServiceIds) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ValueWithServiceIds) String 

func (s ValueWithServiceIds) String() string

String returns the string representation

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.