amp

package module
v1.9.1 Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2021 License: Apache-2.0 Imports: 34 Imported by: 15

Documentation

Overview

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

Amazon Managed Service for Prometheus

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 

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

Types

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)

Create an alert manager definition.

func (*Client) CreateRuleGroupsNamespace added in v1.6.0 

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

Create a rule group namespace.

func (*Client) CreateWorkspace 

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

Creates a new AMP workspace.

func (*Client) DeleteAlertManagerDefinition added in v1.6.0 

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

Deletes an alert manager definition.

func (*Client) DeleteRuleGroupsNamespace added in v1.6.0 

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

Delete a rule groups namespace.

func (*Client) DeleteWorkspace 

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

Deletes an AMP workspace.

func (*Client) DescribeAlertManagerDefinition added in v1.6.0 

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

Describes an alert manager definition.

func (*Client) DescribeRuleGroupsNamespace added in v1.6.0 

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

Describe a rule groups namespace.

func (*Client) DescribeWorkspace 

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

Describes an existing AMP workspace.

func (*Client) ListRuleGroupsNamespaces added in v1.6.0 

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

Lists rule groups namespaces.

func (*Client) ListTagsForResource added in v1.5.0 

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

Lists the tags you have assigned to the resource.

func (*Client) ListWorkspaces 

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

Lists all AMP workspaces, including workspaces being created or deleted.

func (*Client) PutAlertManagerDefinition added in v1.6.0 

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

Update an alert manager definition.

func (*Client) PutRuleGroupsNamespace added in v1.6.0 

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

Update a rule groups namespace.

func (*Client) TagResource added in v1.5.0 

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

Creates tags for the specified resource.

func (*Client) UntagResource added in v1.5.0 

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

Deletes tags from the specified resource.

func (*Client) UpdateWorkspaceAlias 

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

Updates an AMP workspace alias.

type CreateAlertManagerDefinitionInput added in v1.6.0 

type CreateAlertManagerDefinitionInput struct {

	// The alert manager definition data.
	//
	// This member is required.
	Data []byte

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

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a CreateAlertManagerDefinition operation.

type CreateAlertManagerDefinitionOutput added in v1.6.0 

type CreateAlertManagerDefinitionOutput struct {

	// The status of 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 CreateRuleGroupsNamespaceInput added in v1.6.0 

type CreateRuleGroupsNamespaceInput struct {

	// The namespace data that define the rule groups.
	//
	// This member is required.
	Data []byte

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

	// The ID of the workspace in which to create the rule group namespace.
	//
	// This member is required.
	WorkspaceId *string

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	ClientToken *string

	// Optional, user-provided tags for this 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 this rule groups namespace.
	//
	// This member is required.
	Arn *string

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

	// The status of rule groups namespace.
	//
	// This member is required.
	Status *types.RuleGroupsNamespaceStatus

	// The tags of this rule groups 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 CreateWorkspaceInput 

type CreateWorkspaceInput struct {

	// An optional user-assigned alias for this workspace. This alias is for user
	// reference and does not need to be unique.
	Alias *string

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	ClientToken *string

	// Optional, user-provided tags for this workspace.
	Tags map[string]string
	// contains filtered or unexported fields
}

Represents the input of a CreateWorkspace operation.

type CreateWorkspaceOutput 

type CreateWorkspaceOutput struct {

	// The ARN of the workspace that was just created.
	//
	// This member is required.
	Arn *string

	// The status of the workspace that was just created (usually CREATING).
	//
	// This member is required.
	Status *types.WorkspaceStatus

	// The generated ID of the workspace that was just created.
	//
	// This member is required.
	WorkspaceId *string

	// The tags of this 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 in which to delete the alert manager definition.
	//
	// This member is required.
	WorkspaceId *string

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	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 DeleteRuleGroupsNamespaceInput added in v1.6.0 

type DeleteRuleGroupsNamespaceInput struct {

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

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

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	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 DeleteWorkspaceInput 

type DeleteWorkspaceInput struct {

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

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	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 describe.
	//
	// 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 properties of the selected workspace's 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 DescribeRuleGroupsNamespaceInput added in v1.6.0 

type DescribeRuleGroupsNamespaceInput struct {

	// The rule groups namespace.
	//
	// This member is required.
	Name *string

	// The ID of the workspace to describe.
	//
	// 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 selected 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 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 {

	// The properties of the selected 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 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 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 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.
	//
	// This member is required.
	WorkspaceId *string

	// Maximum results to return in response (default=100, maximum=1000).
	MaxResults *int32

	// Optional filter for rule groups namespace name. Only the rule groups namespace
	// that begin with this value will be returned.
	Name *string

	// Pagination token to request the next page in a paginated list. This token is
	// obtained from the output of the previous ListRuleGroupsNamespaces request.
	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 list of the selected rule groups namespaces.
	//
	// This member is required.
	RuleGroupsNamespaces []types.RuleGroupsNamespaceSummary

	// Pagination token to use when requesting the next page in this list.
	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 {
	// Maximum results to return in response (default=100, maximum=1000).
	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 ListTagsForResourceInput added in v1.5.0 

type ListTagsForResourceInput struct {

	// The ARN of the 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 tags assigned to 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 {

	// Optional filter for workspace alias. Only the workspaces with aliases that begin
	// with this value will be returned.
	Alias *string

	// Maximum results to return in response (default=100, maximum=1000).
	MaxResults *int32

	// Pagination token to request the next page in a paginated list. This token is
	// obtained from the output of the previous ListWorkspaces request.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the input of a ListWorkspaces operation.

type ListWorkspacesOutput 

type ListWorkspacesOutput struct {

	// The list of existing workspaces, including those undergoing creation or
	// deletion.
	//
	// This member is required.
	Workspaces []types.WorkspaceSummary

	// Pagination token to use when requesting the next page in this list.
	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 {
	// Maximum results to return in response (default=100, maximum=1000).
	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

	// 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 endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

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

type PutAlertManagerDefinitionInput added in v1.6.0 

type PutAlertManagerDefinitionInput struct {

	// The alert manager definition data.
	//
	// This member is required.
	Data []byte

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

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	ClientToken *string
	// contains filtered or unexported fields
}

Represents the input of a PutAlertManagerDefinition operation.

type PutAlertManagerDefinitionOutput added in v1.6.0 

type PutAlertManagerDefinitionOutput struct {

	// The status of 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 namespace data that define the rule groups.
	//
	// This member is required.
	Data []byte

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

	// The ID of the workspace in which to update the rule group namespace.
	//
	// This member is required.
	WorkspaceId *string

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	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 Amazon Resource Name (ARN) of this rule groups namespace.
	//
	// This member is required.
	Arn *string

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

	// The status of rule groups namespace.
	//
	// This member is required.
	Status *types.RuleGroupsNamespaceStatus

	// The tags of this rule groups 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 TagResourceInput added in v1.5.0 

type TagResourceInput struct {

	// The ARN of the resource.
	//
	// This member is required.
	ResourceArn *string

	// The list of tags assigned to the resource.
	//
	// 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 resource.
	//
	// This member is required.
	ResourceArn *string

	// One or more tag keys
	//
	// 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 UpdateWorkspaceAliasInput 

type UpdateWorkspaceAliasInput struct {

	// The ID of the workspace being updated.
	//
	// This member is required.
	WorkspaceId *string

	// The new alias of the workspace.
	Alias *string

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	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.
	APIOptions []func(*middleware.Stack) error

	// 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.
	APIOptions []func(*middleware.Stack) error

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