evidently

package module
v1.9.0 Latest Latest
Warning

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

 Go to latest Published: Sep 14, 2022 License: Apache-2.0 Imports: 32 Imported by: 7

Documentation

Overview

Package evidently provides the API client, operations, and parameter types for Amazon CloudWatch Evidently.

You can use Amazon CloudWatch Evidently to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to your users. This helps you reduce risk and identify unintended consequences before you fully launch the feature. You can also conduct A/B experiments to make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it using statistical methods. It also provides clear recommendations about which variations perform better. You can test both user-facing features and backend features.

Index

Constants

View Source 
const ServiceAPIVersion = "2021-02-01"
View Source 
const ServiceID = "Evidently"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

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 BatchEvaluateFeatureInput 

type BatchEvaluateFeatureInput struct {

	// The name or ARN of the project that contains the feature being evaluated.
	//
	// This member is required.
	Project *string

	// An array of structures, where each structure assigns a feature variation to one
	// user session.
	//
	// This member is required.
	Requests []types.EvaluationRequest
	// contains filtered or unexported fields
}

type BatchEvaluateFeatureOutput 

type BatchEvaluateFeatureOutput struct {

	// An array of structures, where each structure displays the results of one feature
	// evaluation assignment to one user session.
	Results []types.EvaluationResult

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

type Client 

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

Client provides the API client to make operations call for Amazon CloudWatch Evidently.

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

func (c *Client) BatchEvaluateFeature(ctx context.Context, params *BatchEvaluateFeatureInput, optFns ...func(*Options)) (*BatchEvaluateFeatureOutput, error)

This operation assigns feature variation to user sessions. For each user session, you pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule. Next, if there is a launch of the feature, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch. If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. If the user is not assigned to a launch or experiment, they are served the default variation.

func (*Client) CreateExperiment 

func (c *Client) CreateExperiment(ctx context.Context, params *CreateExperimentInput, optFns ...func(*Options)) (*CreateExperimentOutput, error)

Creates an Evidently experiment. Before you create an experiment, you must create the feature to use for the experiment. An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better. You can optionally specify a segment to have the experiment consider only certain audience types in the experiment, such as using only user sessions from a certain location or who use a certain internet browser. Don't use this operation to update an existing experiment. Instead, use UpdateExperiment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateExperiment.html).

func (*Client) CreateFeature 

func (c *Client) CreateFeature(ctx context.Context, params *CreateFeatureInput, optFns ...func(*Options)) (*CreateFeatureOutput, error)

Creates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see CreateProject (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html). Don't use this operation to update an existing feature. Instead, use UpdateFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateFeature.html).

func (*Client) CreateLaunch 

func (c *Client) CreateLaunch(ctx context.Context, params *CreateLaunchInput, optFns ...func(*Options)) (*CreateLaunchOutput, error)

Creates a launch of a given feature. Before you create a launch, you must create the feature to use for the launch. You can use a launch to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature. Don't use this operation to update an existing launch. Instead, use UpdateLaunch (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateLaunch.html).

func (*Client) CreateProject 

func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)

Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together. To update an existing project, use UpdateProject (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProject.html).

func (*Client) CreateSegment added in v1.8.0 

func (c *Client) CreateSegment(ctx context.Context, params *CreateSegmentInput, optFns ...func(*Options)) (*CreateSegmentOutput, error)

Use this operation to define a segment of your audience. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age. Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allows you to define different traffic splits for the different audience segments. For more information about segment pattern syntax, see Segment rule pattern syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html). The pattern that you define for a segment is matched against the value of evaluationContext, which is passed into Evidently in the EvaluateFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) operation, when Evidently assigns a feature variation to a user.

func (*Client) DeleteExperiment 

func (c *Client) DeleteExperiment(ctx context.Context, params *DeleteExperimentInput, optFns ...func(*Options)) (*DeleteExperimentOutput, error)

Deletes an Evidently experiment. The feature used for the experiment is not deleted. To stop an experiment without deleting it, use StopExperiment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopExperiment.html).

func (*Client) DeleteFeature 

func (c *Client) DeleteFeature(ctx context.Context, params *DeleteFeatureInput, optFns ...func(*Options)) (*DeleteFeatureOutput, error)

Deletes an Evidently feature.

func (*Client) DeleteLaunch 

func (c *Client) DeleteLaunch(ctx context.Context, params *DeleteLaunchInput, optFns ...func(*Options)) (*DeleteLaunchOutput, error)

Deletes an Evidently launch. The feature used for the launch is not deleted. To stop a launch without deleting it, use StopLaunch (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_StopLaunch.html).

func (*Client) DeleteProject 

func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

Deletes an Evidently project. Before you can delete a project, you must delete all the features that the project contains. To delete a feature, use DeleteFeature (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_DeleteFeature.html).

func (*Client) DeleteSegment added in v1.8.0 

func (c *Client) DeleteSegment(ctx context.Context, params *DeleteSegmentInput, optFns ...func(*Options)) (*DeleteSegmentOutput, error)

Deletes a segment. You can't delete a segment that is being used in a launch or experiment, even if that launch or experiment is not currently running.

func (*Client) EvaluateFeature 

func (c *Client) EvaluateFeature(ctx context.Context, params *EvaluateFeatureInput, optFns ...func(*Options)) (*EvaluateFeatureOutput, error)

This operation assigns a feature variation to one given user session. You pass in an entityID that represents the user. Evidently then checks the evaluation rules and assigns the variation. The first rules that are evaluated are the override rules. If the user's entityID matches an override rule, the user is served the variation specified by that rule. If there is a current launch with this feature that uses segment overrides, and if the user session's evaluationContext matches a segment rule defined in a segment override, the configuration in the segment overrides is used. For more information about segments, see CreateSegment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html) and Use segments to focus your audience (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html). If there is a launch with no segment overrides, the user might be assigned to a variation in the launch. The chance of this depends on the percentage of users that are allocated to that launch. If the user is enrolled in the launch, the variation they are served depends on the allocation of the various feature variations used for the launch. If the user is not assigned to a launch, and there is an ongoing experiment for this feature, the user might be assigned to a variation in the experiment. The chance of this depends on the percentage of users that are allocated to that experiment. If the experiment uses a segment, then only user sessions with evaluationContext values that match the segment rule are used in the experiment. If the user is enrolled in the experiment, the variation they are served depends on the allocation of the various feature variations used for the experiment. If the user is not assigned to a launch or experiment, they are served the default variation.

func (*Client) GetExperiment 

func (c *Client) GetExperiment(ctx context.Context, params *GetExperimentInput, optFns ...func(*Options)) (*GetExperimentOutput, error)

Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListExperiments.html).

func (*Client) GetExperimentResults 

func (c *Client) GetExperimentResults(ctx context.Context, params *GetExperimentResultsInput, optFns ...func(*Options)) (*GetExperimentResultsOutput, error)

Retrieves the results of a running or completed experiment. No results are available until there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during the experiment do not find statistical significance. Experiment results are available up to 63 days after the start of the experiment. They are not available after that because of CloudWatch data retention policies.

func (*Client) GetFeature 

func (c *Client) GetFeature(ctx context.Context, params *GetFeatureInput, optFns ...func(*Options)) (*GetFeatureOutput, error)

Returns the details about one feature. You must already know the feature name. To retrieve a list of features in your account, use ListFeatures (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListFeatures.html).

func (*Client) GetLaunch 

func (c *Client) GetLaunch(ctx context.Context, params *GetLaunchInput, optFns ...func(*Options)) (*GetLaunchOutput, error)

Returns the details about one launch. You must already know the launch name. To retrieve a list of launches in your account, use ListLaunches (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListLaunches.html).

func (*Client) GetProject 

func (c *Client) GetProject(ctx context.Context, params *GetProjectInput, optFns ...func(*Options)) (*GetProjectOutput, error)

Returns the details about one launch. You must already know the project name. To retrieve a list of projects in your account, use ListProjects (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_ListProjects.html).

func (*Client) GetSegment added in v1.8.0 

func (c *Client) GetSegment(ctx context.Context, params *GetSegmentInput, optFns ...func(*Options)) (*GetSegmentOutput, error)

Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.

func (*Client) ListExperiments 

func (c *Client) ListExperiments(ctx context.Context, params *ListExperimentsInput, optFns ...func(*Options)) (*ListExperimentsOutput, error)

Returns configuration details about all the experiments in the specified project.

func (*Client) ListFeatures 

func (c *Client) ListFeatures(ctx context.Context, params *ListFeaturesInput, optFns ...func(*Options)) (*ListFeaturesOutput, error)

Returns configuration details about all the features in the specified project.

func (*Client) ListLaunches 

func (c *Client) ListLaunches(ctx context.Context, params *ListLaunchesInput, optFns ...func(*Options)) (*ListLaunchesOutput, error)

Returns configuration details about all the launches in the specified project.

func (*Client) ListProjects 

func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)

Returns configuration details about all the projects in the current Region in your account.

func (*Client) ListSegmentReferences added in v1.8.0 

func (c *Client) ListSegmentReferences(ctx context.Context, params *ListSegmentReferencesInput, optFns ...func(*Options)) (*ListSegmentReferencesOutput, error)

Use this operation to find which experiments or launches are using a specified segment.

func (*Client) ListSegments added in v1.8.0 

func (c *Client) ListSegments(ctx context.Context, params *ListSegmentsInput, optFns ...func(*Options)) (*ListSegmentsOutput, error)

Returns a list of audience segments that you have created in your account in this Region.

func (*Client) ListTagsForResource 

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

Displays the tags associated with an Evidently resource.

func (*Client) PutProjectEvents 

func (c *Client) PutProjectEvents(ctx context.Context, params *PutProjectEventsInput, optFns ...func(*Options)) (*PutProjectEventsOutput, error)

Sends performance events to Evidently. These events can be used to evaluate a launch or an experiment.

func (*Client) StartExperiment 

func (c *Client) StartExperiment(ctx context.Context, params *StartExperimentInput, optFns ...func(*Options)) (*StartExperimentOutput, error)

Starts an existing experiment. To create an experiment, use CreateExperiment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateExperiment.html).

func (*Client) StartLaunch 

func (c *Client) StartLaunch(ctx context.Context, params *StartLaunchInput, optFns ...func(*Options)) (*StartLaunchOutput, error)

Starts an existing launch. To create a launch, use CreateLaunch (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateLaunch.html).

func (*Client) StopExperiment 

func (c *Client) StopExperiment(ctx context.Context, params *StopExperimentInput, optFns ...func(*Options)) (*StopExperimentOutput, error)

Stops an experiment that is currently running. If you stop an experiment, you can't resume it or restart it.

func (*Client) StopLaunch 

func (c *Client) StopLaunch(ctx context.Context, params *StopLaunchInput, optFns ...func(*Options)) (*StopLaunchOutput, error)

Stops a launch that is currently running. After you stop a launch, you will not be able to resume it or restart it. Also, it will not be evaluated as a rule for traffic allocation, and the traffic that was allocated to the launch will instead be available to the feature's experiment, if there is one. Otherwise, all traffic will be served the default variation after the launch is stopped.

func (*Client) TagResource 

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

Assigns one or more tags (key-value pairs) to the specified CloudWatch Evidently resource. Projects, features, launches, and experiments can be tagged. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. For more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).

func (*Client) TestSegmentPattern added in v1.8.0 

func (c *Client) TestSegmentPattern(ctx context.Context, params *TestSegmentPatternInput, optFns ...func(*Options)) (*TestSegmentPatternOutput, error)

Use this operation to test a rules pattern that you plan to use to create an audience segment. For more information about segments, see CreateSegment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateSegment.html).

func (*Client) UntagResource 

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

Removes one or more tags from the specified resource.

func (*Client) UpdateExperiment 

func (c *Client) UpdateExperiment(ctx context.Context, params *UpdateExperimentInput, optFns ...func(*Options)) (*UpdateExperimentOutput, error)

Updates an Evidently experiment. Don't use this operation to update an experiment's tag. Instead, use TagResource (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html).

func (*Client) UpdateFeature 

func (c *Client) UpdateFeature(ctx context.Context, params *UpdateFeatureInput, optFns ...func(*Options)) (*UpdateFeatureOutput, error)

Updates an existing feature. You can't use this operation to update the tags of an existing feature. Instead, use TagResource (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html).

func (*Client) UpdateLaunch 

func (c *Client) UpdateLaunch(ctx context.Context, params *UpdateLaunchInput, optFns ...func(*Options)) (*UpdateLaunchOutput, error)

Updates a launch of a given feature. Don't use this operation to update the tags of an existing launch. Instead, use TagResource (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html).

func (*Client) UpdateProject 

func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)

Updates the description of an existing project. To create a new project, use CreateProject (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html). Don't use this operation to update the data storage options of a project. Instead, use UpdateProjectDataDelivery (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateProjectDataDelivery.html). Don't use this operation to update the tags of a project. Instead, use TagResource (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html).

func (*Client) UpdateProjectDataDelivery 

func (c *Client) UpdateProjectDataDelivery(ctx context.Context, params *UpdateProjectDataDeliveryInput, optFns ...func(*Options)) (*UpdateProjectDataDeliveryOutput, error)

Updates the data storage options for this project. If you store evaluation events, you an keep them and analyze them on your own. If you choose not to store evaluation events, Evidently deletes them after using them to produce metrics and other experiment results that you can view. You can't specify both cloudWatchLogs and s3Destination in the same operation.

type CreateExperimentInput 

type CreateExperimentInput struct {

	// An array of structures that defines the metrics used for the experiment, and
	// whether a higher or lower value for each metric is the goal.
	//
	// This member is required.
	MetricGoals []types.MetricGoalConfig

	// A name for the new experiment.
	//
	// This member is required.
	Name *string

	// The name or ARN of the project that you want to create the new experiment in.
	//
	// This member is required.
	Project *string

	// An array of structures that describe the configuration of each feature variation
	// used in the experiment.
	//
	// This member is required.
	Treatments []types.TreatmentConfig

	// An optional description of the experiment.
	Description *string

	// A structure that contains the configuration of which variation to use as the
	// "control" version. tThe "control" version is used for comparison with other
	// variations. This structure also specifies how much experiment traffic is
	// allocated to each variation.
	OnlineAbConfig *types.OnlineAbConfig

	// When Evidently assigns a particular user session to an experiment, it must use a
	// randomization ID to determine which variation the user session is served. This
	// randomization ID is a combination of the entity ID and randomizationSalt. If you
	// omit randomizationSalt, Evidently uses the experiment name as the
	// randomizationSalt.
	RandomizationSalt *string

	// The portion of the available audience that you want to allocate to this
	// experiment, in thousandths of a percent. The available audience is the total
	// audience minus the audience that you have allocated to overrides or current
	// launches of this feature. This is represented in thousandths of a percent. For
	// example, specify 10,000 to allocate 10% of the available audience.
	SamplingRate *int64

	// Specifies an audience segment to use in the experiment. When a segment is used
	// in an experiment, only user sessions that match the segment pattern are used in
	// the experiment.
	Segment *string

	// Assigns one or more tags (key-value pairs) to the experiment. Tags can help you
	// organize and categorize your resources. You can also use them to scope user
	// permissions by granting a user permission to access or change only resources
	// with certain tag values. Tags don't have any semantic meaning to Amazon Web
	// Services and are interpreted strictly as strings of characters. You can
	// associate as many as 50 tags with an experiment. For more information, see
	// Tagging Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateExperimentOutput 

type CreateExperimentOutput struct {

	// A structure containing the configuration details of the experiment that you
	// created.
	//
	// This member is required.
	Experiment *types.Experiment

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

type CreateFeatureInput 

type CreateFeatureInput struct {

	// The name for the new feature.
	//
	// This member is required.
	Name *string

	// The name or ARN of the project that is to contain the new feature.
	//
	// This member is required.
	Project *string

	// An array of structures that contain the configuration of the feature's different
	// variations.
	//
	// This member is required.
	Variations []types.VariationConfig

	// The name of the variation to use as the default variation. The default variation
	// is served to users who are not allocated to any ongoing launches or experiments
	// of this feature. This variation must also be listed in the variations structure.
	// If you omit defaultVariation, the first variation listed in the variations
	// structure is used as the default variation.
	DefaultVariation *string

	// An optional description of the feature.
	Description *string

	// Specify users that should always be served a specific variation of a feature.
	// Each user is specified by a key-value pair . For each key, specify a user by
	// entering their user ID, account ID, or some other identifier. For the value,
	// specify the name of the variation that they are to be served.
	EntityOverrides map[string]string

	// Specify ALL_RULES to activate the traffic allocation specified by any ongoing
	// launches or experiments. Specify DEFAULT_VARIATION to serve the default
	// variation to all users instead.
	EvaluationStrategy types.FeatureEvaluationStrategy

	// Assigns one or more tags (key-value pairs) to the feature. Tags can help you
	// organize and categorize your resources. You can also use them to scope user
	// permissions by granting a user permission to access or change only resources
	// with certain tag values. Tags don't have any semantic meaning to Amazon Web
	// Services and are interpreted strictly as strings of characters. You can
	// associate as many as 50 tags with a feature. For more information, see Tagging
	// Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateFeatureOutput 

type CreateFeatureOutput struct {

	// A structure that contains information about the new feature.
	Feature *types.Feature

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

type CreateLaunchInput 

type CreateLaunchInput struct {

	// An array of structures that contains the feature and variations that are to be
	// used for the launch.
	//
	// This member is required.
	Groups []types.LaunchGroupConfig

	// The name for the new launch.
	//
	// This member is required.
	Name *string

	// The name or ARN of the project that you want to create the launch in.
	//
	// This member is required.
	Project *string

	// An optional description for the launch.
	Description *string

	// An array of structures that define the metrics that will be used to monitor the
	// launch performance.
	MetricMonitors []types.MetricMonitorConfig

	// When Evidently assigns a particular user session to a launch, it must use a
	// randomization ID to determine which variation the user session is served. This
	// randomization ID is a combination of the entity ID and randomizationSalt. If you
	// omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.
	RandomizationSalt *string

	// An array of structures that define the traffic allocation percentages among the
	// feature variations during each step of the launch.
	ScheduledSplitsConfig *types.ScheduledSplitsLaunchConfig

	// Assigns one or more tags (key-value pairs) to the launch. Tags can help you
	// organize and categorize your resources. You can also use them to scope user
	// permissions by granting a user permission to access or change only resources
	// with certain tag values. Tags don't have any semantic meaning to Amazon Web
	// Services and are interpreted strictly as strings of characters. You can
	// associate as many as 50 tags with a launch. For more information, see Tagging
	// Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateLaunchOutput 

type CreateLaunchOutput struct {

	// A structure that contains the configuration of the launch that was created.
	//
	// This member is required.
	Launch *types.Launch

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

type CreateProjectInput 

type CreateProjectInput struct {

	// The name for the project.
	//
	// This member is required.
	Name *string

	// Use this parameter if the project will use client-side evaluation powered by
	// AppConfig. Client-side evaluation allows your application to assign variations
	// to user sessions locally instead of by calling the EvaluateFeature
	// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html)
	// operation. This mitigates the latency and availability risks that come with an
	// API call. For more information, see  Client-side evaluation - powered by
	// AppConfig.
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html)
	// This parameter is a structure that contains information about the AppConfig
	// application and environment that will be used as for client-side evaluation. To
	// create a project that uses client-side evaluation, you must have the
	// evidently:ExportProjectAsConfiguration permission.
	AppConfigResource *types.ProjectAppConfigResourceConfig

	// A structure that contains information about where Evidently is to store
	// evaluation events for longer term storage, if you choose to do so. If you choose
	// not to store these events, Evidently deletes them after using them to produce
	// metrics and other experiment results that you can view.
	DataDelivery *types.ProjectDataDeliveryConfig

	// An optional description of the project.
	Description *string

	// Assigns one or more tags (key-value pairs) to the project. Tags can help you
	// organize and categorize your resources. You can also use them to scope user
	// permissions by granting a user permission to access or change only resources
	// with certain tag values. Tags don't have any semantic meaning to Amazon Web
	// Services and are interpreted strictly as strings of characters. You can
	// associate as many as 50 tags with a project. For more information, see Tagging
	// Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateProjectOutput 

type CreateProjectOutput struct {

	// A structure that contains information about the created project.
	//
	// This member is required.
	Project *types.Project

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

type CreateSegmentInput added in v1.8.0 

type CreateSegmentInput struct {

	// A name for the segment.
	//
	// This member is required.
	Name *string

	// The pattern to use for the segment. For more information about pattern syntax,
	// see  Segment rule pattern syntax
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html).
	//
	// This value conforms to the media type: application/json
	//
	// This member is required.
	Pattern *string

	// An optional description for this segment.
	Description *string

	// Assigns one or more tags (key-value pairs) to the segment. Tags can help you
	// organize and categorize your resources. You can also use them to scope user
	// permissions by granting a user permission to access or change only resources
	// with certain tag values. Tags don't have any semantic meaning to Amazon Web
	// Services and are interpreted strictly as strings of characters. You can
	// associate as many as 50 tags with a segment. For more information, see Tagging
	// Amazon Web Services resources
	// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateSegmentOutput added in v1.8.0 

type CreateSegmentOutput struct {

	// A structure that contains the complete information about the segment that was
	// just created.
	//
	// This member is required.
	Segment *types.Segment

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

type DeleteExperimentInput 

type DeleteExperimentInput struct {

	// The name of the experiment to delete.
	//
	// This member is required.
	Experiment *string

	// The name or ARN of the project that contains the experiment to delete.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type DeleteExperimentOutput 

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

type DeleteFeatureInput 

type DeleteFeatureInput struct {

	// The name of the feature to delete.
	//
	// This member is required.
	Feature *string

	// The name or ARN of the project that contains the feature to delete.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type DeleteFeatureOutput 

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

type DeleteLaunchInput 

type DeleteLaunchInput struct {

	// The name of the launch to delete.
	//
	// This member is required.
	Launch *string

	// The name or ARN of the project that contains the launch to delete.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type DeleteLaunchOutput 

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

type DeleteProjectInput 

type DeleteProjectInput struct {

	// The name or ARN of the project to delete.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type DeleteProjectOutput 

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

type DeleteSegmentInput added in v1.8.0 

type DeleteSegmentInput struct {

	// Specifies the segment to delete.
	//
	// This member is required.
	Segment *string
	// contains filtered or unexported fields
}

type DeleteSegmentOutput added in v1.8.0 

type DeleteSegmentOutput struct {
	// 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 

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 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EvaluateFeatureInput 

type EvaluateFeatureInput struct {

	// An internal ID that represents a unique user of the application. This entityID
	// is checked against any override rules assigned for this feature.
	//
	// This member is required.
	EntityId *string

	// The name of the feature being evaluated.
	//
	// This member is required.
	Feature *string

	// The name or ARN of the project that contains this feature.
	//
	// This member is required.
	Project *string

	// A JSON object of attributes that you can optionally pass in as part of the
	// evaluation event sent to Evidently from the user session. Evidently can use this
	// value to match user sessions with defined audience segments. For more
	// information, see Use segments to focus your audience
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html).
	// If you include this parameter, the value must be a JSON object. A JSON array is
	// not supported.
	//
	// This value conforms to the media type: application/json
	EvaluationContext *string
	// contains filtered or unexported fields
}

type EvaluateFeatureOutput 

type EvaluateFeatureOutput struct {

	// If this user was assigned to a launch or experiment, this field lists the launch
	// or experiment name.
	//
	// This value conforms to the media type: application/json
	Details *string

	// Specifies the reason that the user session was assigned this variation. Possible
	// values include DEFAULT, meaning the user was served the default variation;
	// LAUNCH_RULE_MATCH, if the user session was enrolled in a launch;
	// EXPERIMENT_RULE_MATCH, if the user session was enrolled in an experiment; or
	// ENTITY_OVERRIDES_MATCH, if the user's entityId matches an override rule.
	Reason *string

	// The value assigned to this variation to differentiate it from the other
	// variations of this feature.
	Value types.VariableValue

	// The name of the variation that was served to the user session.
	Variation *string

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

type GetExperimentInput 

type GetExperimentInput struct {

	// The name of the experiment that you want to see the details of.
	//
	// This member is required.
	Experiment *string

	// The name or ARN of the project that contains the experiment.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type GetExperimentOutput 

type GetExperimentOutput struct {

	// A structure containing the configuration details of the experiment.
	Experiment *types.Experiment

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

type GetExperimentResultsInput 

type GetExperimentResultsInput struct {

	// The name of the experiment to retrieve the results of.
	//
	// This member is required.
	Experiment *string

	// The names of the experiment metrics that you want to see the results of.
	//
	// This member is required.
	MetricNames []string

	// The name or ARN of the project that contains the experiment that you want to see
	// the results of.
	//
	// This member is required.
	Project *string

	// The names of the experiment treatments that you want to see the results for.
	//
	// This member is required.
	TreatmentNames []string

	// The statistic used to calculate experiment results. Currently the only valid
	// value is mean, which uses the mean of the collected values as the statistic.
	BaseStat types.ExperimentBaseStat

	// The date and time that the experiment ended, if it is completed. This must be no
	// longer than 30 days after the experiment start time.
	EndTime *time.Time

	// In seconds, the amount of time to aggregate results together.
	Period int64

	// The names of the report types that you want to see. Currently, BayesianInference
	// is the only valid value.
	ReportNames []types.ExperimentReportName

	// The statistics that you want to see in the returned results.
	//
	// * PValue specifies
	// to use p-values for the results. A p-value is used in hypothesis testing to
	// measure how often you are willing to make a mistake in rejecting the null
	// hypothesis. A general practice is to reject the null hypothesis and declare that
	// the results are statistically significant when the p-value is less than 0.05.
	//
	// *
	// ConfidenceInterval specifies a confidence interval for the results. The
	// confidence interval represents the range of values for the chosen metric that is
	// likely to contain the true difference between the baseStat of a variation and
	// the baseline. Evidently returns the 95% confidence interval.
	//
	// * TreatmentEffect
	// is the difference in the statistic specified by the baseStat parameter between
	// each variation and the default variation.
	//
	// * BaseStat returns the statistical
	// values collected for the metric for each variation. The statistic uses the same
	// statistic specified in the baseStat parameter. Therefore, if baseStat is mean,
	// this returns the mean of the values collected for each variation.
	ResultStats []types.ExperimentResultRequestType

	// The date and time that the experiment started.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type GetExperimentResultsOutput 

type GetExperimentResultsOutput struct {

	// If the experiment doesn't yet have enough events to provide valid results, this
	// field is returned with the message Not enough events to generate results. If
	// there are enough events to provide valid results, this field is not returned.
	Details *string

	// An array of structures that include the reports that you requested.
	Reports []types.ExperimentReport

	// An array of structures that include experiment results including metric names
	// and values.
	ResultsData []types.ExperimentResultsData

	// The timestamps of each result returned.
	Timestamps []time.Time

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

type GetFeatureInput 

type GetFeatureInput struct {

	// The name of the feature that you want to retrieve information for.
	//
	// This member is required.
	Feature *string

	// The name or ARN of the project that contains the feature.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type GetFeatureOutput 

type GetFeatureOutput struct {

	// A structure containing the configuration details of the feature.
	//
	// This member is required.
	Feature *types.Feature

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

type GetLaunchInput 

type GetLaunchInput struct {

	// The name of the launch that you want to see the details of.
	//
	// This member is required.
	Launch *string

	// The name or ARN of the project that contains the launch.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type GetLaunchOutput 

type GetLaunchOutput struct {

	// A structure containing the configuration details of the launch.
	Launch *types.Launch

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

type GetProjectInput 

type GetProjectInput struct {

	// The name or ARN of the project that you want to see the details of.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type GetProjectOutput 

type GetProjectOutput struct {

	// A structure containing the configuration details of the project.
	//
	// This member is required.
	Project *types.Project

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

type GetSegmentInput added in v1.8.0 

type GetSegmentInput struct {

	// The ARN of the segment to return information for.
	//
	// This member is required.
	Segment *string
	// contains filtered or unexported fields
}

type GetSegmentOutput added in v1.8.0 

type GetSegmentOutput struct {

	// A structure that contains the complete information about the segment.
	//
	// This member is required.
	Segment *types.Segment

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

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 ListExperimentsAPIClient 

type ListExperimentsAPIClient interface {
	ListExperiments(context.Context, *ListExperimentsInput, ...func(*Options)) (*ListExperimentsOutput, error)
}

ListExperimentsAPIClient is a client that implements the ListExperiments operation.

type ListExperimentsInput 

type ListExperimentsInput struct {

	// The name or ARN of the project to return the experiment list from.
	//
	// This member is required.
	Project *string

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token to use when requesting the next set of results. You received this
	// token from a previous ListExperiments operation.
	NextToken *string

	// Use this optional parameter to limit the returned results to only the
	// experiments with the status that you specify here.
	Status types.ExperimentStatus
	// contains filtered or unexported fields
}

type ListExperimentsOutput 

type ListExperimentsOutput struct {

	// An array of structures that contain the configuration details of the experiments
	// in the specified project.
	Experiments []types.Experiment

	// The token to use in a subsequent ListExperiments operation to return the next
	// set of results.
	NextToken *string

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

type ListExperimentsPaginator 

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

ListExperimentsPaginator is a paginator for ListExperiments

func NewListExperimentsPaginator 

func NewListExperimentsPaginator(client ListExperimentsAPIClient, params *ListExperimentsInput, optFns ...func(*ListExperimentsPaginatorOptions)) *ListExperimentsPaginator

NewListExperimentsPaginator returns a new ListExperimentsPaginator

func (*ListExperimentsPaginator) HasMorePages 

func (p *ListExperimentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExperimentsPaginator) NextPage 

func (p *ListExperimentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExperimentsOutput, error)

NextPage retrieves the next ListExperiments page.

type ListExperimentsPaginatorOptions 

type ListExperimentsPaginatorOptions struct {
	// The maximum number of results to include in the response.
	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
}

ListExperimentsPaginatorOptions is the paginator options for ListExperiments

type ListFeaturesAPIClient 

type ListFeaturesAPIClient interface {
	ListFeatures(context.Context, *ListFeaturesInput, ...func(*Options)) (*ListFeaturesOutput, error)
}

ListFeaturesAPIClient is a client that implements the ListFeatures operation.

type ListFeaturesInput 

type ListFeaturesInput struct {

	// The name or ARN of the project to return the feature list from.
	//
	// This member is required.
	Project *string

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token to use when requesting the next set of results. You received this
	// token from a previous ListFeatures operation.
	NextToken *string
	// contains filtered or unexported fields
}

type ListFeaturesOutput 

type ListFeaturesOutput struct {

	// An array of structures that contain the configuration details of the features in
	// the specified project.
	Features []types.FeatureSummary

	// The token to use in a subsequent ListFeatures operation to return the next set
	// of results.
	NextToken *string

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

type ListFeaturesPaginator 

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

ListFeaturesPaginator is a paginator for ListFeatures

func NewListFeaturesPaginator 

func NewListFeaturesPaginator(client ListFeaturesAPIClient, params *ListFeaturesInput, optFns ...func(*ListFeaturesPaginatorOptions)) *ListFeaturesPaginator

NewListFeaturesPaginator returns a new ListFeaturesPaginator

func (*ListFeaturesPaginator) HasMorePages 

func (p *ListFeaturesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFeaturesPaginator) NextPage 

func (p *ListFeaturesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFeaturesOutput, error)

NextPage retrieves the next ListFeatures page.

type ListFeaturesPaginatorOptions 

type ListFeaturesPaginatorOptions struct {
	// The maximum number of results to include in the response.
	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
}

ListFeaturesPaginatorOptions is the paginator options for ListFeatures

type ListLaunchesAPIClient 

type ListLaunchesAPIClient interface {
	ListLaunches(context.Context, *ListLaunchesInput, ...func(*Options)) (*ListLaunchesOutput, error)
}

ListLaunchesAPIClient is a client that implements the ListLaunches operation.

type ListLaunchesInput 

type ListLaunchesInput struct {

	// The name or ARN of the project to return the launch list from.
	//
	// This member is required.
	Project *string

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token to use when requesting the next set of results. You received this
	// token from a previous ListLaunches operation.
	NextToken *string

	// Use this optional parameter to limit the returned results to only the launches
	// with the status that you specify here.
	Status types.LaunchStatus
	// contains filtered or unexported fields
}

type ListLaunchesOutput 

type ListLaunchesOutput struct {

	// An array of structures that contain the configuration details of the launches in
	// the specified project.
	Launches []types.Launch

	// The token to use in a subsequent ListLaunches operation to return the next set
	// of results.
	NextToken *string

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

type ListLaunchesPaginator 

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

ListLaunchesPaginator is a paginator for ListLaunches

func NewListLaunchesPaginator 

func NewListLaunchesPaginator(client ListLaunchesAPIClient, params *ListLaunchesInput, optFns ...func(*ListLaunchesPaginatorOptions)) *ListLaunchesPaginator

NewListLaunchesPaginator returns a new ListLaunchesPaginator

func (*ListLaunchesPaginator) HasMorePages 

func (p *ListLaunchesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLaunchesPaginator) NextPage 

func (p *ListLaunchesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLaunchesOutput, error)

NextPage retrieves the next ListLaunches page.

type ListLaunchesPaginatorOptions 

type ListLaunchesPaginatorOptions struct {
	// The maximum number of results to include in the response.
	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
}

ListLaunchesPaginatorOptions is the paginator options for ListLaunches

type ListProjectsAPIClient 

type ListProjectsAPIClient interface {
	ListProjects(context.Context, *ListProjectsInput, ...func(*Options)) (*ListProjectsOutput, error)
}

ListProjectsAPIClient is a client that implements the ListProjects operation.

type ListProjectsInput 

type ListProjectsInput struct {

	// The maximum number of results to include in the response.
	MaxResults *int32

	// The token to use when requesting the next set of results. You received this
	// token from a previous ListProjects operation.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProjectsOutput 

type ListProjectsOutput struct {

	// The token to use in a subsequent ListProjects operation to return the next set
	// of results.
	NextToken *string

	// An array of structures that contain the configuration details of the projects in
	// the Region.
	Projects []types.ProjectSummary

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

type ListProjectsPaginator 

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

ListProjectsPaginator is a paginator for ListProjects

func NewListProjectsPaginator 

func NewListProjectsPaginator(client ListProjectsAPIClient, params *ListProjectsInput, optFns ...func(*ListProjectsPaginatorOptions)) *ListProjectsPaginator

NewListProjectsPaginator returns a new ListProjectsPaginator

func (*ListProjectsPaginator) HasMorePages 

func (p *ListProjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProjectsPaginator) NextPage 

func (p *ListProjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectsOutput, error)

NextPage retrieves the next ListProjects page.

type ListProjectsPaginatorOptions 

type ListProjectsPaginatorOptions struct {
	// The maximum number of results to include in the response.
	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
}

ListProjectsPaginatorOptions is the paginator options for ListProjects

type ListSegmentReferencesAPIClient added in v1.8.0 

type ListSegmentReferencesAPIClient interface {
	ListSegmentReferences(context.Context, *ListSegmentReferencesInput, ...func(*Options)) (*ListSegmentReferencesOutput, error)
}

ListSegmentReferencesAPIClient is a client that implements the ListSegmentReferences operation.

type ListSegmentReferencesInput added in v1.8.0 

type ListSegmentReferencesInput struct {

	// The ARN of the segment that you want to view information for.
	//
	// This member is required.
	Segment *string

	// Specifies whether to return information about launches or experiments that use
	// this segment.
	//
	// This member is required.
	Type types.SegmentReferenceResourceType

	// The maximum number of results to include in the response. If you omit this, the
	// default of 50 is used.
	MaxResults *int32

	// The token to use when requesting the next set of results. You received this
	// token from a previous ListSegmentReferences operation.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSegmentReferencesOutput added in v1.8.0 

type ListSegmentReferencesOutput struct {

	// The token to use in a subsequent ListSegmentReferences operation to return the
	// next set of results.
	NextToken *string

	// An array of structures, where each structure contains information about one
	// experiment or launch that uses this segment.
	ReferencedBy []types.RefResource

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

type ListSegmentReferencesPaginator added in v1.8.0 

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

ListSegmentReferencesPaginator is a paginator for ListSegmentReferences

func NewListSegmentReferencesPaginator added in v1.8.0 

func NewListSegmentReferencesPaginator(client ListSegmentReferencesAPIClient, params *ListSegmentReferencesInput, optFns ...func(*ListSegmentReferencesPaginatorOptions)) *ListSegmentReferencesPaginator

NewListSegmentReferencesPaginator returns a new ListSegmentReferencesPaginator

func (*ListSegmentReferencesPaginator) HasMorePages added in v1.8.0 

func (p *ListSegmentReferencesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSegmentReferencesPaginator) NextPage added in v1.8.0 

func (p *ListSegmentReferencesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSegmentReferencesOutput, error)

NextPage retrieves the next ListSegmentReferences page.

type ListSegmentReferencesPaginatorOptions added in v1.8.0 

type ListSegmentReferencesPaginatorOptions struct {
	// The maximum number of results to include in the response. If you omit this, the
	// default of 50 is used.
	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
}

ListSegmentReferencesPaginatorOptions is the paginator options for ListSegmentReferences

type ListSegmentsAPIClient added in v1.8.0 

type ListSegmentsAPIClient interface {
	ListSegments(context.Context, *ListSegmentsInput, ...func(*Options)) (*ListSegmentsOutput, error)
}

ListSegmentsAPIClient is a client that implements the ListSegments operation.

type ListSegmentsInput added in v1.8.0 

type ListSegmentsInput struct {

	// The maximum number of results to include in the response. If you omit this, the
	// default of 50 is used.
	MaxResults *int32

	// The token to use when requesting the next set of results. You received this
	// token from a previous ListSegments operation.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSegmentsOutput added in v1.8.0 

type ListSegmentsOutput struct {

	// The token to use in a subsequent ListSegments operation to return the next set
	// of results.
	NextToken *string

	// An array of structures that contain information about the segments in this
	// Region.
	Segments []types.Segment

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

type ListSegmentsPaginator added in v1.8.0 

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

ListSegmentsPaginator is a paginator for ListSegments

func NewListSegmentsPaginator added in v1.8.0 

func NewListSegmentsPaginator(client ListSegmentsAPIClient, params *ListSegmentsInput, optFns ...func(*ListSegmentsPaginatorOptions)) *ListSegmentsPaginator

NewListSegmentsPaginator returns a new ListSegmentsPaginator

func (*ListSegmentsPaginator) HasMorePages added in v1.8.0 

func (p *ListSegmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSegmentsPaginator) NextPage added in v1.8.0 

func (p *ListSegmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSegmentsOutput, error)

NextPage retrieves the next ListSegments page.

type ListSegmentsPaginatorOptions added in v1.8.0 

type ListSegmentsPaginatorOptions struct {
	// The maximum number of results to include in the response. If you omit this, the
	// default of 50 is used.
	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
}

ListSegmentsPaginatorOptions is the paginator options for ListSegments

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource that you want to see the tags of.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tag keys and values associated with the resource you specified.
	Tags map[string]string

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

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 PutProjectEventsInput 

type PutProjectEventsInput struct {

	// An array of event structures that contain the performance data that is being
	// sent to Evidently.
	//
	// This member is required.
	Events []types.Event

	// The name or ARN of the project to write the events to.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type PutProjectEventsOutput 

type PutProjectEventsOutput struct {

	// A structure that contains Evidently's response to the sent events, including an
	// event ID and error codes, if any.
	EventResults []types.PutProjectEventsResultEntry

	// The number of events in the operation that could not be used by Evidently.
	FailedEventCount *int32

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

type StartExperimentInput struct {

	// The date and time to end the experiment. This must be no more than 30 days after
	// the experiment starts.
	//
	// This member is required.
	AnalysisCompleteTime *time.Time

	// The name of the experiment to start.
	//
	// This member is required.
	Experiment *string

	// The name or ARN of the project that contains the experiment to start.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type StartExperimentOutput 

type StartExperimentOutput struct {

	// A timestamp that indicates when the experiment started.
	StartedTime *time.Time

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

type StartLaunchInput 

type StartLaunchInput struct {

	// The name of the launch to start.
	//
	// This member is required.
	Launch *string

	// The name or ARN of the project that contains the launch to start.
	//
	// This member is required.
	Project *string
	// contains filtered or unexported fields
}

type StartLaunchOutput 

type StartLaunchOutput struct {

	// A structure that contains information about the launch that was started.
	//
	// This member is required.
	Launch *types.Launch

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

type StopExperimentInput 

type StopExperimentInput struct {

	// The name of the experiment to stop.
	//
	// This member is required.
	Experiment *string

	// The name or ARN of the project that contains the experiment to stop.
	//
	// This member is required.
	Project *string

	// Specify whether the experiment is to be considered COMPLETED or CANCELLED after
	// it stops.
	DesiredState types.ExperimentStopDesiredState

	// A string that describes why you are stopping the experiment.
	Reason *string
	// contains filtered or unexported fields
}

type StopExperimentOutput 

type StopExperimentOutput struct {

	// The date and time that the experiment stopped.
	EndedTime *time.Time

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

type StopLaunchInput 

type StopLaunchInput struct {

	// The name of the launch to stop.
	//
	// This member is required.
	Launch *string

	// The name or ARN of the project that contains the launch that you want to stop.
	//
	// This member is required.
	Project *string

	// Specify whether to consider the launch as COMPLETED or CANCELLED after it stops.
	DesiredState types.LaunchStopDesiredState

	// A string that describes why you are stopping the launch.
	Reason *string
	// contains filtered or unexported fields
}

type StopLaunchOutput 

type StopLaunchOutput struct {

	// The date and time that the launch stopped.
	EndedTime *time.Time

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

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the CloudWatch Evidently resource that you're adding tags to.
	//
	// This member is required.
	ResourceArn *string

	// The list of key-value pairs to associate with the resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

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

type TestSegmentPatternInput added in v1.8.0 

type TestSegmentPatternInput struct {

	// The pattern to test.
	//
	// This value conforms to the media type: application/json
	//
	// This member is required.
	Pattern *string

	// A sample evaluationContext JSON block to test against the specified pattern.
	//
	// This value conforms to the media type: application/json
	//
	// This member is required.
	Payload *string
	// contains filtered or unexported fields
}

type TestSegmentPatternOutput added in v1.8.0 

type TestSegmentPatternOutput struct {

	// Returns true if the pattern matches the payload.
	//
	// This member is required.
	Match *bool

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the CloudWatch Evidently resource that you're removing tags from.
	//
	// This member is required.
	ResourceArn *string

	// The list of tag keys to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

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

type UpdateExperimentInput 

type UpdateExperimentInput struct {

	// The name of the experiment to update.
	//
	// This member is required.
	Experiment *string

	// The name or ARN of the project that contains the experiment that you want to
	// update.
	//
	// This member is required.
	Project *string

	// An optional description of the experiment.
	Description *string

	// An array of structures that defines the metrics used for the experiment, and
	// whether a higher or lower value for each metric is the goal.
	MetricGoals []types.MetricGoalConfig

	// A structure that contains the configuration of which variation o use as the
	// "control" version. The "control" version is used for comparison with other
	// variations. This structure also specifies how much experiment traffic is
	// allocated to each variation.
	OnlineAbConfig *types.OnlineAbConfig

	// When Evidently assigns a particular user session to an experiment, it must use a
	// randomization ID to determine which variation the user session is served. This
	// randomization ID is a combination of the entity ID and randomizationSalt. If you
	// omit randomizationSalt, Evidently uses the experiment name as the
	// randomizationSalt.
	RandomizationSalt *string

	// Removes a segment from being used in an experiment. You can't use this parameter
	// if the experiment is currently running.
	RemoveSegment bool

	// The portion of the available audience that you want to allocate to this
	// experiment, in thousandths of a percent. The available audience is the total
	// audience minus the audience that you have allocated to overrides or current
	// launches of this feature. This is represented in thousandths of a percent. For
	// example, specify 20,000 to allocate 20% of the available audience.
	SamplingRate *int64

	// Adds an audience segment to an experiment. When a segment is used in an
	// experiment, only user sessions that match the segment pattern are used in the
	// experiment. You can't use this parameter if the experiment is currently running.
	Segment *string

	// An array of structures that define the variations being tested in the
	// experiment.
	Treatments []types.TreatmentConfig
	// contains filtered or unexported fields
}

type UpdateExperimentOutput 

type UpdateExperimentOutput struct {

	// A structure containing the configuration details of the experiment that was
	// updated.
	//
	// This member is required.
	Experiment *types.Experiment

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

type UpdateFeatureInput 

type UpdateFeatureInput struct {

	// The name of the feature to be updated.
	//
	// This member is required.
	Feature *string

	// The name or ARN of the project that contains the feature to be updated.
	//
	// This member is required.
	Project *string

	// To update variation configurations for this feature, or add new ones, specify
	// this structure. In this array, include any variations that you want to add or
	// update. If the array includes a variation name that already exists for this
	// feature, it is updated. If it includes a new variation name, it is added as a
	// new variation.
	AddOrUpdateVariations []types.VariationConfig

	// The name of the variation to use as the default variation. The default variation
	// is served to users who are not allocated to any ongoing launches or experiments
	// of this feature.
	DefaultVariation *string

	// An optional description of the feature.
	Description *string

	// Specified users that should always be served a specific variation of a feature.
	// Each user is specified by a key-value pair . For each key, specify a user by
	// entering their user ID, account ID, or some other identifier. For the value,
	// specify the name of the variation that they are to be served.
	EntityOverrides map[string]string

	// Specify ALL_RULES to activate the traffic allocation specified by any ongoing
	// launches or experiments. Specify DEFAULT_VARIATION to serve the default
	// variation to all users instead.
	EvaluationStrategy types.FeatureEvaluationStrategy

	// Removes a variation from the feature. If the variation you specify doesn't
	// exist, then this makes no change and does not report an error. This operation
	// fails if you try to remove a variation that is part of an ongoing launch or
	// experiment.
	RemoveVariations []string
	// contains filtered or unexported fields
}

type UpdateFeatureOutput 

type UpdateFeatureOutput struct {

	// A structure that contains information about the updated feature.
	//
	// This member is required.
	Feature *types.Feature

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

type UpdateLaunchInput 

type UpdateLaunchInput struct {

	// The name of the launch that is to be updated.
	//
	// This member is required.
	Launch *string

	// The name or ARN of the project that contains the launch that you want to update.
	//
	// This member is required.
	Project *string

	// An optional description for the launch.
	Description *string

	// An array of structures that contains the feature and variations that are to be
	// used for the launch.
	Groups []types.LaunchGroupConfig

	// An array of structures that define the metrics that will be used to monitor the
	// launch performance.
	MetricMonitors []types.MetricMonitorConfig

	// When Evidently assigns a particular user session to a launch, it must use a
	// randomization ID to determine which variation the user session is served. This
	// randomization ID is a combination of the entity ID and randomizationSalt. If you
	// omit randomizationSalt, Evidently uses the launch name as the randomizationSalt.
	RandomizationSalt *string

	// An array of structures that define the traffic allocation percentages among the
	// feature variations during each step of the launch.
	ScheduledSplitsConfig *types.ScheduledSplitsLaunchConfig
	// contains filtered or unexported fields
}

type UpdateLaunchOutput 

type UpdateLaunchOutput struct {

	// A structure that contains the new configuration of the launch that was updated.
	//
	// This member is required.
	Launch *types.Launch

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

type UpdateProjectDataDeliveryInput 

type UpdateProjectDataDeliveryInput struct {

	// The name or ARN of the project that you want to modify the data storage options
	// for.
	//
	// This member is required.
	Project *string

	// A structure containing the CloudWatch Logs log group where you want to store
	// evaluation events.
	CloudWatchLogs *types.CloudWatchLogsDestinationConfig

	// A structure containing the S3 bucket name and bucket prefix where you want to
	// store evaluation events.
	S3Destination *types.S3DestinationConfig
	// contains filtered or unexported fields
}

type UpdateProjectDataDeliveryOutput 

type UpdateProjectDataDeliveryOutput struct {

	// A structure containing details about the project that you updated.
	//
	// This member is required.
	Project *types.Project

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

type UpdateProjectInput 

type UpdateProjectInput struct {

	// The name or ARN of the project to update.
	//
	// This member is required.
	Project *string

	// Use this parameter if the project will use client-side evaluation powered by
	// AppConfig. Client-side evaluation allows your application to assign variations
	// to user sessions locally instead of by calling the EvaluateFeature
	// (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html)
	// operation. This mitigates the latency and availability risks that come with an
	// API call. allows you to This parameter is a structure that contains information
	// about the AppConfig application that will be used for client-side evaluation.
	AppConfigResource *types.ProjectAppConfigResourceConfig

	// An optional description of the project.
	Description *string
	// contains filtered or unexported fields
}

type UpdateProjectOutput 

type UpdateProjectOutput struct {

	// A structure containing information about the updated project.
	//
	// This member is required.
	Project *types.Project

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