xray

package module
v1.16.1 Latest Latest
Warning

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

 Go to latest Published: Jan 23, 2023 License: Apache-2.0 Imports: 32 Imported by: 50

Documentation

Overview

Package xray provides the API client, operations, and parameter types for AWS X-Ray.

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

Index

Constants

View Source 
const ServiceAPIVersion = "2016-04-12"
View Source 
const ServiceID = "XRay"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type BatchGetTracesAPIClient added in v0.30.0 

type BatchGetTracesAPIClient interface {
	BatchGetTraces(context.Context, *BatchGetTracesInput, ...func(*Options)) (*BatchGetTracesOutput, error)
}

BatchGetTracesAPIClient is a client that implements the BatchGetTraces operation.

type BatchGetTracesInput 

type BatchGetTracesInput struct {

	// Specify the trace IDs of requests for which to retrieve segments.
	//
	// This member is required.
	TraceIds []string

	// Pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

type BatchGetTracesOutput 

type BatchGetTracesOutput struct {

	// Pagination token.
	NextToken *string

	// Full traces for the specified requests.
	Traces []types.Trace

	// Trace IDs of requests that haven't been processed.
	UnprocessedTraceIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetTracesPaginator added in v0.30.0 

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

BatchGetTracesPaginator is a paginator for BatchGetTraces

func NewBatchGetTracesPaginator added in v0.30.0 

func NewBatchGetTracesPaginator(client BatchGetTracesAPIClient, params *BatchGetTracesInput, optFns ...func(*BatchGetTracesPaginatorOptions)) *BatchGetTracesPaginator

NewBatchGetTracesPaginator returns a new BatchGetTracesPaginator

func (*BatchGetTracesPaginator) HasMorePages added in v0.30.0 

func (p *BatchGetTracesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*BatchGetTracesPaginator) NextPage added in v0.30.0 

func (p *BatchGetTracesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*BatchGetTracesOutput, error)

NextPage retrieves the next BatchGetTraces page.

type BatchGetTracesPaginatorOptions added in v0.30.0 

type BatchGetTracesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

BatchGetTracesPaginatorOptions is the paginator options for BatchGetTraces

type Client 

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

Client provides the API client to make operations call for AWS X-Ray.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchGetTraces 

func (c *Client) BatchGetTraces(ctx context.Context, params *BatchGetTracesInput, optFns ...func(*Options)) (*BatchGetTracesOutput, error)

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.

func (*Client) CreateGroup 

func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)

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

func (*Client) CreateSamplingRule 

func (c *Client) CreateSamplingRule(ctx context.Context, params *CreateSamplingRuleInput, optFns ...func(*Options)) (*CreateSamplingRuleOutput, error)

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html), 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 (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html) 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.

func (*Client) DeleteGroup 

func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)

Deletes a group resource.

func (*Client) DeleteResourcePolicy added in v1.15.0 

func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error)

Deletes a resource policy from the target Amazon Web Services account.

func (*Client) DeleteSamplingRule 

func (c *Client) DeleteSamplingRule(ctx context.Context, params *DeleteSamplingRuleInput, optFns ...func(*Options)) (*DeleteSamplingRuleOutput, error)

Deletes a sampling rule.

func (*Client) GetEncryptionConfig 

func (c *Client) GetEncryptionConfig(ctx context.Context, params *GetEncryptionConfigInput, optFns ...func(*Options)) (*GetEncryptionConfigOutput, error)

Retrieves the current encryption configuration for X-Ray data.

func (*Client) GetGroup 

func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error)

Retrieves group resource details.

func (*Client) GetGroups 

func (c *Client) GetGroups(ctx context.Context, params *GetGroupsInput, optFns ...func(*Options)) (*GetGroupsOutput, error)

Retrieves all active group details.

func (*Client) GetInsight added in v0.30.0 

func (c *Client) GetInsight(ctx context.Context, params *GetInsightInput, optFns ...func(*Options)) (*GetInsightOutput, error)

Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

func (*Client) GetInsightEvents added in v0.30.0 

func (c *Client) GetInsightEvents(ctx context.Context, params *GetInsightEventsInput, optFns ...func(*Options)) (*GetInsightEventsOutput, error)

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

func (*Client) GetInsightImpactGraph added in v0.30.0 

func (c *Client) GetInsightImpactGraph(ctx context.Context, params *GetInsightImpactGraphInput, optFns ...func(*Options)) (*GetInsightImpactGraphOutput, error)

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

func (*Client) GetInsightSummaries added in v0.30.0 

func (c *Client) GetInsightSummaries(ctx context.Context, params *GetInsightSummariesInput, optFns ...func(*Options)) (*GetInsightSummariesOutput, error)

Retrieves the summaries of all insights in the specified group matching the provided filter values.

func (*Client) GetSamplingRules 

func (c *Client) GetSamplingRules(ctx context.Context, params *GetSamplingRulesInput, optFns ...func(*Options)) (*GetSamplingRulesOutput, error)

Retrieves all sampling rules.

func (*Client) GetSamplingStatisticSummaries 

func (c *Client) GetSamplingStatisticSummaries(ctx context.Context, params *GetSamplingStatisticSummariesInput, optFns ...func(*Options)) (*GetSamplingStatisticSummariesOutput, error)

Retrieves information about recent sampling results for all sampling rules.

func (*Client) GetSamplingTargets 

func (c *Client) GetSamplingTargets(ctx context.Context, params *GetSamplingTargetsInput, optFns ...func(*Options)) (*GetSamplingTargetsOutput, error)

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

func (*Client) GetServiceGraph 

func (c *Client) GetServiceGraph(ctx context.Context, params *GetServiceGraphInput, optFns ...func(*Options)) (*GetServiceGraphOutput, error)

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 Amazon Web Services X-Ray SDK (https://docs.aws.amazon.com/xray/index.html). Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

func (*Client) GetTimeSeriesServiceStatistics 

func (c *Client) GetTimeSeriesServiceStatistics(ctx context.Context, params *GetTimeSeriesServiceStatisticsInput, optFns ...func(*Options)) (*GetTimeSeriesServiceStatisticsOutput, error)

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

func (*Client) GetTraceGraph 

func (c *Client) GetTraceGraph(ctx context.Context, params *GetTraceGraphInput, optFns ...func(*Options)) (*GetTraceGraphOutput, error)

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

func (*Client) GetTraceSummaries 

func (c *Client) GetTraceSummaries(ctx context.Context, params *GetTraceSummariesInput, optFns ...func(*Options)) (*GetTraceSummariesOutput, error)

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 Amazon Web Services X-Ray Developer Guide.

func (*Client) ListResourcePolicies added in v1.15.0 

func (c *Client) ListResourcePolicies(ctx context.Context, params *ListResourcePoliciesInput, optFns ...func(*Options)) (*ListResourcePoliciesOutput, error)

Returns the list of resource policies in the target Amazon Web Services account.

func (*Client) ListTagsForResource added in v0.29.0 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

func (*Client) PutEncryptionConfig 

func (c *Client) PutEncryptionConfig(ctx context.Context, params *PutEncryptionConfigInput, optFns ...func(*Options)) (*PutEncryptionConfigOutput, error)

Updates the encryption configuration for X-Ray data.

func (*Client) PutResourcePolicy added in v1.15.0 

func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

func (*Client) PutTelemetryRecords 

func (c *Client) PutTelemetryRecords(ctx context.Context, params *PutTelemetryRecordsInput, optFns ...func(*Options)) (*PutTelemetryRecordsOutput, error)

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

func (*Client) PutTraceSegments 

func (c *Client) PutTraceSegments(ctx context.Context, params *PutTraceSegmentsInput, optFns ...func(*Options)) (*PutTraceSegmentsOutput, error)

Uploads segment documents to Amazon Web Services 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 Amazon Web Services X-Ray Segment Documents (https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) in the Amazon Web Services 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 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, for instance, 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.

func (*Client) TagResource added in v0.29.0 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

func (*Client) UntagResource added in v0.29.0 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

func (*Client) UpdateGroup 

func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)

Updates a group resource.

func (*Client) UpdateSamplingRule 

func (c *Client) UpdateSamplingRule(ctx context.Context, params *UpdateSamplingRuleInput, optFns ...func(*Options)) (*UpdateSamplingRuleOutput, error)

Modifies a sampling rule's configuration.

type CreateGroupInput 

type CreateGroupInput struct {

	// The case-sensitive name of the new group. Default is a reserved name and names
	// must be unique.
	//
	// This member is required.
	GroupName *string

	// The filter expression defining criteria by which to group traces.
	FilterExpression *string

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

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

type CreateGroupOutput 

type CreateGroupOutput struct {

	// The group that was created. Contains the name of the group that was created, the
	// Amazon Resource Name (ARN) of the group that was generated based on the group
	// name, the filter expression, and the insight configuration that was assigned to
	// the group.
	Group *types.Group

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSamplingRuleInput 

type CreateSamplingRuleInput struct {

	// The rule definition.
	//
	// This member is required.
	SamplingRule *types.SamplingRule

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

type CreateSamplingRuleOutput 

type CreateSamplingRuleOutput struct {

	// The saved rule definition and metadata.
	SamplingRuleRecord *types.SamplingRuleRecord

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGroupInput 

type DeleteGroupInput struct {

	// The ARN of the group that was generated on creation.
	GroupARN *string

	// The case-sensitive name of the group.
	GroupName *string
	// contains filtered or unexported fields
}

type DeleteGroupOutput 

type DeleteGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteResourcePolicyInput added in v1.15.0 

type DeleteResourcePolicyInput struct {

	// The name of the resource policy to delete.
	//
	// This member is required.
	PolicyName *string

	// Specifies a specific policy revision to delete. Provide a PolicyRevisionId to
	// ensure an atomic delete operation. If the provided revision id does not match
	// the latest policy revision id, an InvalidPolicyRevisionIdException exception is
	// returned.
	PolicyRevisionId *string
	// contains filtered or unexported fields
}

type DeleteResourcePolicyOutput added in v1.15.0 

type DeleteResourcePolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSamplingRuleInput 

type DeleteSamplingRuleInput struct {

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

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

type DeleteSamplingRuleOutput 

type DeleteSamplingRuleOutput struct {

	// The deleted rule definition and metadata.
	SamplingRuleRecord *types.SamplingRuleRecord

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetEncryptionConfigInput 

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

type GetEncryptionConfigOutput 

type GetEncryptionConfigOutput struct {

	// The encryption configuration document.
	EncryptionConfig *types.EncryptionConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGroupInput 

type GetGroupInput struct {

	// The ARN of the group that was generated on creation.
	GroupARN *string

	// The case-sensitive name of the group.
	GroupName *string
	// contains filtered or unexported fields
}

type GetGroupOutput 

type GetGroupOutput struct {

	// The group that was requested. Contains the name of the group, the ARN of the
	// group, the filter expression, and the insight configuration assigned to the
	// group.
	Group *types.Group

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGroupsAPIClient added in v0.30.0 

type GetGroupsAPIClient interface {
	GetGroups(context.Context, *GetGroupsInput, ...func(*Options)) (*GetGroupsOutput, error)
}

GetGroupsAPIClient is a client that implements the GetGroups operation.

type GetGroupsInput 

type GetGroupsInput struct {

	// Pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

type GetGroupsOutput 

type GetGroupsOutput struct {

	// The collection of all active groups.
	Groups []types.GroupSummary

	// Pagination token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGroupsPaginator added in v0.30.0 

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

GetGroupsPaginator is a paginator for GetGroups

func NewGetGroupsPaginator added in v0.30.0 

func NewGetGroupsPaginator(client GetGroupsAPIClient, params *GetGroupsInput, optFns ...func(*GetGroupsPaginatorOptions)) *GetGroupsPaginator

NewGetGroupsPaginator returns a new GetGroupsPaginator

func (*GetGroupsPaginator) HasMorePages added in v0.30.0 

func (p *GetGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetGroupsPaginator) NextPage added in v0.30.0 

func (p *GetGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetGroupsOutput, error)

NextPage retrieves the next GetGroups page.

type GetGroupsPaginatorOptions added in v0.30.0 

type GetGroupsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetGroupsPaginatorOptions is the paginator options for GetGroups

type GetInsightEventsAPIClient added in v0.30.0 

type GetInsightEventsAPIClient interface {
	GetInsightEvents(context.Context, *GetInsightEventsInput, ...func(*Options)) (*GetInsightEventsOutput, error)
}

GetInsightEventsAPIClient is a client that implements the GetInsightEvents operation.

type GetInsightEventsInput added in v0.30.0 

type GetInsightEventsInput struct {

	// The insight's unique identifier. Use the GetInsightSummaries action to retrieve
	// an InsightId.
	//
	// This member is required.
	InsightId *string

	// Used to retrieve at most the specified value of events.
	MaxResults *int32

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

type GetInsightEventsOutput added in v0.30.0 

type GetInsightEventsOutput struct {

	// A detailed description of the event. This includes the time of the event, client
	// and root cause impact statistics, and the top anomalous service at the time of
	// the event.
	InsightEvents []types.InsightEvent

	// Use this token to retrieve the next page of insight events.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetInsightEventsPaginator added in v0.30.0 

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

GetInsightEventsPaginator is a paginator for GetInsightEvents

func NewGetInsightEventsPaginator added in v0.30.0 

func NewGetInsightEventsPaginator(client GetInsightEventsAPIClient, params *GetInsightEventsInput, optFns ...func(*GetInsightEventsPaginatorOptions)) *GetInsightEventsPaginator

NewGetInsightEventsPaginator returns a new GetInsightEventsPaginator

func (*GetInsightEventsPaginator) HasMorePages added in v0.30.0 

func (p *GetInsightEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetInsightEventsPaginator) NextPage added in v0.30.0 

func (p *GetInsightEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInsightEventsOutput, error)

NextPage retrieves the next GetInsightEvents page.

type GetInsightEventsPaginatorOptions added in v0.30.0 

type GetInsightEventsPaginatorOptions struct {
	// Used to retrieve at most the specified value of events.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetInsightEventsPaginatorOptions is the paginator options for GetInsightEvents

type GetInsightImpactGraphInput added in v0.30.0 

type GetInsightImpactGraphInput struct {

	// The estimated end time of the insight, in Unix time seconds. The EndTime is
	// exclusive of the value provided. The time range between the start time and end
	// time can't be more than six hours.
	//
	// This member is required.
	EndTime *time.Time

	// The insight's unique identifier. Use the GetInsightSummaries action to retrieve
	// an InsightId.
	//
	// This member is required.
	InsightId *string

	// The estimated start time of the insight, in Unix time seconds. The StartTime is
	// inclusive of the value provided and can't be more than 30 days old.
	//
	// This member is required.
	StartTime *time.Time

	// Specify the pagination token returned by a previous request to retrieve the next
	// page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetInsightImpactGraphOutput added in v0.30.0 

type GetInsightImpactGraphOutput struct {

	// The provided end time.
	EndTime *time.Time

	// The insight's unique identifier.
	InsightId *string

	// Pagination token.
	NextToken *string

	// The time, in Unix seconds, at which the service graph ended.
	ServiceGraphEndTime *time.Time

	// The time, in Unix seconds, at which the service graph started.
	ServiceGraphStartTime *time.Time

	// The Amazon Web Services instrumented services related to the insight.
	Services []types.InsightImpactGraphService

	// The provided start time.
	StartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetInsightInput added in v0.30.0 

type GetInsightInput struct {

	// The insight's unique identifier. Use the GetInsightSummaries action to retrieve
	// an InsightId.
	//
	// This member is required.
	InsightId *string
	// contains filtered or unexported fields
}

type GetInsightOutput added in v0.30.0 

type GetInsightOutput struct {

	// The summary information of an insight.
	Insight *types.Insight

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetInsightSummariesAPIClient added in v0.30.0 

type GetInsightSummariesAPIClient interface {
	GetInsightSummaries(context.Context, *GetInsightSummariesInput, ...func(*Options)) (*GetInsightSummariesOutput, error)
}

GetInsightSummariesAPIClient is a client that implements the GetInsightSummaries operation.

type GetInsightSummariesInput added in v0.30.0 

type GetInsightSummariesInput struct {

	// The end of the time frame in which the insights ended. The end time can't be
	// more than 30 days old.
	//
	// This member is required.
	EndTime *time.Time

	// The beginning of the time frame in which the insights started. The start time
	// can't be more than 30 days old.
	//
	// This member is required.
	StartTime *time.Time

	// The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't
	// provided.
	GroupARN *string

	// The name of the group. Required if the GroupARN isn't provided.
	GroupName *string

	// The maximum number of results to display.
	MaxResults *int32

	// Pagination token.
	NextToken *string

	// The list of insight states.
	States []types.InsightState
	// contains filtered or unexported fields
}

type GetInsightSummariesOutput added in v0.30.0 

type GetInsightSummariesOutput struct {

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

	// Pagination token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetInsightSummariesPaginator added in v0.30.0 

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

GetInsightSummariesPaginator is a paginator for GetInsightSummaries

func NewGetInsightSummariesPaginator added in v0.30.0 

func NewGetInsightSummariesPaginator(client GetInsightSummariesAPIClient, params *GetInsightSummariesInput, optFns ...func(*GetInsightSummariesPaginatorOptions)) *GetInsightSummariesPaginator

NewGetInsightSummariesPaginator returns a new GetInsightSummariesPaginator

func (*GetInsightSummariesPaginator) HasMorePages added in v0.30.0 

func (p *GetInsightSummariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetInsightSummariesPaginator) NextPage added in v0.30.0 

func (p *GetInsightSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInsightSummariesOutput, error)

NextPage retrieves the next GetInsightSummaries page.

type GetInsightSummariesPaginatorOptions added in v0.30.0 

type GetInsightSummariesPaginatorOptions struct {
	// The maximum number of results to display.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetInsightSummariesPaginatorOptions is the paginator options for GetInsightSummaries

type GetSamplingRulesAPIClient added in v0.30.0 

type GetSamplingRulesAPIClient interface {
	GetSamplingRules(context.Context, *GetSamplingRulesInput, ...func(*Options)) (*GetSamplingRulesOutput, error)
}

GetSamplingRulesAPIClient is a client that implements the GetSamplingRules operation.

type GetSamplingRulesInput 

type GetSamplingRulesInput struct {

	// Pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

type GetSamplingRulesOutput 

type GetSamplingRulesOutput struct {

	// Pagination token.
	NextToken *string

	// Rule definitions and metadata.
	SamplingRuleRecords []types.SamplingRuleRecord

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSamplingRulesPaginator added in v0.30.0 

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

GetSamplingRulesPaginator is a paginator for GetSamplingRules

func NewGetSamplingRulesPaginator added in v0.30.0 

func NewGetSamplingRulesPaginator(client GetSamplingRulesAPIClient, params *GetSamplingRulesInput, optFns ...func(*GetSamplingRulesPaginatorOptions)) *GetSamplingRulesPaginator

NewGetSamplingRulesPaginator returns a new GetSamplingRulesPaginator

func (*GetSamplingRulesPaginator) HasMorePages added in v0.30.0 

func (p *GetSamplingRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetSamplingRulesPaginator) NextPage added in v0.30.0 

func (p *GetSamplingRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetSamplingRulesOutput, error)

NextPage retrieves the next GetSamplingRules page.

type GetSamplingRulesPaginatorOptions added in v0.30.0 

type GetSamplingRulesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetSamplingRulesPaginatorOptions is the paginator options for GetSamplingRules

type GetSamplingStatisticSummariesAPIClient added in v0.30.0 

type GetSamplingStatisticSummariesAPIClient interface {
	GetSamplingStatisticSummaries(context.Context, *GetSamplingStatisticSummariesInput, ...func(*Options)) (*GetSamplingStatisticSummariesOutput, error)
}

GetSamplingStatisticSummariesAPIClient is a client that implements the GetSamplingStatisticSummaries operation.

type GetSamplingStatisticSummariesInput 

type GetSamplingStatisticSummariesInput struct {

	// Pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

type GetSamplingStatisticSummariesOutput 

type GetSamplingStatisticSummariesOutput struct {

	// Pagination token.
	NextToken *string

	// Information about the number of requests instrumented for each sampling rule.
	SamplingStatisticSummaries []types.SamplingStatisticSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSamplingStatisticSummariesPaginator added in v0.30.0 

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

GetSamplingStatisticSummariesPaginator is a paginator for GetSamplingStatisticSummaries

func NewGetSamplingStatisticSummariesPaginator added in v0.30.0 

func NewGetSamplingStatisticSummariesPaginator(client GetSamplingStatisticSummariesAPIClient, params *GetSamplingStatisticSummariesInput, optFns ...func(*GetSamplingStatisticSummariesPaginatorOptions)) *GetSamplingStatisticSummariesPaginator

NewGetSamplingStatisticSummariesPaginator returns a new GetSamplingStatisticSummariesPaginator

func (*GetSamplingStatisticSummariesPaginator) HasMorePages added in v0.30.0 

func (p *GetSamplingStatisticSummariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetSamplingStatisticSummariesPaginator) NextPage added in v0.30.0 

func (p *GetSamplingStatisticSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetSamplingStatisticSummariesOutput, error)

NextPage retrieves the next GetSamplingStatisticSummaries page.

type GetSamplingStatisticSummariesPaginatorOptions added in v0.30.0 

type GetSamplingStatisticSummariesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetSamplingStatisticSummariesPaginatorOptions is the paginator options for GetSamplingStatisticSummaries

type GetSamplingTargetsInput 

type GetSamplingTargetsInput struct {

	// Information about rules that the service is using to sample requests.
	//
	// This member is required.
	SamplingStatisticsDocuments []types.SamplingStatisticsDocument
	// contains filtered or unexported fields
}

type GetSamplingTargetsOutput 

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
	// (https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html) to get
	// the latest version.
	LastRuleModification *time.Time

	// Updated rules that the service should use to sample requests.
	SamplingTargetDocuments []types.SamplingTargetDocument

	// Information about SamplingStatisticsDocument
	// (https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html)
	// that X-Ray could not process.
	UnprocessedStatistics []types.UnprocessedStatistics

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetServiceGraphAPIClient added in v0.30.0 

type GetServiceGraphAPIClient interface {
	GetServiceGraph(context.Context, *GetServiceGraphInput, ...func(*Options)) (*GetServiceGraphOutput, error)
}

GetServiceGraphAPIClient is a client that implements the GetServiceGraph operation.

type GetServiceGraphInput 

type GetServiceGraphInput struct {

	// The end of the timeframe for which to generate a graph.
	//
	// This member is required.
	EndTime *time.Time

	// The start of the time frame for which to generate a graph.
	//
	// This member is required.
	StartTime *time.Time

	// The Amazon Resource Name (ARN) of a group based on which you want to generate a
	// graph.
	GroupARN *string

	// The name of a group based on which you want to generate a graph.
	GroupName *string

	// Pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

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

	// The end of the time frame for which the graph was generated.
	EndTime *time.Time

	// Pagination token.
	NextToken *string

	// The services that have processed a traced request during the specified time
	// frame.
	Services []types.Service

	// The start of the time frame for which the graph was generated.
	StartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetServiceGraphPaginator added in v0.30.0 

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

GetServiceGraphPaginator is a paginator for GetServiceGraph

func NewGetServiceGraphPaginator added in v0.30.0 

func NewGetServiceGraphPaginator(client GetServiceGraphAPIClient, params *GetServiceGraphInput, optFns ...func(*GetServiceGraphPaginatorOptions)) *GetServiceGraphPaginator

NewGetServiceGraphPaginator returns a new GetServiceGraphPaginator

func (*GetServiceGraphPaginator) HasMorePages added in v0.30.0 

func (p *GetServiceGraphPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetServiceGraphPaginator) NextPage added in v0.30.0 

func (p *GetServiceGraphPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetServiceGraphOutput, error)

NextPage retrieves the next GetServiceGraph page.

type GetServiceGraphPaginatorOptions added in v0.30.0 

type GetServiceGraphPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetServiceGraphPaginatorOptions is the paginator options for GetServiceGraph

type GetTimeSeriesServiceStatisticsAPIClient added in v0.30.0 

type GetTimeSeriesServiceStatisticsAPIClient interface {
	GetTimeSeriesServiceStatistics(context.Context, *GetTimeSeriesServiceStatisticsInput, ...func(*Options)) (*GetTimeSeriesServiceStatisticsOutput, error)
}

GetTimeSeriesServiceStatisticsAPIClient is a client that implements the GetTimeSeriesServiceStatistics operation.

type GetTimeSeriesServiceStatisticsInput 

type GetTimeSeriesServiceStatisticsInput struct {

	// The end of the time frame for which to aggregate statistics.
	//
	// This member is required.
	EndTime *time.Time

	// The start of the time frame for which to aggregate statistics.
	//
	// This member is required.
	StartTime *time.Time

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

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

	// The Amazon Resource Name (ARN) of the group for which to pull statistics from.
	GroupARN *string

	// The case-sensitive name of the group for which to pull statistics from.
	GroupName *string

	// Pagination token.
	NextToken *string

	// Aggregation period in seconds.
	Period *int32
	// contains filtered or unexported fields
}

type GetTimeSeriesServiceStatisticsOutput 

type GetTimeSeriesServiceStatisticsOutput struct {

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

	// Pagination token.
	NextToken *string

	// The collection of statistics.
	TimeSeriesServiceStatistics []types.TimeSeriesServiceStatistics

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTimeSeriesServiceStatisticsPaginator added in v0.30.0 

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

GetTimeSeriesServiceStatisticsPaginator is a paginator for GetTimeSeriesServiceStatistics

func NewGetTimeSeriesServiceStatisticsPaginator added in v0.30.0 

func NewGetTimeSeriesServiceStatisticsPaginator(client GetTimeSeriesServiceStatisticsAPIClient, params *GetTimeSeriesServiceStatisticsInput, optFns ...func(*GetTimeSeriesServiceStatisticsPaginatorOptions)) *GetTimeSeriesServiceStatisticsPaginator

NewGetTimeSeriesServiceStatisticsPaginator returns a new GetTimeSeriesServiceStatisticsPaginator

func (*GetTimeSeriesServiceStatisticsPaginator) HasMorePages added in v0.30.0 

func (p *GetTimeSeriesServiceStatisticsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetTimeSeriesServiceStatisticsPaginator) NextPage added in v0.30.0 

func (p *GetTimeSeriesServiceStatisticsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetTimeSeriesServiceStatisticsOutput, error)

NextPage retrieves the next GetTimeSeriesServiceStatistics page.

type GetTimeSeriesServiceStatisticsPaginatorOptions added in v0.30.0 

type GetTimeSeriesServiceStatisticsPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetTimeSeriesServiceStatisticsPaginatorOptions is the paginator options for GetTimeSeriesServiceStatistics

type GetTraceGraphAPIClient added in v0.30.0 

type GetTraceGraphAPIClient interface {
	GetTraceGraph(context.Context, *GetTraceGraphInput, ...func(*Options)) (*GetTraceGraphOutput, error)
}

GetTraceGraphAPIClient is a client that implements the GetTraceGraph operation.

type GetTraceGraphInput 

type GetTraceGraphInput struct {

	// Trace IDs of requests for which to generate a service graph.
	//
	// This member is required.
	TraceIds []string

	// Pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

type GetTraceGraphOutput 

type GetTraceGraphOutput struct {

	// Pagination token.
	NextToken *string

	// The services that have processed one of the specified requests.
	Services []types.Service

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTraceGraphPaginator added in v0.30.0 

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

GetTraceGraphPaginator is a paginator for GetTraceGraph

func NewGetTraceGraphPaginator added in v0.30.0 

func NewGetTraceGraphPaginator(client GetTraceGraphAPIClient, params *GetTraceGraphInput, optFns ...func(*GetTraceGraphPaginatorOptions)) *GetTraceGraphPaginator

NewGetTraceGraphPaginator returns a new GetTraceGraphPaginator

func (*GetTraceGraphPaginator) HasMorePages added in v0.30.0 

func (p *GetTraceGraphPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetTraceGraphPaginator) NextPage added in v0.30.0 

func (p *GetTraceGraphPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetTraceGraphOutput, error)

NextPage retrieves the next GetTraceGraph page.

type GetTraceGraphPaginatorOptions added in v0.30.0 

type GetTraceGraphPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetTraceGraphPaginatorOptions is the paginator options for GetTraceGraph

type GetTraceSummariesAPIClient added in v0.30.0 

type GetTraceSummariesAPIClient interface {
	GetTraceSummaries(context.Context, *GetTraceSummariesInput, ...func(*Options)) (*GetTraceSummariesOutput, error)
}

GetTraceSummariesAPIClient is a client that implements the GetTraceSummaries operation.

type GetTraceSummariesInput 

type GetTraceSummariesInput struct {

	// The end of the time frame for which to retrieve traces.
	//
	// This member is required.
	EndTime *time.Time

	// The start of the time frame for which to retrieve traces.
	//
	// This member is required.
	StartTime *time.Time

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

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

	// Set to true to get summaries for only a subset of available traces.
	Sampling *bool

	// A parameter to indicate whether to enable sampling on trace summaries. Input
	// parameters are Name and Value.
	SamplingStrategy *types.SamplingStrategy

	// A parameter to indicate whether to query trace summaries by TraceId or Event
	// time.
	TimeRangeType types.TimeRangeType
	// contains filtered or unexported fields
}

type GetTraceSummariesOutput 

type GetTraceSummariesOutput struct {

	// The start time of this page of results.
	ApproximateTime *time.Time

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

	// Trace IDs and annotations for traces that were found in the specified time
	// frame.
	TraceSummaries []types.TraceSummary

	// The total number of traces processed, including traces that did not match the
	// specified filter expression.
	TracesProcessedCount *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTraceSummariesPaginator added in v0.30.0 

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

GetTraceSummariesPaginator is a paginator for GetTraceSummaries

func NewGetTraceSummariesPaginator added in v0.30.0 

func NewGetTraceSummariesPaginator(client GetTraceSummariesAPIClient, params *GetTraceSummariesInput, optFns ...func(*GetTraceSummariesPaginatorOptions)) *GetTraceSummariesPaginator

NewGetTraceSummariesPaginator returns a new GetTraceSummariesPaginator

func (*GetTraceSummariesPaginator) HasMorePages added in v0.30.0 

func (p *GetTraceSummariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetTraceSummariesPaginator) NextPage added in v0.30.0 

func (p *GetTraceSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetTraceSummariesOutput, error)

NextPage retrieves the next GetTraceSummaries page.

type GetTraceSummariesPaginatorOptions added in v0.30.0 

type GetTraceSummariesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetTraceSummariesPaginatorOptions is the paginator options for GetTraceSummaries

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListResourcePoliciesAPIClient added in v1.15.0 

type ListResourcePoliciesAPIClient interface {
	ListResourcePolicies(context.Context, *ListResourcePoliciesInput, ...func(*Options)) (*ListResourcePoliciesOutput, error)
}

ListResourcePoliciesAPIClient is a client that implements the ListResourcePolicies operation.

type ListResourcePoliciesInput added in v1.15.0 

type ListResourcePoliciesInput struct {

	// Not currently supported.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourcePoliciesOutput added in v1.15.0 

type ListResourcePoliciesOutput struct {

	// Pagination token. Not currently supported.
	NextToken *string

	// The list of resource policies in the target Amazon Web Services account.
	ResourcePolicies []types.ResourcePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListResourcePoliciesPaginator added in v1.15.0 

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

ListResourcePoliciesPaginator is a paginator for ListResourcePolicies

func NewListResourcePoliciesPaginator added in v1.15.0 

func NewListResourcePoliciesPaginator(client ListResourcePoliciesAPIClient, params *ListResourcePoliciesInput, optFns ...func(*ListResourcePoliciesPaginatorOptions)) *ListResourcePoliciesPaginator

NewListResourcePoliciesPaginator returns a new ListResourcePoliciesPaginator

func (*ListResourcePoliciesPaginator) HasMorePages added in v1.15.0 

func (p *ListResourcePoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourcePoliciesPaginator) NextPage added in v1.15.0 

func (p *ListResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcePoliciesOutput, error)

NextPage retrieves the next ListResourcePolicies page.

type ListResourcePoliciesPaginatorOptions added in v1.15.0 

type ListResourcePoliciesPaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListResourcePoliciesPaginatorOptions is the paginator options for ListResourcePolicies

type ListTagsForResourceAPIClient added in v1.15.0 

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

type ListTagsForResourceInput added in v0.29.0 

type ListTagsForResourceInput struct {

	// The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
	//
	// This member is required.
	ResourceARN *string

	// A pagination token. If multiple pages of results are returned, use the NextToken
	// value returned with the current page of results as the value of this parameter
	// to get the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v0.29.0 

type ListTagsForResourceOutput struct {

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

	// A list of tags, as key and value pairs, that is associated with the specified
	// X-Ray group or sampling rule.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourcePaginator added in v1.15.0 

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

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v1.15.0 

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v1.15.0 

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v1.15.0 

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v1.15.0 

type ListTagsForResourcePaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutEncryptionConfigInput 

type PutEncryptionConfigInput struct {

	// The type of encryption. Set to KMS to use your own key for encryption. Set to
	// NONE for default encryption.
	//
	// This member is required.
	Type types.EncryptionType

	// An Amazon Web Services KMS key 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. Amazon Web Services
	// X-Ray does not support asymmetric KMS keys.
	//
	// * 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
	// contains filtered or unexported fields
}

type PutEncryptionConfigOutput 

type PutEncryptionConfigOutput struct {

	// The new encryption configuration.
	EncryptionConfig *types.EncryptionConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutResourcePolicyInput added in v1.15.0 

type PutResourcePolicyInput struct {

	// The resource policy document, which can be up to 5kb in size.
	//
	// This member is required.
	PolicyDocument *string

	// The name of the resource policy. Must be unique within a specific Amazon Web
	// Services account.
	//
	// This member is required.
	PolicyName *string

	// A flag to indicate whether to bypass the resource policy lockout safety check.
	// Setting this value to true increases the risk that the policy becomes
	// unmanageable. Do not set this value to true indiscriminately. Use this parameter
	// only when you include a policy in the request and you intend to prevent the
	// principal that is making the request from making a subsequent PutResourcePolicy
	// request. The default value is false.
	BypassPolicyLockoutCheck bool

	// Specifies a specific policy revision, to ensure an atomic create operation. By
	// default the resource policy is created if it does not exist, or updated with an
	// incremented revision id. The revision id is unique to each policy in the
	// account. If the policy revision id does not match the latest revision id, the
	// operation will fail with an InvalidPolicyRevisionIdException exception. You can
	// also provide a PolicyRevisionId of 0. In this case, the operation will fail with
	// an InvalidPolicyRevisionIdException exception if a resource policy with the same
	// name already exists.
	PolicyRevisionId *string
	// contains filtered or unexported fields
}

type PutResourcePolicyOutput added in v1.15.0 

type PutResourcePolicyOutput struct {

	// The resource policy document, as provided in the PutResourcePolicyRequest.
	ResourcePolicy *types.ResourcePolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutTelemetryRecordsInput 

type PutTelemetryRecordsInput struct {

	//
	//
	// This member is required.
	TelemetryRecords []types.TelemetryRecord

	//
	EC2InstanceId *string

	//
	Hostname *string

	//
	ResourceARN *string
	// contains filtered or unexported fields
}

type PutTelemetryRecordsOutput 

type PutTelemetryRecordsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutTraceSegmentsInput 

type PutTraceSegmentsInput struct {

	// A string containing a JSON document defining one or more segments or
	// subsegments.
	//
	// This member is required.
	TraceSegmentDocuments []string
	// contains filtered or unexported fields
}

type PutTraceSegmentsOutput 

type PutTraceSegmentsOutput struct {

	// Segments that failed processing.
	UnprocessedTraceSegments []types.UnprocessedTraceSegment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput added in v0.29.0 

type TagResourceInput struct {

	// The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
	//
	// This member is required.
	ResourceARN *string

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

type TagResourceOutput added in v0.29.0 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v0.29.0 

type UntagResourceInput struct {

	// The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
	//
	// This member is required.
	ResourceARN *string

	// Keys for one or more tags that you want to remove from an X-Ray group or
	// sampling rule.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v0.29.0 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGroupInput 

type UpdateGroupInput struct {

	// The updated filter expression defining criteria by which to group traces.
	FilterExpression *string

	// The ARN that was generated upon creation.
	GroupARN *string

	// The case-sensitive name of the group.
	GroupName *string

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

type UpdateGroupOutput 

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, the updated filter expression, and the
	// updated insight configuration assigned to the group.
	Group *types.Group

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSamplingRuleInput 

type UpdateSamplingRuleInput struct {

	// The rule and fields to change.
	//
	// This member is required.
	SamplingRuleUpdate *types.SamplingRuleUpdate
	// contains filtered or unexported fields
}

type UpdateSamplingRuleOutput 

type UpdateSamplingRuleOutput struct {

	// The updated rule definition and metadata.
	SamplingRuleRecord *types.SamplingRuleRecord

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.