amp

package module
v1.25.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: 45 Imported by: 15

Documentation

Overview

Package amp provides the API client, operations, and parameter types for Amazon Prometheus Service.

Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure. For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus (https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html) User Guide. Amazon Managed Service for Prometheus includes two APIs.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-08-01"
View Source 
const ServiceID = "amp"

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.19.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.19.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 AuthResolverParameters added in v1.19.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.19.2 

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

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

type Client 

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

Client provides the API client to make operations call for Amazon Prometheus Service.

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) CreateAlertManagerDefinition added in v1.6.0 

func (c *Client) CreateAlertManagerDefinition(ctx context.Context, params *CreateAlertManagerDefinitionInput, optFns ...func(*Options)) (*CreateAlertManagerDefinitionOutput, error)

The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition .

func (*Client) CreateLoggingConfiguration added in v1.15.0 

func (c *Client) CreateLoggingConfiguration(ctx context.Context, params *CreateLoggingConfigurationInput, optFns ...func(*Options)) (*CreateLoggingConfigurationOutput, error)

The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

func (*Client) CreateRuleGroupsNamespace added in v1.6.0 

func (c *Client) CreateRuleGroupsNamespace(ctx context.Context, params *CreateRuleGroupsNamespaceInput, optFns ...func(*Options)) (*CreateRuleGroupsNamespaceOutput, error)

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace .

func (*Client) CreateScraper added in v1.20.0 

func (c *Client) CreateScraper(ctx context.Context, params *CreateScraperInput, optFns ...func(*Options)) (*CreateScraperOutput, error)

The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace. If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS (https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper) in the Amazon Managed Service for Prometheus User Guide. You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one. The scrapeConfiguration parameter contains the base64-encoded version of the YAML configuration file. For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html) in the Amazon Managed Service for Prometheus User Guide.

func (*Client) CreateWorkspace 

func (c *Client) CreateWorkspace(ctx context.Context, params *CreateWorkspaceInput, optFns ...func(*Options)) (*CreateWorkspaceOutput, error)

Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.

func (*Client) DeleteAlertManagerDefinition added in v1.6.0 

func (c *Client) DeleteAlertManagerDefinition(ctx context.Context, params *DeleteAlertManagerDefinitionInput, optFns ...func(*Options)) (*DeleteAlertManagerDefinitionOutput, error)

Deletes the alert manager definition from a workspace.

func (*Client) DeleteLoggingConfiguration added in v1.15.0 

func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteLoggingConfigurationInput, optFns ...func(*Options)) (*DeleteLoggingConfigurationOutput, error)

Deletes the logging configuration for a workspace.

func (*Client) DeleteRuleGroupsNamespace added in v1.6.0 

func (c *Client) DeleteRuleGroupsNamespace(ctx context.Context, params *DeleteRuleGroupsNamespaceInput, optFns ...func(*Options)) (*DeleteRuleGroupsNamespaceOutput, error)

Deletes one rule groups namespace and its associated rule groups definition.

func (*Client) DeleteScraper added in v1.20.0 

func (c *Client) DeleteScraper(ctx context.Context, params *DeleteScraperInput, optFns ...func(*Options)) (*DeleteScraperOutput, error)

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

func (*Client) DeleteWorkspace 

func (c *Client) DeleteWorkspace(ctx context.Context, params *DeleteWorkspaceInput, optFns ...func(*Options)) (*DeleteWorkspaceOutput, error)

Deletes an existing workspace. When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.

func (*Client) DescribeAlertManagerDefinition added in v1.6.0 

func (c *Client) DescribeAlertManagerDefinition(ctx context.Context, params *DescribeAlertManagerDefinitionInput, optFns ...func(*Options)) (*DescribeAlertManagerDefinitionOutput, error)

Retrieves the full information about the alert manager definition for a workspace.

func (*Client) DescribeLoggingConfiguration added in v1.15.0 

func (c *Client) DescribeLoggingConfiguration(ctx context.Context, params *DescribeLoggingConfigurationInput, optFns ...func(*Options)) (*DescribeLoggingConfigurationOutput, error)

Returns complete information about the current logging configuration of the workspace.

func (*Client) DescribeRuleGroupsNamespace added in v1.6.0 

func (c *Client) DescribeRuleGroupsNamespace(ctx context.Context, params *DescribeRuleGroupsNamespaceInput, optFns ...func(*Options)) (*DescribeRuleGroupsNamespaceOutput, error)

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces .

func (*Client) DescribeScraper added in v1.20.0 

func (c *Client) DescribeScraper(ctx context.Context, params *DescribeScraperInput, optFns ...func(*Options)) (*DescribeScraperOutput, error)

The DescribeScraper operation displays information about an existing scraper.

func (*Client) DescribeWorkspace 

func (c *Client) DescribeWorkspace(ctx context.Context, params *DescribeWorkspaceInput, optFns ...func(*Options)) (*DescribeWorkspaceOutput, error)

Returns information about an existing workspace.

func (*Client) GetDefaultScraperConfiguration added in v1.20.0 

func (c *Client) GetDefaultScraperConfiguration(ctx context.Context, params *GetDefaultScraperConfigurationInput, optFns ...func(*Options)) (*GetDefaultScraperConfigurationOutput, error)

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

func (*Client) ListRuleGroupsNamespaces added in v1.6.0 

func (c *Client) ListRuleGroupsNamespaces(ctx context.Context, params *ListRuleGroupsNamespacesInput, optFns ...func(*Options)) (*ListRuleGroupsNamespacesOutput, error)

Returns a list of rule groups namespaces in a workspace.

func (*Client) ListScrapers added in v1.20.0 

func (c *Client) ListScrapers(ctx context.Context, params *ListScrapersInput, optFns ...func(*Options)) (*ListScrapersOutput, error)

The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.

func (*Client) ListTagsForResource added in v1.5.0 

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

The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces.

func (*Client) ListWorkspaces 

func (c *Client) ListWorkspaces(ctx context.Context, params *ListWorkspacesInput, optFns ...func(*Options)) (*ListWorkspacesOutput, error)

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

func (*Client) Options added in v1.21.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) PutAlertManagerDefinition added in v1.6.0 

func (c *Client) PutAlertManagerDefinition(ctx context.Context, params *PutAlertManagerDefinitionInput, optFns ...func(*Options)) (*PutAlertManagerDefinitionOutput, error)

Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition .

func (*Client) PutRuleGroupsNamespace added in v1.6.0 

func (c *Client) PutRuleGroupsNamespace(ctx context.Context, params *PutRuleGroupsNamespaceInput, optFns ...func(*Options)) (*PutRuleGroupsNamespaceOutput, error)

Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace . You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource .

func (*Client) TagResource added in v1.5.0 

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

The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. 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.

func (*Client) UntagResource added in v1.5.0 

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

Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.

func (*Client) UpdateLoggingConfiguration added in v1.15.0 

func (c *Client) UpdateLoggingConfiguration(ctx context.Context, params *UpdateLoggingConfigurationInput, optFns ...func(*Options)) (*UpdateLoggingConfigurationOutput, error)

Updates the log group ARN or the workspace ID of the current logging configuration.

func (*Client) UpdateWorkspaceAlias 

func (c *Client) UpdateWorkspaceAlias(ctx context.Context, params *UpdateWorkspaceAliasInput, optFns ...func(*Options)) (*UpdateWorkspaceAliasOutput, error)

Updates the alias of an existing workspace.

type CreateAlertManagerDefinitionInput added in v1.6.0 

type CreateAlertManagerDefinitionInput struct {

	// The alert manager definition to add. A base64-encoded version of the YAML alert
	// manager definition file. For details about the alert manager definition, see
	// AlertManagedDefinitionData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html)
	// .
	//
	// This member is required.
	Data []byte

	// The ID of the workspace to add the alert manager definition to.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a CreateAlertManagerDefinition operation.

type CreateAlertManagerDefinitionOutput added in v1.6.0 

type CreateAlertManagerDefinitionOutput struct {

	// A structure that displays the current status of the alert manager definition.
	//
	// This member is required.
	Status *types.AlertManagerDefinitionStatus

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

Represents the output of a CreateAlertManagerDefinition operation.

type CreateLoggingConfigurationInput added in v1.15.0 

type CreateLoggingConfigurationInput struct {

	// The ARN of the CloudWatch log group to which the vended log data will be
	// published. This log group must exist prior to calling this API.
	//
	// This member is required.
	LogGroupArn *string

	// The ID of the workspace to create the logging configuration for.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a CreateLoggingConfiguration operation.

type CreateLoggingConfigurationOutput added in v1.15.0 

type CreateLoggingConfigurationOutput struct {

	// A structure that displays the current status of the logging configuration.
	//
	// This member is required.
	Status *types.LoggingConfigurationStatus

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

Represents the output of a CreateLoggingConfiguration operation.

type CreateRuleGroupsNamespaceInput added in v1.6.0 

type CreateRuleGroupsNamespaceInput struct {

	// The rules file to use in the new namespace. Contains the base64-encoded version
	// of the YAML rules file. For details about the rule groups namespace structure,
	// see RuleGroupsNamespaceData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html)
	// .
	//
	// This member is required.
	Data []byte

	// The name for the new rule groups namespace.
	//
	// This member is required.
	Name *string

	// The ID of the workspace to add the rule groups namespace.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string

	// The list of tag keys and values to associate with the rule groups namespace.
	Tags map[string]string
	// contains filtered or unexported fields
}

Represents the input of a CreateRuleGroupsNamespace operation.

type CreateRuleGroupsNamespaceOutput added in v1.6.0 

type CreateRuleGroupsNamespaceOutput struct {

	// The Amazon Resource Name (ARN) of the new rule groups namespace.
	//
	// This member is required.
	Arn *string

	// The name of the new rule groups namespace.
	//
	// This member is required.
	Name *string

	// A structure that returns the current status of the rule groups namespace.
	//
	// This member is required.
	Status *types.RuleGroupsNamespaceStatus

	// The list of tag keys and values that are associated with the namespace.
	Tags map[string]string

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

Represents the output of a CreateRuleGroupsNamespace operation.

type CreateScraperInput added in v1.20.0 

type CreateScraperInput struct {

	// The Amazon Managed Service for Prometheus workspace to send metrics to.
	//
	// This member is required.
	Destination types.Destination

	// The configuration file to use in the new scraper. For more information, see
	// Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
	//
	// This member is required.
	ScrapeConfiguration types.ScrapeConfiguration

	// The Amazon EKS cluster from which the scraper will collect metrics.
	//
	// This member is required.
	Source types.Source

	// (optional) a name to associate with the scraper. This is for your use, and does
	// not need to be unique.
	Alias *string

	// (Optional) A unique, case-sensitive identifier that you can provide to ensure
	// the idempotency of the request.
	ClientToken *string

	// (Optional) The list of tag keys and values to associate with the scraper.
	Tags map[string]string
	// contains filtered or unexported fields
}

Represents the input of a CreateScraper operation.

type CreateScraperOutput added in v1.20.0 

type CreateScraperOutput struct {

	// The Amazon Resource Name (ARN) of the new scraper.
	//
	// This member is required.
	Arn *string

	// The ID of the new scraper.
	//
	// This member is required.
	ScraperId *string

	// A structure that displays the current status of the scraper.
	//
	// This member is required.
	Status *types.ScraperStatus

	// The list of tag keys and values that are associated with the scraper.
	Tags map[string]string

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

Represents the output of a CreateScraper operation.

type CreateWorkspaceInput 

type CreateWorkspaceInput struct {

	// An alias that you assign to this workspace to help you identify it. It does not
	// need to be unique. Blank spaces at the beginning or end of the alias that you
	// specify will be trimmed from the value used.
	Alias *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string

	// (optional) The ARN for a customer managed KMS key to use for encrypting data
	// within your workspace. For more information about using your own key in your
	// workspace, see Encryption at rest (https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html)
	// in the Amazon Managed Service for Prometheus User Guide.
	KmsKeyArn *string

	// The list of tag keys and values to associate with the workspace.
	Tags map[string]string
	// contains filtered or unexported fields
}

Represents the input of a CreateWorkspace operation.

type CreateWorkspaceOutput 

type CreateWorkspaceOutput struct {

	// The ARN for the new workspace.
	//
	// This member is required.
	Arn *string

	// The current status of the new workspace. Immediately after you create the
	// workspace, the status is usually CREATING .
	//
	// This member is required.
	Status *types.WorkspaceStatus

	// The unique ID for the new workspace.
	//
	// This member is required.
	WorkspaceId *string

	// (optional) If the workspace was created with a customer managed KMS key, the
	// ARN for the key used.
	KmsKeyArn *string

	// The list of tag keys and values that are associated with the workspace.
	Tags map[string]string

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

Represents the output of a CreateWorkspace operation.

type DeleteAlertManagerDefinitionInput added in v1.6.0 

type DeleteAlertManagerDefinitionInput struct {

	// The ID of the workspace to delete the alert manager definition from.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteAlertManagerDefinition operation.

type DeleteAlertManagerDefinitionOutput added in v1.6.0 

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

type DeleteLoggingConfigurationInput added in v1.15.0 

type DeleteLoggingConfigurationInput struct {

	// The ID of the workspace containing the logging configuration to delete.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteLoggingConfiguration operation.

type DeleteLoggingConfigurationOutput added in v1.15.0 

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

type DeleteRuleGroupsNamespaceInput added in v1.6.0 

type DeleteRuleGroupsNamespaceInput struct {

	// The name of the rule groups namespace to delete.
	//
	// This member is required.
	Name *string

	// The ID of the workspace containing the rule groups namespace and definition to
	// delete.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteRuleGroupsNamespace operation.

type DeleteRuleGroupsNamespaceOutput added in v1.6.0 

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

type DeleteScraperInput added in v1.20.0 

type DeleteScraperInput struct {

	// The ID of the scraper to delete.
	//
	// This member is required.
	ScraperId *string

	// (Optional) A unique, case-sensitive identifier that you can provide to ensure
	// the idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteScraper operation.

type DeleteScraperOutput added in v1.20.0 

type DeleteScraperOutput struct {

	// The ID of the scraper to delete.
	//
	// This member is required.
	ScraperId *string

	// The current status of the scraper.
	//
	// This member is required.
	Status *types.ScraperStatus

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

Represents the output of a DeleteScraper operation.

type DeleteWorkspaceInput 

type DeleteWorkspaceInput struct {

	// The ID of the workspace to delete.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a DeleteWorkspace operation.

type DeleteWorkspaceOutput 

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

type DescribeAlertManagerDefinitionInput added in v1.6.0 

type DescribeAlertManagerDefinitionInput struct {

	// The ID of the workspace to retrieve the alert manager definition from.
	//
	// This member is required.
	WorkspaceId *string
	// contains filtered or unexported fields
}

Represents the input of a DescribeAlertManagerDefinition operation.

type DescribeAlertManagerDefinitionOutput added in v1.6.0 

type DescribeAlertManagerDefinitionOutput struct {

	// The alert manager definition.
	//
	// This member is required.
	AlertManagerDefinition *types.AlertManagerDefinitionDescription

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

Represents the output of a DescribeAlertManagerDefinition operation.

type DescribeLoggingConfigurationInput added in v1.15.0 

type DescribeLoggingConfigurationInput struct {

	// The ID of the workspace to describe the logging configuration for.
	//
	// This member is required.
	WorkspaceId *string
	// contains filtered or unexported fields
}

Represents the input of a DescribeLoggingConfiguration operation.

type DescribeLoggingConfigurationOutput added in v1.15.0 

type DescribeLoggingConfigurationOutput struct {

	// A structure that displays the information about the logging configuration.
	//
	// This member is required.
	LoggingConfiguration *types.LoggingConfigurationMetadata

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

Represents the output of a DescribeLoggingConfiguration operation.

type DescribeRuleGroupsNamespaceInput added in v1.6.0 

type DescribeRuleGroupsNamespaceInput struct {

	// The name of the rule groups namespace that you want information for.
	//
	// This member is required.
	Name *string

	// The ID of the workspace containing the rule groups namespace.
	//
	// This member is required.
	WorkspaceId *string
	// contains filtered or unexported fields
}

Represents the input of a DescribeRuleGroupsNamespace operation.

type DescribeRuleGroupsNamespaceOutput added in v1.6.0 

type DescribeRuleGroupsNamespaceOutput struct {

	// The information about the rule groups namespace.
	//
	// This member is required.
	RuleGroupsNamespace *types.RuleGroupsNamespaceDescription

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

Represents the output of a DescribeRuleGroupsNamespace operation.

type DescribeScraperAPIClient added in v1.20.0 

type DescribeScraperAPIClient interface {
	DescribeScraper(context.Context, *DescribeScraperInput, ...func(*Options)) (*DescribeScraperOutput, error)
}

DescribeScraperAPIClient is a client that implements the DescribeScraper operation.

type DescribeScraperInput added in v1.20.0 

type DescribeScraperInput struct {

	// The ID of the scraper to describe.
	//
	// This member is required.
	ScraperId *string
	// contains filtered or unexported fields
}

Represents the input of a DescribeScraper operation.

type DescribeScraperOutput added in v1.20.0 

type DescribeScraperOutput struct {

	// Contains details about the scraper.
	//
	// This member is required.
	Scraper *types.ScraperDescription

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

Represents the output of a DescribeScraper operation.

type DescribeWorkspaceAPIClient added in v1.6.0 

type DescribeWorkspaceAPIClient interface {
	DescribeWorkspace(context.Context, *DescribeWorkspaceInput, ...func(*Options)) (*DescribeWorkspaceOutput, error)
}

DescribeWorkspaceAPIClient is a client that implements the DescribeWorkspace operation.

type DescribeWorkspaceInput 

type DescribeWorkspaceInput struct {

	// The ID of the workspace to describe.
	//
	// This member is required.
	WorkspaceId *string
	// contains filtered or unexported fields
}

Represents the input of a DescribeWorkspace operation.

type DescribeWorkspaceOutput 

type DescribeWorkspaceOutput struct {

	// A structure that contains details about the workspace.
	//
	// This member is required.
	Workspace *types.WorkspaceDescription

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

Represents the output of a DescribeWorkspace operation.

type EndpointParameters added in v1.17.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.17.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.17.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.17.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.17.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetDefaultScraperConfigurationInput added in v1.20.0 

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

Represents the input of a GetDefaultScraperConfiguration operation.

type GetDefaultScraperConfigurationOutput added in v1.20.0 

type GetDefaultScraperConfigurationOutput struct {

	// The configuration file. Base 64 encoded. For more information, see Scraper
	// configuration (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
	// in the Amazon Managed Service for Prometheus User Guide.
	//
	// This member is required.
	Configuration []byte

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

Represents the output of a GetDefaultScraperConfiguration operation.

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 IdempotencyTokenProvider added in v1.9.3 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListRuleGroupsNamespacesAPIClient added in v1.6.0 

type ListRuleGroupsNamespacesAPIClient interface {
	ListRuleGroupsNamespaces(context.Context, *ListRuleGroupsNamespacesInput, ...func(*Options)) (*ListRuleGroupsNamespacesOutput, error)
}

ListRuleGroupsNamespacesAPIClient is a client that implements the ListRuleGroupsNamespaces operation.

type ListRuleGroupsNamespacesInput added in v1.6.0 

type ListRuleGroupsNamespacesInput struct {

	// The ID of the workspace containing the rule groups namespaces.
	//
	// This member is required.
	WorkspaceId *string

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

	// Use this parameter to filter the rule groups namespaces that are returned. Only
	// the namespaces with names that begin with the value that you specify are
	// returned.
	Name *string

	// The token for the next set of items to return. You receive this token from a
	// previous call, and use it to get the next page of results. The other parameters
	// must be the same as the initial call. For example, if your initial request has
	// maxResults of 10, and there are 12 rule groups namespaces to return, then your
	// initial request will return 10 and a nextToken . Using the next token in a
	// subsequent call will return the remaining 2 namespaces.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListRuleGroupsNamespaces operation.

type ListRuleGroupsNamespacesOutput added in v1.6.0 

type ListRuleGroupsNamespacesOutput struct {

	// The returned list of rule groups namespaces.
	//
	// This member is required.
	RuleGroupsNamespaces []types.RuleGroupsNamespaceSummary

	// A token indicating that there are more results to retrieve. You can use this
	// token as part of your next ListRuleGroupsNamespaces request to retrieve those
	// results.
	NextToken *string

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

Represents the output of a ListRuleGroupsNamespaces operation.

type ListRuleGroupsNamespacesPaginator added in v1.6.0 

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

ListRuleGroupsNamespacesPaginator is a paginator for ListRuleGroupsNamespaces

func NewListRuleGroupsNamespacesPaginator added in v1.6.0 

func NewListRuleGroupsNamespacesPaginator(client ListRuleGroupsNamespacesAPIClient, params *ListRuleGroupsNamespacesInput, optFns ...func(*ListRuleGroupsNamespacesPaginatorOptions)) *ListRuleGroupsNamespacesPaginator

NewListRuleGroupsNamespacesPaginator returns a new ListRuleGroupsNamespacesPaginator

func (*ListRuleGroupsNamespacesPaginator) HasMorePages added in v1.6.0 

func (p *ListRuleGroupsNamespacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRuleGroupsNamespacesPaginator) NextPage added in v1.6.0 

func (p *ListRuleGroupsNamespacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRuleGroupsNamespacesOutput, error)

NextPage retrieves the next ListRuleGroupsNamespaces page.

type ListRuleGroupsNamespacesPaginatorOptions added in v1.6.0 

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

ListRuleGroupsNamespacesPaginatorOptions is the paginator options for ListRuleGroupsNamespaces

type ListScrapersAPIClient added in v1.20.0 

type ListScrapersAPIClient interface {
	ListScrapers(context.Context, *ListScrapersInput, ...func(*Options)) (*ListScrapersOutput, error)
}

ListScrapersAPIClient is a client that implements the ListScrapers operation.

type ListScrapersInput added in v1.20.0 

type ListScrapersInput struct {

	// (Optional) A list of key-value pairs to filter the list of scrapers returned.
	// Keys include status , sourceArn , destinationArn , and alias . Filters on the
	// same key are OR 'd together, and filters on different keys are AND 'd together.
	// For example, status=ACTIVE&status=CREATING&alias=Test , will return all scrapers
	// that have the alias Test, and are either in status ACTIVE or CREATING. To find
	// all active scrapers that are sending metrics to a specific Amazon Managed
	// Service for Prometheus workspace, you would use the ARN of the workspace in a
	// query:
	// status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012
	// If this is included, it filters the results to only the scrapers that match the
	// filter.
	Filters map[string][]string

	// Optional) The maximum number of scrapers to return in one ListScrapers
	// operation. The range is 1-1000. If you omit this parameter, the default of 100
	// is used.
	MaxResults *int32

	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListScrapers operation.

type ListScrapersOutput added in v1.20.0 

type ListScrapersOutput struct {

	// A list of ScraperSummary structures giving information about scrapers in the
	// account that match the filters provided.
	//
	// This member is required.
	Scrapers []types.ScraperSummary

	// A token indicating that there are more results to retrieve. You can use this
	// token as part of your next ListScrapers operation to retrieve those results.
	NextToken *string

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

Represents the output of a ListScrapers operation.

type ListScrapersPaginator added in v1.20.0 

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

ListScrapersPaginator is a paginator for ListScrapers

func NewListScrapersPaginator added in v1.20.0 

func NewListScrapersPaginator(client ListScrapersAPIClient, params *ListScrapersInput, optFns ...func(*ListScrapersPaginatorOptions)) *ListScrapersPaginator

NewListScrapersPaginator returns a new ListScrapersPaginator

func (*ListScrapersPaginator) HasMorePages added in v1.20.0 

func (p *ListScrapersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListScrapersPaginator) NextPage added in v1.20.0 

func (p *ListScrapersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListScrapersOutput, error)

NextPage retrieves the next ListScrapers page.

type ListScrapersPaginatorOptions added in v1.20.0 

type ListScrapersPaginatorOptions struct {
	// Optional) The maximum number of scrapers to return in one ListScrapers
	// operation. The range is 1-1000. If you omit this parameter, the default of 100
	// 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
}

ListScrapersPaginatorOptions is the paginator options for ListScrapers

type ListTagsForResourceInput added in v1.5.0 

type ListTagsForResourceInput struct {

	// The ARN of the resource to list tages for. Must be a workspace or rule groups
	// namespace resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.5.0 

type ListTagsForResourceOutput struct {

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

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

type ListWorkspacesAPIClient 

type ListWorkspacesAPIClient interface {
	ListWorkspaces(context.Context, *ListWorkspacesInput, ...func(*Options)) (*ListWorkspacesOutput, error)
}

ListWorkspacesAPIClient is a client that implements the ListWorkspaces operation.

type ListWorkspacesInput 

type ListWorkspacesInput struct {

	// If this is included, it filters the results to only the workspaces with names
	// that start with the value that you specify here. Amazon Managed Service for
	// Prometheus will automatically strip any blank spaces from the beginning and end
	// of the alias that you specify.
	Alias *string

	// The maximum number of workspaces to return per request. The default is 100.
	MaxResults *int32

	// The token for the next set of items to return. You receive this token from a
	// previous call, and use it to get the next page of results. The other parameters
	// must be the same as the initial call. For example, if your initial request has
	// maxResults of 10, and there are 12 workspaces to return, then your initial
	// request will return 10 and a nextToken . Using the next token in a subsequent
	// call will return the remaining 2 workspaces.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListWorkspaces operation.

type ListWorkspacesOutput 

type ListWorkspacesOutput struct {

	// An array of WorkspaceSummary structures containing information about the
	// workspaces requested.
	//
	// This member is required.
	Workspaces []types.WorkspaceSummary

	// A token indicating that there are more results to retrieve. You can use this
	// token as part of your next ListWorkspaces request to retrieve those results.
	NextToken *string

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

Represents the output of a ListWorkspaces operation.

type ListWorkspacesPaginator 

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

ListWorkspacesPaginator is a paginator for ListWorkspaces

func NewListWorkspacesPaginator 

func NewListWorkspacesPaginator(client ListWorkspacesAPIClient, params *ListWorkspacesInput, optFns ...func(*ListWorkspacesPaginatorOptions)) *ListWorkspacesPaginator

NewListWorkspacesPaginator returns a new ListWorkspacesPaginator

func (*ListWorkspacesPaginator) HasMorePages 

func (p *ListWorkspacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkspacesPaginator) NextPage 

func (p *ListWorkspacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkspacesOutput, error)

NextPage retrieves the next ListWorkspaces page.

type ListWorkspacesPaginatorOptions 

type ListWorkspacesPaginatorOptions struct {
	// The maximum number of workspaces to return per request. The default is 100.
	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
}

ListWorkspacesPaginatorOptions is the paginator options for ListWorkspaces

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

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

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

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

type PutAlertManagerDefinitionInput added in v1.6.0 

type PutAlertManagerDefinitionInput struct {

	// The alert manager definition to use. A base64-encoded version of the YAML alert
	// manager definition file. For details about the alert manager definition, see
	// AlertManagedDefinitionData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html)
	// .
	//
	// This member is required.
	Data []byte

	// The ID of the workspace to update the alert manager definition in.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a PutAlertManagerDefinition operation.

type PutAlertManagerDefinitionOutput added in v1.6.0 

type PutAlertManagerDefinitionOutput struct {

	// A structure that returns the current status of the alert manager definition.
	//
	// This member is required.
	Status *types.AlertManagerDefinitionStatus

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

Represents the output of a PutAlertManagerDefinition operation.

type PutRuleGroupsNamespaceInput added in v1.6.0 

type PutRuleGroupsNamespaceInput struct {

	// The new rules file to use in the namespace. A base64-encoded version of the
	// YAML rule groups file. For details about the rule groups namespace structure,
	// see RuleGroupsNamespaceData (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html)
	// .
	//
	// This member is required.
	Data []byte

	// The name of the rule groups namespace that you are updating.
	//
	// This member is required.
	Name *string

	// The ID of the workspace where you are updating the rule groups namespace.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a PutRuleGroupsNamespace operation.

type PutRuleGroupsNamespaceOutput added in v1.6.0 

type PutRuleGroupsNamespaceOutput struct {

	// The ARN of the rule groups namespace.
	//
	// This member is required.
	Arn *string

	// The name of the rule groups namespace that was updated.
	//
	// This member is required.
	Name *string

	// A structure that includes the current status of the rule groups namespace.
	//
	// This member is required.
	Status *types.RuleGroupsNamespaceStatus

	// The list of tag keys and values that are associated with the namespace.
	Tags map[string]string

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

Represents the output of a PutRuleGroupsNamespace operation.

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

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

ScraperActiveWaiter defines the waiters for ScraperActive

func NewScraperActiveWaiter added in v1.20.0 

func NewScraperActiveWaiter(client DescribeScraperAPIClient, optFns ...func(*ScraperActiveWaiterOptions)) *ScraperActiveWaiter

NewScraperActiveWaiter constructs a ScraperActiveWaiter.

func (*ScraperActiveWaiter) Wait added in v1.20.0 

func (w *ScraperActiveWaiter) Wait(ctx context.Context, params *DescribeScraperInput, maxWaitDur time.Duration, optFns ...func(*ScraperActiveWaiterOptions)) error

Wait calls the waiter function for ScraperActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ScraperActiveWaiter) WaitForOutput added in v1.20.0 

func (w *ScraperActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeScraperInput, maxWaitDur time.Duration, optFns ...func(*ScraperActiveWaiterOptions)) (*DescribeScraperOutput, error)

WaitForOutput calls the waiter function for ScraperActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ScraperActiveWaiterOptions added in v1.20.0 

type ScraperActiveWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ScraperActiveWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ScraperActiveWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeScraperInput, *DescribeScraperOutput, error) (bool, error)
}

ScraperActiveWaiterOptions are waiter options for ScraperActiveWaiter

type ScraperDeletedWaiter added in v1.20.0 

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

ScraperDeletedWaiter defines the waiters for ScraperDeleted

func NewScraperDeletedWaiter added in v1.20.0 

func NewScraperDeletedWaiter(client DescribeScraperAPIClient, optFns ...func(*ScraperDeletedWaiterOptions)) *ScraperDeletedWaiter

NewScraperDeletedWaiter constructs a ScraperDeletedWaiter.

func (*ScraperDeletedWaiter) Wait added in v1.20.0 

func (w *ScraperDeletedWaiter) Wait(ctx context.Context, params *DescribeScraperInput, maxWaitDur time.Duration, optFns ...func(*ScraperDeletedWaiterOptions)) error

Wait calls the waiter function for ScraperDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ScraperDeletedWaiter) WaitForOutput added in v1.20.0 

func (w *ScraperDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeScraperInput, maxWaitDur time.Duration, optFns ...func(*ScraperDeletedWaiterOptions)) (*DescribeScraperOutput, error)

WaitForOutput calls the waiter function for ScraperDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ScraperDeletedWaiterOptions added in v1.20.0 

type ScraperDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ScraperDeletedWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ScraperDeletedWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeScraperInput, *DescribeScraperOutput, error) (bool, error)
}

ScraperDeletedWaiterOptions are waiter options for ScraperDeletedWaiter

type TagResourceInput added in v1.5.0 

type TagResourceInput struct {

	// The ARN of the workspace or rule groups namespace to apply tags to.
	//
	// This member is required.
	ResourceArn *string

	// The list of tag keys and values to associate with the resource. Keys may not
	// begin with aws: .
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.5.0 

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

type UntagResourceInput added in v1.5.0 

type UntagResourceInput struct {

	// The ARN of the workspace or rule groups namespace.
	//
	// This member is required.
	ResourceArn *string

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

type UntagResourceOutput added in v1.5.0 

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

type UpdateLoggingConfigurationInput added in v1.15.0 

type UpdateLoggingConfigurationInput struct {

	// The ARN of the CloudWatch log group to which the vended log data will be
	// published.
	//
	// This member is required.
	LogGroupArn *string

	// The ID of the workspace to update the logging configuration for.
	//
	// This member is required.
	WorkspaceId *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of an UpdateLoggingConfiguration operation.

type UpdateLoggingConfigurationOutput added in v1.15.0 

type UpdateLoggingConfigurationOutput struct {

	// A structure that contains the current status of the logging configuration.
	//
	// This member is required.
	Status *types.LoggingConfigurationStatus

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

Represents the output of an UpdateLoggingConfiguration operation.

type UpdateWorkspaceAliasInput 

type UpdateWorkspaceAliasInput struct {

	// The ID of the workspace to update.
	//
	// This member is required.
	WorkspaceId *string

	// The new alias for the workspace. It does not need to be unique. Amazon Managed
	// Service for Prometheus will automatically strip any blank spaces from the
	// beginning and end of the alias that you specify.
	Alias *string

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of an UpdateWorkspaceAlias operation.

type UpdateWorkspaceAliasOutput 

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

type WorkspaceActiveWaiter added in v1.6.0 

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

WorkspaceActiveWaiter defines the waiters for WorkspaceActive

func NewWorkspaceActiveWaiter added in v1.6.0 

func NewWorkspaceActiveWaiter(client DescribeWorkspaceAPIClient, optFns ...func(*WorkspaceActiveWaiterOptions)) *WorkspaceActiveWaiter

NewWorkspaceActiveWaiter constructs a WorkspaceActiveWaiter.

func (*WorkspaceActiveWaiter) Wait added in v1.6.0 

func (w *WorkspaceActiveWaiter) Wait(ctx context.Context, params *DescribeWorkspaceInput, maxWaitDur time.Duration, optFns ...func(*WorkspaceActiveWaiterOptions)) error

Wait calls the waiter function for WorkspaceActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*WorkspaceActiveWaiter) WaitForOutput added in v1.9.0 

func (w *WorkspaceActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeWorkspaceInput, maxWaitDur time.Duration, optFns ...func(*WorkspaceActiveWaiterOptions)) (*DescribeWorkspaceOutput, error)

WaitForOutput calls the waiter function for WorkspaceActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type WorkspaceActiveWaiterOptions added in v1.6.0 

type WorkspaceActiveWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// WorkspaceActiveWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, WorkspaceActiveWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeWorkspaceInput, *DescribeWorkspaceOutput, error) (bool, error)
}

WorkspaceActiveWaiterOptions are waiter options for WorkspaceActiveWaiter

type WorkspaceDeletedWaiter added in v1.6.0 

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

WorkspaceDeletedWaiter defines the waiters for WorkspaceDeleted

func NewWorkspaceDeletedWaiter added in v1.6.0 

func NewWorkspaceDeletedWaiter(client DescribeWorkspaceAPIClient, optFns ...func(*WorkspaceDeletedWaiterOptions)) *WorkspaceDeletedWaiter

NewWorkspaceDeletedWaiter constructs a WorkspaceDeletedWaiter.

func (*WorkspaceDeletedWaiter) Wait added in v1.6.0 

func (w *WorkspaceDeletedWaiter) Wait(ctx context.Context, params *DescribeWorkspaceInput, maxWaitDur time.Duration, optFns ...func(*WorkspaceDeletedWaiterOptions)) error

Wait calls the waiter function for WorkspaceDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*WorkspaceDeletedWaiter) WaitForOutput added in v1.9.0 

func (w *WorkspaceDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeWorkspaceInput, maxWaitDur time.Duration, optFns ...func(*WorkspaceDeletedWaiterOptions)) (*DescribeWorkspaceOutput, error)

WaitForOutput calls the waiter function for WorkspaceDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type WorkspaceDeletedWaiterOptions added in v1.6.0 

type WorkspaceDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// WorkspaceDeletedWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, WorkspaceDeletedWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeWorkspaceInput, *DescribeWorkspaceOutput, error) (bool, error)
}

WorkspaceDeletedWaiterOptions are waiter options for WorkspaceDeletedWaiter

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.