lookoutmetrics

package module
v1.27.4 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 39 Imported by: 3

Documentation

Overview

Package lookoutmetrics provides the API client, operations, and parameter types for Amazon Lookout for Metrics.

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide (https://docs.aws.amazon.com/lookoutmetrics/latest/dev) .

Index

Constants

View Source
const ServiceAPIVersion = "2017-07-25"
View Source
const ServiceID = "LookoutMetrics"

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 deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.20.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.24.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.24.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type ActivateAnomalyDetectorInput

type ActivateAnomalyDetectorInput struct {

	// The ARN of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string
	// contains filtered or unexported fields
}

type ActivateAnomalyDetectorOutput

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

type AuthResolverParameters added in v1.24.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.24.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BackTestAnomalyDetectorInput

type BackTestAnomalyDetectorInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string
	// contains filtered or unexported fields
}

type BackTestAnomalyDetectorOutput

type BackTestAnomalyDetectorOutput struct {
	// 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 Lookout for Metrics.

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

func (c *Client) ActivateAnomalyDetector(ctx context.Context, params *ActivateAnomalyDetectorInput, optFns ...func(*Options)) (*ActivateAnomalyDetectorOutput, error)

Activates an anomaly detector.

func (*Client) BackTestAnomalyDetector

func (c *Client) BackTestAnomalyDetector(ctx context.Context, params *BackTestAnomalyDetectorInput, optFns ...func(*Options)) (*BackTestAnomalyDetectorOutput, error)

Runs a backtest for anomaly detection for the specified resource.

func (*Client) CreateAlert

func (c *Client) CreateAlert(ctx context.Context, params *CreateAlertInput, optFns ...func(*Options)) (*CreateAlertOutput, error)

Creates an alert for an anomaly detector.

func (*Client) CreateAnomalyDetector

func (c *Client) CreateAnomalyDetector(ctx context.Context, params *CreateAnomalyDetectorInput, optFns ...func(*Options)) (*CreateAnomalyDetectorOutput, error)

Creates an anomaly detector.

func (*Client) CreateMetricSet

func (c *Client) CreateMetricSet(ctx context.Context, params *CreateMetricSetInput, optFns ...func(*Options)) (*CreateMetricSetOutput, error)

Creates a dataset.

func (*Client) DeactivateAnomalyDetector added in v1.9.0

func (c *Client) DeactivateAnomalyDetector(ctx context.Context, params *DeactivateAnomalyDetectorInput, optFns ...func(*Options)) (*DeactivateAnomalyDetectorOutput, error)

Deactivates an anomaly detector.

func (*Client) DeleteAlert

func (c *Client) DeleteAlert(ctx context.Context, params *DeleteAlertInput, optFns ...func(*Options)) (*DeleteAlertOutput, error)

Deletes an alert.

func (*Client) DeleteAnomalyDetector

func (c *Client) DeleteAnomalyDetector(ctx context.Context, params *DeleteAnomalyDetectorInput, optFns ...func(*Options)) (*DeleteAnomalyDetectorOutput, error)

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.

func (*Client) DescribeAlert

func (c *Client) DescribeAlert(ctx context.Context, params *DescribeAlertInput, optFns ...func(*Options)) (*DescribeAlertOutput, error)

Describes an alert. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

func (*Client) DescribeAnomalyDetectionExecutions

func (c *Client) DescribeAnomalyDetectionExecutions(ctx context.Context, params *DescribeAnomalyDetectionExecutionsInput, optFns ...func(*Options)) (*DescribeAnomalyDetectionExecutionsOutput, error)

Returns information about the status of the specified anomaly detection jobs.

func (*Client) DescribeAnomalyDetector

func (c *Client) DescribeAnomalyDetector(ctx context.Context, params *DescribeAnomalyDetectorInput, optFns ...func(*Options)) (*DescribeAnomalyDetectorOutput, error)

Describes a detector. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

func (*Client) DescribeMetricSet

func (c *Client) DescribeMetricSet(ctx context.Context, params *DescribeMetricSetInput, optFns ...func(*Options)) (*DescribeMetricSetOutput, error)

Describes a dataset. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

func (*Client) DetectMetricSetConfig added in v1.12.0

func (c *Client) DetectMetricSetConfig(ctx context.Context, params *DetectMetricSetConfigInput, optFns ...func(*Options)) (*DetectMetricSetConfigOutput, error)

Detects an Amazon S3 dataset's file format, interval, and offset.

func (*Client) GetAnomalyGroup

func (c *Client) GetAnomalyGroup(ctx context.Context, params *GetAnomalyGroupInput, optFns ...func(*Options)) (*GetAnomalyGroupOutput, error)

Returns details about a group of anomalous metrics.

func (*Client) GetDataQualityMetrics added in v1.17.0

func (c *Client) GetDataQualityMetrics(ctx context.Context, params *GetDataQualityMetricsInput, optFns ...func(*Options)) (*GetDataQualityMetricsOutput, error)

Returns details about the requested data quality metrics.

func (*Client) GetFeedback

func (c *Client) GetFeedback(ctx context.Context, params *GetFeedbackInput, optFns ...func(*Options)) (*GetFeedbackOutput, error)

Get feedback for an anomaly group.

func (*Client) GetSampleData

func (c *Client) GetSampleData(ctx context.Context, params *GetSampleDataInput, optFns ...func(*Options)) (*GetSampleDataOutput, error)

Returns a selection of sample records from an Amazon S3 datasource.

func (*Client) ListAlerts

func (c *Client) ListAlerts(ctx context.Context, params *ListAlertsInput, optFns ...func(*Options)) (*ListAlertsOutput, error)

Lists the alerts attached to a detector. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

func (*Client) ListAnomalyDetectors

func (c *Client) ListAnomalyDetectors(ctx context.Context, params *ListAnomalyDetectorsInput, optFns ...func(*Options)) (*ListAnomalyDetectorsOutput, error)

Lists the detectors in the current AWS Region. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

func (*Client) ListAnomalyGroupRelatedMetrics added in v1.6.0

func (c *Client) ListAnomalyGroupRelatedMetrics(ctx context.Context, params *ListAnomalyGroupRelatedMetricsInput, optFns ...func(*Options)) (*ListAnomalyGroupRelatedMetricsOutput, error)

Returns a list of measures that are potential causes or effects of an anomaly group.

func (*Client) ListAnomalyGroupSummaries

func (c *Client) ListAnomalyGroupSummaries(ctx context.Context, params *ListAnomalyGroupSummariesInput, optFns ...func(*Options)) (*ListAnomalyGroupSummariesOutput, error)

Returns a list of anomaly groups.

func (*Client) ListAnomalyGroupTimeSeries

func (c *Client) ListAnomalyGroupTimeSeries(ctx context.Context, params *ListAnomalyGroupTimeSeriesInput, optFns ...func(*Options)) (*ListAnomalyGroupTimeSeriesOutput, error)

Gets a list of anomalous metrics for a measure in an anomaly group.

func (*Client) ListMetricSets

func (c *Client) ListMetricSets(ctx context.Context, params *ListMetricSetsInput, optFns ...func(*Options)) (*ListMetricSetsOutput, error)

Lists the datasets in the current AWS Region. Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

func (*Client) ListTagsForResource

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

Gets a list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) for a detector, dataset, or alert.

func (*Client) Options added in v1.25.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutFeedback

func (c *Client) PutFeedback(ctx context.Context, params *PutFeedbackInput, optFns ...func(*Options)) (*PutFeedbackOutput, error)

Add feedback for an anomalous metric.

func (*Client) TagResource

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

Adds tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) to a detector, dataset, or alert.

func (*Client) UntagResource

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

Removes tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) from a detector, dataset, or alert.

func (*Client) UpdateAlert added in v1.16.0

func (c *Client) UpdateAlert(ctx context.Context, params *UpdateAlertInput, optFns ...func(*Options)) (*UpdateAlertOutput, error)

Make changes to an existing alert.

func (*Client) UpdateAnomalyDetector

func (c *Client) UpdateAnomalyDetector(ctx context.Context, params *UpdateAnomalyDetectorInput, optFns ...func(*Options)) (*UpdateAnomalyDetectorOutput, error)

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

func (*Client) UpdateMetricSet

func (c *Client) UpdateMetricSet(ctx context.Context, params *UpdateMetricSetInput, optFns ...func(*Options)) (*UpdateMetricSetOutput, error)

Updates a dataset.

type CreateAlertInput

type CreateAlertInput struct {

	// Action that will be triggered when there is an alert.
	//
	// This member is required.
	Action *types.Action

	// The name of the alert.
	//
	// This member is required.
	AlertName *string

	// The ARN of the detector to which the alert is attached.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// A description of the alert.
	AlertDescription *string

	// The configuration of the alert filters, containing MetricList and
	// DimensionFilterList.
	AlertFilters *types.AlertFilters

	// An integer from 0 to 100 specifying the alert sensitivity threshold.
	AlertSensitivityThreshold int32

	// A list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html)
	// to apply to the alert.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAlertOutput

type CreateAlertOutput struct {

	// The ARN of the alert.
	AlertArn *string

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

type CreateAnomalyDetectorInput

type CreateAnomalyDetectorInput struct {

	// Contains information about the configuration of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorConfig *types.AnomalyDetectorConfig

	// The name of the detector.
	//
	// This member is required.
	AnomalyDetectorName *string

	// A description of the detector.
	AnomalyDetectorDescription *string

	// The ARN of the KMS key to use to encrypt your data.
	KmsKeyArn *string

	// A list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html)
	// to apply to the anomaly detector.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAnomalyDetectorOutput

type CreateAnomalyDetectorOutput struct {

	// The ARN of the detector.
	AnomalyDetectorArn *string

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

type CreateMetricSetInput

type CreateMetricSetInput struct {

	// The ARN of the anomaly detector that will use the dataset.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// A list of metrics that the dataset will contain.
	//
	// This member is required.
	MetricList []types.Metric

	// The name of the dataset.
	//
	// This member is required.
	MetricSetName *string

	// Contains information about how the source data should be interpreted.
	//
	// This member is required.
	MetricSource *types.MetricSource

	// A list of filters that specify which data is kept for anomaly detection.
	DimensionFilterList []types.MetricSetDimensionFilter

	// A list of the fields you want to treat as dimensions.
	DimensionList []string

	// A description of the dataset you are creating.
	MetricSetDescription *string

	// The frequency with which the source data will be analyzed for anomalies.
	MetricSetFrequency types.Frequency

	// After an interval ends, the amount of seconds that the detector waits before
	// importing data. Offset is only supported for S3, Redshift, Athena and
	// datasources.
	Offset *int32

	// A list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html)
	// to apply to the dataset.
	Tags map[string]string

	// Contains information about the column used for tracking time in your source
	// data.
	TimestampColumn *types.TimestampColumn

	// The time zone in which your source data was recorded.
	Timezone *string
	// contains filtered or unexported fields
}

type CreateMetricSetOutput

type CreateMetricSetOutput struct {

	// The ARN of the dataset.
	MetricSetArn *string

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

type DeactivateAnomalyDetectorInput added in v1.9.0

type DeactivateAnomalyDetectorInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string
	// contains filtered or unexported fields
}

type DeactivateAnomalyDetectorOutput added in v1.9.0

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

type DeleteAlertInput

type DeleteAlertInput struct {

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

type DeleteAlertOutput

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

type DeleteAnomalyDetectorInput

type DeleteAnomalyDetectorInput struct {

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

type DeleteAnomalyDetectorOutput

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

type DescribeAlertInput

type DescribeAlertInput struct {

	// The ARN of the alert to describe.
	//
	// This member is required.
	AlertArn *string
	// contains filtered or unexported fields
}

type DescribeAlertOutput

type DescribeAlertOutput struct {

	// Contains information about an alert.
	Alert *types.Alert

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

type DescribeAnomalyDetectionExecutionsAPIClient

type DescribeAnomalyDetectionExecutionsAPIClient interface {
	DescribeAnomalyDetectionExecutions(context.Context, *DescribeAnomalyDetectionExecutionsInput, ...func(*Options)) (*DescribeAnomalyDetectionExecutionsOutput, error)
}

DescribeAnomalyDetectionExecutionsAPIClient is a client that implements the DescribeAnomalyDetectionExecutions operation.

type DescribeAnomalyDetectionExecutionsInput

type DescribeAnomalyDetectionExecutionsInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// The number of items to return in the response.
	MaxResults *int32

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

	// The timestamp of the anomaly detection job.
	Timestamp *string
	// contains filtered or unexported fields
}

type DescribeAnomalyDetectionExecutionsOutput

type DescribeAnomalyDetectionExecutionsOutput struct {

	// A list of detection jobs.
	ExecutionList []types.ExecutionStatus

	// The pagination token that's included if more results are available.
	NextToken *string

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

type DescribeAnomalyDetectionExecutionsPaginator

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

DescribeAnomalyDetectionExecutionsPaginator is a paginator for DescribeAnomalyDetectionExecutions

func NewDescribeAnomalyDetectionExecutionsPaginator

NewDescribeAnomalyDetectionExecutionsPaginator returns a new DescribeAnomalyDetectionExecutionsPaginator

func (*DescribeAnomalyDetectionExecutionsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeAnomalyDetectionExecutionsPaginator) NextPage

NextPage retrieves the next DescribeAnomalyDetectionExecutions page.

type DescribeAnomalyDetectionExecutionsPaginatorOptions

type DescribeAnomalyDetectionExecutionsPaginatorOptions struct {
	// The number of items to return 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
}

DescribeAnomalyDetectionExecutionsPaginatorOptions is the paginator options for DescribeAnomalyDetectionExecutions

type DescribeAnomalyDetectorInput

type DescribeAnomalyDetectorInput struct {

	// The ARN of the detector to describe.
	//
	// This member is required.
	AnomalyDetectorArn *string
	// contains filtered or unexported fields
}

type DescribeAnomalyDetectorOutput

type DescribeAnomalyDetectorOutput struct {

	// The ARN of the detector.
	AnomalyDetectorArn *string

	// Contains information about the detector's configuration.
	AnomalyDetectorConfig *types.AnomalyDetectorConfigSummary

	// A description of the detector.
	AnomalyDetectorDescription *string

	// The name of the detector.
	AnomalyDetectorName *string

	// The time at which the detector was created.
	CreationTime *time.Time

	// The reason that the detector failed.
	FailureReason *string

	// The process that caused the detector to fail.
	FailureType types.AnomalyDetectorFailureType

	// The ARN of the KMS key to use to encrypt your data.
	KmsKeyArn *string

	// The time at which the detector was last modified.
	LastModificationTime *time.Time

	// The status of the detector.
	Status types.AnomalyDetectorStatus

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

type DescribeMetricSetInput

type DescribeMetricSetInput struct {

	// The ARN of the dataset.
	//
	// This member is required.
	MetricSetArn *string
	// contains filtered or unexported fields
}

type DescribeMetricSetOutput

type DescribeMetricSetOutput struct {

	// The ARN of the detector that contains the dataset.
	AnomalyDetectorArn *string

	// The time at which the dataset was created.
	CreationTime *time.Time

	// The dimensions and their values that were used to filter the dataset.
	DimensionFilterList []types.MetricSetDimensionFilter

	// A list of the dimensions chosen for analysis.
	DimensionList []string

	// The time at which the dataset was last modified.
	LastModificationTime *time.Time

	// A list of the metrics defined by the dataset.
	MetricList []types.Metric

	// The ARN of the dataset.
	MetricSetArn *string

	// The dataset's description.
	MetricSetDescription *string

	// The interval at which the data will be analyzed for anomalies.
	MetricSetFrequency types.Frequency

	// The name of the dataset.
	MetricSetName *string

	// Contains information about the dataset's source data.
	MetricSource *types.MetricSource

	// After an interval ends, the amount of seconds that the detector waits before
	// importing data. Offset is only supported for S3, Redshift, Athena and
	// datasources.
	Offset *int32

	// Contains information about the column used for tracking time in your source
	// data.
	TimestampColumn *types.TimestampColumn

	// The time zone in which the dataset's data was recorded.
	Timezone *string

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

type DetectMetricSetConfigInput added in v1.12.0

type DetectMetricSetConfigInput struct {

	// An anomaly detector ARN.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// A data source.
	//
	// This member is required.
	AutoDetectionMetricSource *types.AutoDetectionMetricSource
	// contains filtered or unexported fields
}

type DetectMetricSetConfigOutput added in v1.12.0

type DetectMetricSetConfigOutput struct {

	// The inferred dataset configuration for the datasource.
	DetectedMetricSetConfig *types.DetectedMetricSetConfig

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

type EndpointParameters added in v1.20.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.20.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.20.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

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 EndpointResolverV2 added in v1.20.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.20.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAnomalyGroupInput

type GetAnomalyGroupInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// The ID of the anomaly group.
	//
	// This member is required.
	AnomalyGroupId *string
	// contains filtered or unexported fields
}

type GetAnomalyGroupOutput

type GetAnomalyGroupOutput struct {

	// Details about the anomaly group.
	AnomalyGroup *types.AnomalyGroup

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

type GetDataQualityMetricsInput added in v1.17.0

type GetDataQualityMetricsInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector that you want to
	// investigate.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// The Amazon Resource Name (ARN) of a specific data quality metric set.
	MetricSetArn *string
	// contains filtered or unexported fields
}

type GetDataQualityMetricsOutput added in v1.17.0

type GetDataQualityMetricsOutput struct {

	// A list of the data quality metrics for the AnomalyDetectorArn that you
	// requested.
	AnomalyDetectorDataQualityMetricList []types.AnomalyDetectorDataQualityMetric

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

type GetFeedbackAPIClient

type GetFeedbackAPIClient interface {
	GetFeedback(context.Context, *GetFeedbackInput, ...func(*Options)) (*GetFeedbackOutput, error)
}

GetFeedbackAPIClient is a client that implements the GetFeedback operation.

type GetFeedbackInput

type GetFeedbackInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// The anomalous metric and group ID.
	//
	// This member is required.
	AnomalyGroupTimeSeriesFeedback *types.AnomalyGroupTimeSeries

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

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

type GetFeedbackOutput

type GetFeedbackOutput struct {

	// Feedback for an anomalous metric.
	AnomalyGroupTimeSeriesFeedback []types.TimeSeriesFeedback

	// The pagination token that's included if more results are available.
	NextToken *string

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

type GetFeedbackPaginator

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

GetFeedbackPaginator is a paginator for GetFeedback

func NewGetFeedbackPaginator

func NewGetFeedbackPaginator(client GetFeedbackAPIClient, params *GetFeedbackInput, optFns ...func(*GetFeedbackPaginatorOptions)) *GetFeedbackPaginator

NewGetFeedbackPaginator returns a new GetFeedbackPaginator

func (*GetFeedbackPaginator) HasMorePages

func (p *GetFeedbackPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetFeedbackPaginator) NextPage

func (p *GetFeedbackPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetFeedbackOutput, error)

NextPage retrieves the next GetFeedback page.

type GetFeedbackPaginatorOptions

type GetFeedbackPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

GetFeedbackPaginatorOptions is the paginator options for GetFeedback

type GetSampleDataInput

type GetSampleDataInput struct {

	// A datasource bucket in Amazon S3.
	S3SourceConfig *types.SampleDataS3SourceConfig
	// contains filtered or unexported fields
}

type GetSampleDataOutput

type GetSampleDataOutput struct {

	// A list of header labels for the records.
	HeaderValues []string

	// A list of records.
	SampleRows [][]string

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

type ListAlertsAPIClient interface {
	ListAlerts(context.Context, *ListAlertsInput, ...func(*Options)) (*ListAlertsOutput, error)
}

ListAlertsAPIClient is a client that implements the ListAlerts operation.

type ListAlertsInput

type ListAlertsInput struct {

	// The ARN of the alert's detector.
	AnomalyDetectorArn *string

	// The maximum number of results that will be displayed by the request.
	MaxResults *int32

	// If the result of the previous request is truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAlertsOutput

type ListAlertsOutput struct {

	// Contains information about an alert.
	AlertSummaryList []types.AlertSummary

	// If the response is truncated, the service returns this token. To retrieve the
	// next set of results, use this token in the next request.
	NextToken *string

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

type ListAlertsPaginator

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

ListAlertsPaginator is a paginator for ListAlerts

func NewListAlertsPaginator

func NewListAlertsPaginator(client ListAlertsAPIClient, params *ListAlertsInput, optFns ...func(*ListAlertsPaginatorOptions)) *ListAlertsPaginator

NewListAlertsPaginator returns a new ListAlertsPaginator

func (*ListAlertsPaginator) HasMorePages

func (p *ListAlertsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAlertsPaginator) NextPage

func (p *ListAlertsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAlertsOutput, error)

NextPage retrieves the next ListAlerts page.

type ListAlertsPaginatorOptions

type ListAlertsPaginatorOptions struct {
	// The maximum number of results that will be displayed by the request.
	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
}

ListAlertsPaginatorOptions is the paginator options for ListAlerts

type ListAnomalyDetectorsAPIClient

type ListAnomalyDetectorsAPIClient interface {
	ListAnomalyDetectors(context.Context, *ListAnomalyDetectorsInput, ...func(*Options)) (*ListAnomalyDetectorsOutput, error)
}

ListAnomalyDetectorsAPIClient is a client that implements the ListAnomalyDetectors operation.

type ListAnomalyDetectorsInput

type ListAnomalyDetectorsInput struct {

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

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAnomalyDetectorsOutput

type ListAnomalyDetectorsOutput struct {

	// A list of anomaly detectors in the account in the current region.
	AnomalyDetectorSummaryList []types.AnomalyDetectorSummary

	// If the response is truncated, the service returns this token. To retrieve the
	// next set of results, use the token in the next request.
	NextToken *string

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

type ListAnomalyDetectorsPaginator

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

ListAnomalyDetectorsPaginator is a paginator for ListAnomalyDetectors

func NewListAnomalyDetectorsPaginator

NewListAnomalyDetectorsPaginator returns a new ListAnomalyDetectorsPaginator

func (*ListAnomalyDetectorsPaginator) HasMorePages

func (p *ListAnomalyDetectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnomalyDetectorsPaginator) NextPage

NextPage retrieves the next ListAnomalyDetectors page.

type ListAnomalyDetectorsPaginatorOptions

type ListAnomalyDetectorsPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListAnomalyDetectorsPaginatorOptions is the paginator options for ListAnomalyDetectors

type ListAnomalyGroupRelatedMetricsAPIClient added in v1.6.0

type ListAnomalyGroupRelatedMetricsAPIClient interface {
	ListAnomalyGroupRelatedMetrics(context.Context, *ListAnomalyGroupRelatedMetricsInput, ...func(*Options)) (*ListAnomalyGroupRelatedMetricsOutput, error)
}

ListAnomalyGroupRelatedMetricsAPIClient is a client that implements the ListAnomalyGroupRelatedMetrics operation.

type ListAnomalyGroupRelatedMetricsInput added in v1.6.0

type ListAnomalyGroupRelatedMetricsInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// The ID of the anomaly group.
	//
	// This member is required.
	AnomalyGroupId *string

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

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

	// Filter for potential causes ( CAUSE_OF_INPUT_ANOMALY_GROUP ) or downstream
	// effects ( EFFECT_OF_INPUT_ANOMALY_GROUP ) of the anomaly group.
	RelationshipTypeFilter types.RelationshipType
	// contains filtered or unexported fields
}

type ListAnomalyGroupRelatedMetricsOutput added in v1.6.0

type ListAnomalyGroupRelatedMetricsOutput struct {

	// Aggregated details about the measures contributing to the anomaly group, and
	// the measures potentially impacted by the anomaly group.
	InterMetricImpactList []types.InterMetricImpactDetails

	// The pagination token that's included if more results are available.
	NextToken *string

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

type ListAnomalyGroupRelatedMetricsPaginator added in v1.6.0

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

ListAnomalyGroupRelatedMetricsPaginator is a paginator for ListAnomalyGroupRelatedMetrics

func NewListAnomalyGroupRelatedMetricsPaginator added in v1.6.0

NewListAnomalyGroupRelatedMetricsPaginator returns a new ListAnomalyGroupRelatedMetricsPaginator

func (*ListAnomalyGroupRelatedMetricsPaginator) HasMorePages added in v1.6.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnomalyGroupRelatedMetricsPaginator) NextPage added in v1.6.0

NextPage retrieves the next ListAnomalyGroupRelatedMetrics page.

type ListAnomalyGroupRelatedMetricsPaginatorOptions added in v1.6.0

type ListAnomalyGroupRelatedMetricsPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListAnomalyGroupRelatedMetricsPaginatorOptions is the paginator options for ListAnomalyGroupRelatedMetrics

type ListAnomalyGroupSummariesAPIClient

type ListAnomalyGroupSummariesAPIClient interface {
	ListAnomalyGroupSummaries(context.Context, *ListAnomalyGroupSummariesInput, ...func(*Options)) (*ListAnomalyGroupSummariesOutput, error)
}

ListAnomalyGroupSummariesAPIClient is a client that implements the ListAnomalyGroupSummaries operation.

type ListAnomalyGroupSummariesInput

type ListAnomalyGroupSummariesInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// The minimum severity score for inclusion in the output.
	//
	// This member is required.
	SensitivityThreshold int32

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

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

type ListAnomalyGroupSummariesOutput

type ListAnomalyGroupSummariesOutput struct {

	// Aggregated details about the anomaly groups.
	AnomalyGroupStatistics *types.AnomalyGroupStatistics

	// A list of anomaly group summaries.
	AnomalyGroupSummaryList []types.AnomalyGroupSummary

	// The pagination token that's included if more results are available.
	NextToken *string

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

type ListAnomalyGroupSummariesPaginator

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

ListAnomalyGroupSummariesPaginator is a paginator for ListAnomalyGroupSummaries

func NewListAnomalyGroupSummariesPaginator

NewListAnomalyGroupSummariesPaginator returns a new ListAnomalyGroupSummariesPaginator

func (*ListAnomalyGroupSummariesPaginator) HasMorePages

func (p *ListAnomalyGroupSummariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnomalyGroupSummariesPaginator) NextPage

NextPage retrieves the next ListAnomalyGroupSummaries page.

type ListAnomalyGroupSummariesPaginatorOptions

type ListAnomalyGroupSummariesPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListAnomalyGroupSummariesPaginatorOptions is the paginator options for ListAnomalyGroupSummaries

type ListAnomalyGroupTimeSeriesAPIClient

type ListAnomalyGroupTimeSeriesAPIClient interface {
	ListAnomalyGroupTimeSeries(context.Context, *ListAnomalyGroupTimeSeriesInput, ...func(*Options)) (*ListAnomalyGroupTimeSeriesOutput, error)
}

ListAnomalyGroupTimeSeriesAPIClient is a client that implements the ListAnomalyGroupTimeSeries operation.

type ListAnomalyGroupTimeSeriesInput

type ListAnomalyGroupTimeSeriesInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// The ID of the anomaly group.
	//
	// This member is required.
	AnomalyGroupId *string

	// The name of the measure field.
	//
	// This member is required.
	MetricName *string

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

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

type ListAnomalyGroupTimeSeriesOutput

type ListAnomalyGroupTimeSeriesOutput struct {

	// The ID of the anomaly group.
	AnomalyGroupId *string

	// The name of the measure field.
	MetricName *string

	// The pagination token that's included if more results are available.
	NextToken *string

	// A list of anomalous metrics.
	TimeSeriesList []types.TimeSeries

	// Timestamps for the anomalous metrics.
	TimestampList []string

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

type ListAnomalyGroupTimeSeriesPaginator

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

ListAnomalyGroupTimeSeriesPaginator is a paginator for ListAnomalyGroupTimeSeries

func NewListAnomalyGroupTimeSeriesPaginator

NewListAnomalyGroupTimeSeriesPaginator returns a new ListAnomalyGroupTimeSeriesPaginator

func (*ListAnomalyGroupTimeSeriesPaginator) HasMorePages

func (p *ListAnomalyGroupTimeSeriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnomalyGroupTimeSeriesPaginator) NextPage

NextPage retrieves the next ListAnomalyGroupTimeSeries page.

type ListAnomalyGroupTimeSeriesPaginatorOptions

type ListAnomalyGroupTimeSeriesPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListAnomalyGroupTimeSeriesPaginatorOptions is the paginator options for ListAnomalyGroupTimeSeries

type ListMetricSetsAPIClient

type ListMetricSetsAPIClient interface {
	ListMetricSets(context.Context, *ListMetricSetsInput, ...func(*Options)) (*ListMetricSetsOutput, error)
}

ListMetricSetsAPIClient is a client that implements the ListMetricSets operation.

type ListMetricSetsInput

type ListMetricSetsInput struct {

	// The ARN of the anomaly detector containing the metrics sets to list.
	AnomalyDetectorArn *string

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

	// If the result of the previous request was truncated, the response includes a
	// NextToken . To retrieve the next set of results, use the token in the next
	// request. Tokens expire after 24 hours.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMetricSetsOutput

type ListMetricSetsOutput struct {

	// A list of the datasets in the AWS Region, with configuration details for each.
	MetricSetSummaryList []types.MetricSetSummary

	// If the response is truncated, the list call returns this token. To retrieve the
	// next set of results, use the token in the next list request.
	NextToken *string

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

type ListMetricSetsPaginator

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

ListMetricSetsPaginator is a paginator for ListMetricSets

func NewListMetricSetsPaginator

func NewListMetricSetsPaginator(client ListMetricSetsAPIClient, params *ListMetricSetsInput, optFns ...func(*ListMetricSetsPaginatorOptions)) *ListMetricSetsPaginator

NewListMetricSetsPaginator returns a new ListMetricSetsPaginator

func (*ListMetricSetsPaginator) HasMorePages

func (p *ListMetricSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMetricSetsPaginator) NextPage

func (p *ListMetricSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMetricSetsOutput, error)

NextPage retrieves the next ListMetricSets page.

type ListMetricSetsPaginatorOptions

type ListMetricSetsPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListMetricSetsPaginatorOptions is the paginator options for ListMetricSets

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The resource's Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The resource's tags.
	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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.24.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutFeedbackInput

type PutFeedbackInput struct {

	// The Amazon Resource Name (ARN) of the anomaly detector.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// Feedback for an anomalous metric.
	//
	// This member is required.
	AnomalyGroupTimeSeriesFeedback *types.AnomalyGroupTimeSeriesFeedback
	// contains filtered or unexported fields
}

type PutFeedbackOutput

type PutFeedbackOutput struct {
	// 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 (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// The resource's Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string

	// Tags to apply to the resource. Tag keys and values can contain letters,
	// numbers, spaces, and the following symbols: _.:/=+@-
	//
	// 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 UntagResourceInput

type UntagResourceInput struct {

	// The resource's Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string

	// Keys to remove from the resource's tags.
	//
	// 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 UpdateAlertInput added in v1.16.0

type UpdateAlertInput struct {

	// The ARN of the alert to update.
	//
	// This member is required.
	AlertArn *string

	// Action that will be triggered when there is an alert.
	Action *types.Action

	// A description of the alert.
	AlertDescription *string

	// The configuration of the alert filters, containing MetricList and
	// DimensionFilterList.
	AlertFilters *types.AlertFilters

	// An integer from 0 to 100 specifying the alert sensitivity threshold.
	AlertSensitivityThreshold int32
	// contains filtered or unexported fields
}

type UpdateAlertOutput added in v1.16.0

type UpdateAlertOutput struct {

	// The ARN of the updated alert.
	AlertArn *string

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

type UpdateAnomalyDetectorInput

type UpdateAnomalyDetectorInput struct {

	// The ARN of the detector to update.
	//
	// This member is required.
	AnomalyDetectorArn *string

	// Contains information about the configuration to which the detector will be
	// updated.
	AnomalyDetectorConfig *types.AnomalyDetectorConfig

	// The updated detector description.
	AnomalyDetectorDescription *string

	// The Amazon Resource Name (ARN) of an AWS KMS encryption key.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

type UpdateAnomalyDetectorOutput

type UpdateAnomalyDetectorOutput struct {

	// The ARN of the updated detector.
	AnomalyDetectorArn *string

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

type UpdateMetricSetInput

type UpdateMetricSetInput struct {

	// The ARN of the dataset to update.
	//
	// This member is required.
	MetricSetArn *string

	// Describes a list of filters for choosing specific dimensions and specific
	// values. Each filter consists of the dimension and one of its values that you
	// want to include. When multiple dimensions or values are specified, the
	// dimensions are joined with an AND operation and the values are joined with an OR
	// operation.
	DimensionFilterList []types.MetricSetDimensionFilter

	// The dimension list.
	DimensionList []string

	// The metric list.
	MetricList []types.Metric

	// The dataset's description.
	MetricSetDescription *string

	// The dataset's interval.
	MetricSetFrequency types.Frequency

	// Contains information about source data used to generate metrics.
	MetricSource *types.MetricSource

	// After an interval ends, the amount of seconds that the detector waits before
	// importing data. Offset is only supported for S3, Redshift, Athena and
	// datasources.
	Offset *int32

	// The timestamp column.
	TimestampColumn *types.TimestampColumn
	// contains filtered or unexported fields
}

type UpdateMetricSetOutput

type UpdateMetricSetOutput struct {

	// The ARN of the dataset.
	MetricSetArn *string

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

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL