notifications

package module
v1.1.3 Latest Latest
Warning

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

Go to latest
Published: Jan 31, 2025 License: Apache-2.0 Imports: 43 Imported by: 2

Documentation

Overview

Package notifications provides the API client, operations, and parameter types for AWS User Notifications.

The Amazon Web Services User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.

User Notification control plane APIs are currently available in US East (Virginia) - us-east-1 .

GetNotificationEventand ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called.

The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hubin addition to US East (Virginia).

Index

Constants

View Source
const ServiceAPIVersion = "2018-05-10"
View Source
const ServiceID = "Notifications"

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

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName

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

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 AssociateChannelInput

type AssociateChannelInput struct {

	// The Amazon Resource Name (ARN) of the Channel to associate with the
	// NotificationConfiguration .
	//
	// Supported ARNs include Chatbot, the Console Mobile Application, and
	// notifications-contacts.
	//
	// This member is required.
	Arn *string

	// The ARN of the NotificationConfiguration to associate with the Channel.
	//
	// This member is required.
	NotificationConfigurationArn *string
	// contains filtered or unexported fields
}

type AssociateChannelOutput

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

type AssociateManagedNotificationAccountContactInput added in v1.1.0

type AssociateManagedNotificationAccountContactInput struct {

	// A unique value of an Account Contact Type to associate with the
	// ManagedNotificationConfiguration .
	//
	// This member is required.
	ContactIdentifier types.AccountContactType

	// The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to
	// associate with the Account Contact.
	//
	// This member is required.
	ManagedNotificationConfigurationArn *string
	// contains filtered or unexported fields
}

type AssociateManagedNotificationAccountContactOutput added in v1.1.0

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

type AssociateManagedNotificationAdditionalChannelInput added in v1.1.0

type AssociateManagedNotificationAdditionalChannelInput struct {

	// The Amazon Resource Name (ARN) of the Channel to associate with the
	// ManagedNotificationConfiguration .
	//
	// Supported ARNs include Chatbot, the Console Mobile Application, and email
	// (notifications-contacts).
	//
	// This member is required.
	ChannelArn *string

	// The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to
	// associate with the additional Channel.
	//
	// This member is required.
	ManagedNotificationConfigurationArn *string
	// contains filtered or unexported fields
}

type AssociateManagedNotificationAdditionalChannelOutput added in v1.1.0

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

type AuthResolverParameters

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

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 AWS User Notifications.

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

func (c *Client) AssociateChannel(ctx context.Context, params *AssociateChannelInput, optFns ...func(*Options)) (*AssociateChannelOutput, error)

Associates a delivery Channel with a particular NotificationConfiguration . Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

func (*Client) AssociateManagedNotificationAccountContact added in v1.1.0

func (c *Client) AssociateManagedNotificationAccountContact(ctx context.Context, params *AssociateManagedNotificationAccountContactInput, optFns ...func(*Options)) (*AssociateManagedNotificationAccountContactOutput, error)

Associates an Account Contact with a particular ManagedNotificationConfiguration .

func (*Client) AssociateManagedNotificationAdditionalChannel added in v1.1.0

func (c *Client) AssociateManagedNotificationAdditionalChannel(ctx context.Context, params *AssociateManagedNotificationAdditionalChannelInput, optFns ...func(*Options)) (*AssociateManagedNotificationAdditionalChannelOutput, error)

Associates an additional Channel with a particular ManagedNotificationConfiguration .

Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

func (*Client) CreateEventRule

func (c *Client) CreateEventRule(ctx context.Context, params *CreateEventRuleInput, optFns ...func(*Options)) (*CreateEventRuleOutput, error)

Creates an EventRuleEventRule that is associated with a specified NotificationConfiguration .

func (*Client) CreateNotificationConfiguration

func (c *Client) CreateNotificationConfiguration(ctx context.Context, params *CreateNotificationConfigurationInput, optFns ...func(*Options)) (*CreateNotificationConfigurationOutput, error)

Creates a new NotificationConfiguration .

func (*Client) DeleteEventRule

func (c *Client) DeleteEventRule(ctx context.Context, params *DeleteEventRuleInput, optFns ...func(*Options)) (*DeleteEventRuleOutput, error)

Deletes an EventRule .

func (*Client) DeleteNotificationConfiguration

func (c *Client) DeleteNotificationConfiguration(ctx context.Context, params *DeleteNotificationConfigurationInput, optFns ...func(*Options)) (*DeleteNotificationConfigurationOutput, error)

Deletes a NotificationConfiguration .

func (*Client) DeregisterNotificationHub

func (c *Client) DeregisterNotificationHub(ctx context.Context, params *DeregisterNotificationHubInput, optFns ...func(*Options)) (*DeregisterNotificationHubOutput, error)

Deregisters a NotificationConfiguration in the specified Region.

You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationConfiguration are no longer be visible. Recreating a new NotificationConfiguration in the same Region restores access to those NotificationEvents .

func (*Client) DisableNotificationsAccessForOrganization added in v1.1.0

func (c *Client) DisableNotificationsAccessForOrganization(ctx context.Context, params *DisableNotificationsAccessForOrganizationInput, optFns ...func(*Options)) (*DisableNotificationsAccessForOrganizationOutput, error)

Disables service trust between User Notifications and Amazon Web Services Organizations.

func (*Client) DisassociateChannel

func (c *Client) DisassociateChannel(ctx context.Context, params *DisassociateChannelInput, optFns ...func(*Options)) (*DisassociateChannelOutput, error)

Disassociates a Channel from a specified NotificationConfiguration . Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

func (*Client) DisassociateManagedNotificationAccountContact added in v1.1.0

func (c *Client) DisassociateManagedNotificationAccountContact(ctx context.Context, params *DisassociateManagedNotificationAccountContactInput, optFns ...func(*Options)) (*DisassociateManagedNotificationAccountContactOutput, error)

Disassociates an Account Contact with a particular ManagedNotificationConfiguration .

func (*Client) DisassociateManagedNotificationAdditionalChannel added in v1.1.0

func (c *Client) DisassociateManagedNotificationAdditionalChannel(ctx context.Context, params *DisassociateManagedNotificationAdditionalChannelInput, optFns ...func(*Options)) (*DisassociateManagedNotificationAdditionalChannelOutput, error)

Disassociates an additional Channel from a particular ManagedNotificationConfiguration .

Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).

func (*Client) EnableNotificationsAccessForOrganization added in v1.1.0

func (c *Client) EnableNotificationsAccessForOrganization(ctx context.Context, params *EnableNotificationsAccessForOrganizationInput, optFns ...func(*Options)) (*EnableNotificationsAccessForOrganizationOutput, error)

Enables service trust between User Notifications and Amazon Web Services Organizations.

func (*Client) GetEventRule

func (c *Client) GetEventRule(ctx context.Context, params *GetEventRuleInput, optFns ...func(*Options)) (*GetEventRuleOutput, error)

Returns a specified EventRule .

func (*Client) GetManagedNotificationChildEvent added in v1.1.0

func (c *Client) GetManagedNotificationChildEvent(ctx context.Context, params *GetManagedNotificationChildEventInput, optFns ...func(*Options)) (*GetManagedNotificationChildEventOutput, error)

Returns the child event of a specific given ManagedNotificationEvent .

func (*Client) GetManagedNotificationConfiguration added in v1.1.0

func (c *Client) GetManagedNotificationConfiguration(ctx context.Context, params *GetManagedNotificationConfigurationInput, optFns ...func(*Options)) (*GetManagedNotificationConfigurationOutput, error)

Returns a specified ManagedNotificationConfiguration .

func (*Client) GetManagedNotificationEvent added in v1.1.0

func (c *Client) GetManagedNotificationEvent(ctx context.Context, params *GetManagedNotificationEventInput, optFns ...func(*Options)) (*GetManagedNotificationEventOutput, error)

Returns a specified ManagedNotificationEvent .

func (*Client) GetNotificationConfiguration

func (c *Client) GetNotificationConfiguration(ctx context.Context, params *GetNotificationConfigurationInput, optFns ...func(*Options)) (*GetNotificationConfigurationOutput, error)

Returns a specified NotificationConfiguration .

func (*Client) GetNotificationEvent

func (c *Client) GetNotificationEvent(ctx context.Context, params *GetNotificationEventInput, optFns ...func(*Options)) (*GetNotificationEventOutput, error)

Returns a specified NotificationEvent .

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubsin the Amazon Web Services User Notifications User Guide.

func (*Client) GetNotificationsAccessForOrganization added in v1.1.0

func (c *Client) GetNotificationsAccessForOrganization(ctx context.Context, params *GetNotificationsAccessForOrganizationInput, optFns ...func(*Options)) (*GetNotificationsAccessForOrganizationOutput, error)

Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.

func (*Client) ListChannels

func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error)

Returns a list of Channels for a NotificationConfiguration .

func (*Client) ListEventRules

func (c *Client) ListEventRules(ctx context.Context, params *ListEventRulesInput, optFns ...func(*Options)) (*ListEventRulesOutput, error)

Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).

func (*Client) ListManagedNotificationChannelAssociations added in v1.1.0

func (c *Client) ListManagedNotificationChannelAssociations(ctx context.Context, params *ListManagedNotificationChannelAssociationsInput, optFns ...func(*Options)) (*ListManagedNotificationChannelAssociationsOutput, error)

Returns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration , in paginated format.

func (*Client) ListManagedNotificationChildEvents added in v1.1.0

func (c *Client) ListManagedNotificationChildEvents(ctx context.Context, params *ListManagedNotificationChildEventsInput, optFns ...func(*Options)) (*ListManagedNotificationChildEventsOutput, error)

Returns a list of ManagedNotificationChildEvents for a specified aggregate ManagedNotificationEvent , ordered by creation time in reverse chronological order (newest first).

func (*Client) ListManagedNotificationConfigurations added in v1.1.0

func (c *Client) ListManagedNotificationConfigurations(ctx context.Context, params *ListManagedNotificationConfigurationsInput, optFns ...func(*Options)) (*ListManagedNotificationConfigurationsOutput, error)

Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).

func (*Client) ListManagedNotificationEvents added in v1.1.0

func (c *Client) ListManagedNotificationEvents(ctx context.Context, params *ListManagedNotificationEventsInput, optFns ...func(*Options)) (*ListManagedNotificationEventsOutput, error)

Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).

func (*Client) ListNotificationConfigurations

func (c *Client) ListNotificationConfigurations(ctx context.Context, params *ListNotificationConfigurationsInput, optFns ...func(*Options)) (*ListNotificationConfigurationsOutput, error)

Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).

func (*Client) ListNotificationEvents

func (c *Client) ListNotificationEvents(ctx context.Context, params *ListNotificationEventsInput, optFns ...func(*Options)) (*ListNotificationEventsOutput, error)

Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).

User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubsin the Amazon Web Services User Notifications User Guide.

func (*Client) ListNotificationHubs

func (c *Client) ListNotificationHubs(ctx context.Context, params *ListNotificationHubsInput, optFns ...func(*Options)) (*ListNotificationHubsOutput, error)

Returns a list of NotificationHubs .

func (*Client) ListTagsForResource

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

Returns a list of tags for a specified Amazon Resource Name (ARN).

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

This is only supported for NotificationConfigurations .

func (*Client) Options

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

func (c *Client) RegisterNotificationHub(ctx context.Context, params *RegisterNotificationHubInput, optFns ...func(*Options)) (*RegisterNotificationHubOutput, error)

Registers a NotificationConfiguration in the specified Region.

There is a maximum of one NotificationConfiguration per Region. You can have a maximum of 3 NotificationHub resources at a time.

func (*Client) TagResource

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

Tags the resource with a tag key and value.

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

This is only supported for NotificationConfigurations .

func (*Client) UntagResource

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

Untags a resource with a specified Amazon Resource Name (ARN).

For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.

func (*Client) UpdateEventRule

func (c *Client) UpdateEventRule(ctx context.Context, params *UpdateEventRuleInput, optFns ...func(*Options)) (*UpdateEventRuleOutput, error)

Updates an existing EventRule .

func (*Client) UpdateNotificationConfiguration

func (c *Client) UpdateNotificationConfiguration(ctx context.Context, params *UpdateNotificationConfigurationInput, optFns ...func(*Options)) (*UpdateNotificationConfigurationOutput, error)

Updates a NotificationConfiguration .

type CreateEventRuleInput

type CreateEventRuleInput struct {

	// The event type to match.
	//
	// Must match one of the valid Amazon EventBridge event types. For example, EC2
	// Instance State-change Notification and Amazon CloudWatch Alarm State Change. For
	// more information, see [Event delivery from Amazon Web Services services]in the Amazon EventBridge User Guide.
	//
	// [Event delivery from Amazon Web Services services]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
	//
	// This member is required.
	EventType *string

	// The Amazon Resource Name (ARN) of the NotificationConfiguration associated with
	// this EventRule .
	//
	// This member is required.
	NotificationConfigurationArn *string

	// A list of Amazon Web Services Regions that send events to this EventRule .
	//
	// This member is required.
	Regions []string

	// The matched event source.
	//
	// Must match one of the valid EventBridge sources. Only Amazon Web Services
	// service sourced events are supported. For example, aws.ec2 and aws.cloudwatch .
	// For more information, see [Event delivery from Amazon Web Services services]in the Amazon EventBridge User Guide.
	//
	// [Event delivery from Amazon Web Services services]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
	//
	// This member is required.
	Source *string

	// An additional event pattern used to further filter the events this EventRule
	// receives.
	//
	// For more information, see [Amazon EventBridge event patterns] in the Amazon EventBridge User Guide.
	//
	// [Amazon EventBridge event patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
	EventPattern *string
	// contains filtered or unexported fields
}

type CreateEventRuleOutput

type CreateEventRuleOutput struct {

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

	// The ARN of a NotificationConfiguration .
	//
	// This member is required.
	NotificationConfigurationArn *string

	// A list of an EventRule 's status by Region. Regions are mapped to
	// EventRuleStatusSummary .
	//
	// This member is required.
	StatusSummaryByRegion map[string]types.EventRuleStatusSummary

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

type CreateNotificationConfigurationInput

type CreateNotificationConfigurationInput struct {

	// The description of the NotificationConfiguration .
	//
	// This member is required.
	Description *string

	// The name of the NotificationConfiguration . Supports RFC 3986's unreserved
	// characters.
	//
	// This member is required.
	Name *string

	// The aggregation preference of the NotificationConfiguration .
	//
	//   - Values:
	//
	//   - LONG
	//
	//   - Aggregate notifications for long periods of time (12 hours).
	//
	//   - SHORT
	//
	//   - Aggregate notifications for short periods of time (5 minutes).
	//
	//   - NONE
	//
	//   - Don't aggregate notifications.
	AggregationDuration types.AggregationDuration

	// A map of tags assigned to a resource. A tag is a string-to-string map of
	// key-value pairs.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateNotificationConfigurationOutput

type CreateNotificationConfigurationOutput struct {

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

	// The current status of this NotificationConfiguration .
	//
	// This member is required.
	Status types.NotificationConfigurationStatus

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

type DeleteEventRuleInput

type DeleteEventRuleInput struct {

	// The Amazon Resource Name (ARN) of the EventRule to delete.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteEventRuleOutput

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

type DeleteNotificationConfigurationInput

type DeleteNotificationConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteNotificationConfigurationOutput

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

type DeregisterNotificationHubInput

type DeregisterNotificationHubInput struct {

	// The NotificationConfiguration Region.
	//
	// This member is required.
	NotificationHubRegion *string
	// contains filtered or unexported fields
}

type DeregisterNotificationHubOutput

type DeregisterNotificationHubOutput struct {

	// The NotificationConfiguration Region.
	//
	// This member is required.
	NotificationHubRegion *string

	// NotificationConfiguration status information.
	//
	// This member is required.
	StatusSummary *types.NotificationHubStatusSummary

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

type DisableNotificationsAccessForOrganizationInput added in v1.1.0

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

type DisableNotificationsAccessForOrganizationOutput added in v1.1.0

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

type DisassociateChannelInput

type DisassociateChannelInput struct {

	// The Amazon Resource Name (ARN) of the Channel to disassociate.
	//
	// This member is required.
	Arn *string

	// The ARN of the NotificationConfiguration to disassociate.
	//
	// This member is required.
	NotificationConfigurationArn *string
	// contains filtered or unexported fields
}

type DisassociateChannelOutput

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

type DisassociateManagedNotificationAccountContactInput added in v1.1.0

type DisassociateManagedNotificationAccountContactInput struct {

	// The unique value of an Account Contact Type to associate with the
	// ManagedNotificationConfiguration .
	//
	// This member is required.
	ContactIdentifier types.AccountContactType

	// The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to
	// associate with the Account Contact.
	//
	// This member is required.
	ManagedNotificationConfigurationArn *string
	// contains filtered or unexported fields
}

type DisassociateManagedNotificationAccountContactOutput added in v1.1.0

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

type DisassociateManagedNotificationAdditionalChannelInput added in v1.1.0

type DisassociateManagedNotificationAdditionalChannelInput struct {

	// The Amazon Resource Name (ARN) of the Channel to associate with the
	// ManagedNotificationConfiguration .
	//
	// This member is required.
	ChannelArn *string

	// The Amazon Resource Name (ARN) of the Managed Notification Configuration to
	// associate with the additional Channel.
	//
	// This member is required.
	ManagedNotificationConfigurationArn *string
	// contains filtered or unexported fields
}

type DisassociateManagedNotificationAdditionalChannelOutput added in v1.1.0

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

type EnableNotificationsAccessForOrganizationInput added in v1.1.0

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

type EnableNotificationsAccessForOrganizationOutput added in v1.1.0

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

type EndpointParameters

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

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults

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

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

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetEventRuleInput

type GetEventRuleInput struct {

	// The Amazon Resource Name (ARN) of the EventRule to return.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetEventRuleOutput

type GetEventRuleOutput struct {

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

	// The date when the EventRule was created.
	//
	// This member is required.
	CreationTime *time.Time

	// An additional event pattern used to further filter the events this EventRule
	// receives.
	//
	// For more information, see [Amazon EventBridge event patterns] in the Amazon EventBridge User Guide.
	//
	// [Amazon EventBridge event patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
	//
	// This member is required.
	EventPattern *string

	// The event type to match.
	//
	// Must match one of the valid Amazon EventBridge event types. For example, EC2
	// Instance State-change Notification and Amazon CloudWatch Alarm State Change. For
	// more information, see [Event delivery from Amazon Web Services services]in the Amazon EventBridge User Guide.
	//
	// [Event delivery from Amazon Web Services services]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
	//
	// This member is required.
	EventType *string

	// A list of managed rules from EventBridge that are associated with this EventRule
	// .
	//
	// These are created by User Notifications within your account so this EventRule
	// functions.
	//
	// This member is required.
	ManagedRules []string

	// The ARN of a NotificationConfiguration .
	//
	// This member is required.
	NotificationConfigurationArn *string

	// A list of Amazon Web Services Regions that send events to this EventRule .
	//
	// This member is required.
	Regions []string

	// The matched event source.
	//
	// Must match one of the valid EventBridge sources. Only Amazon Web Services
	// service sourced events are supported. For example, aws.ec2 and aws.cloudwatch .
	// For more information, see [Event delivery from Amazon Web Services services]in the Amazon EventBridge User Guide.
	//
	// [Event delivery from Amazon Web Services services]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
	//
	// This member is required.
	Source *string

	// A list of an EventRule 's status by Region. Regions are mapped to
	// EventRuleStatusSummary .
	//
	// This member is required.
	StatusSummaryByRegion map[string]types.EventRuleStatusSummary

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

type GetManagedNotificationChildEventInput added in v1.1.0

type GetManagedNotificationChildEventInput struct {

	// The Amazon Resource Name (ARN) of the ManagedNotificationChildEvent to return.
	//
	// This member is required.
	Arn *string

	// The locale code of the language used for the retrieved
	// ManagedNotificationChildEvent . The default locale is English en_US .
	Locale types.LocaleCode
	// contains filtered or unexported fields
}

type GetManagedNotificationChildEventOutput added in v1.1.0

type GetManagedNotificationChildEventOutput struct {

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

	// The content of the ManagedNotificationChildEvent .
	//
	// This member is required.
	Content *types.ManagedNotificationChildEvent

	// The creation time of the ManagedNotificationChildEvent .
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration
	// associated with the ManagedNotificationChildEvent .
	//
	// This member is required.
	ManagedNotificationConfigurationArn *string

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

type GetManagedNotificationConfigurationInput added in v1.1.0

type GetManagedNotificationConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to
	// return.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetManagedNotificationConfigurationOutput added in v1.1.0

type GetManagedNotificationConfigurationOutput struct {

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

	// The category of the ManagedNotificationConfiguration .
	//
	// This member is required.
	Category *string

	// The description of the ManagedNotificationConfiguration .
	//
	// This member is required.
	Description *string

	// The name of the ManagedNotificationConfiguration .
	//
	// This member is required.
	Name *string

	// The subCategory of the ManagedNotificationConfiguration .
	//
	// This member is required.
	SubCategory *string

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

type GetManagedNotificationEventInput added in v1.1.0

type GetManagedNotificationEventInput struct {

	// The Amazon Resource Name (ARN) of the ManagedNotificationEvent to return.
	//
	// This member is required.
	Arn *string

	// The locale code of the language used for the retrieved ManagedNotificationEvent
	// . The default locale is English (en_US) .
	Locale types.LocaleCode
	// contains filtered or unexported fields
}

type GetManagedNotificationEventOutput added in v1.1.0

type GetManagedNotificationEventOutput struct {

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

	// The content of the ManagedNotificationEvent .
	//
	// This member is required.
	Content *types.ManagedNotificationEvent

	// The creation time of the ManagedNotificationEvent .
	//
	// This member is required.
	CreationTime *time.Time

	// The ARN of the ManagedNotificationConfiguration .
	//
	// This member is required.
	ManagedNotificationConfigurationArn *string

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

type GetNotificationConfigurationInput

type GetNotificationConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the NotificationConfiguration to return.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetNotificationConfigurationOutput

type GetNotificationConfigurationOutput struct {

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

	// The creation time of the NotificationConfiguration .
	//
	// This member is required.
	CreationTime *time.Time

	// The description of the NotificationConfiguration .
	//
	// This member is required.
	Description *string

	// The name of the NotificationConfiguration .
	//
	// This member is required.
	Name *string

	// The status of this NotificationConfiguration .
	//
	// This member is required.
	Status types.NotificationConfigurationStatus

	// The aggregation preference of the NotificationConfiguration .
	//
	//   - Values:
	//
	//   - LONG
	//
	//   - Aggregate notifications for long periods of time (12 hours).
	//
	//   - SHORT
	//
	//   - Aggregate notifications for short periods of time (5 minutes).
	//
	//   - NONE
	//
	//   - Don't aggregate notifications.
	AggregationDuration types.AggregationDuration

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

type GetNotificationEventInput

type GetNotificationEventInput struct {

	// The Amazon Resource Name (ARN) of the NotificationEvent to return.
	//
	// This member is required.
	Arn *string

	// The locale code of the language used for the retrieved NotificationEvent . The
	// default locale is English en_US .
	Locale types.LocaleCode
	// contains filtered or unexported fields
}

type GetNotificationEventOutput

type GetNotificationEventOutput struct {

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

	// The content of the NotificationEvent .
	//
	// This member is required.
	Content *types.NotificationEventSchema

	// The creation time of the NotificationEvent .
	//
	// This member is required.
	CreationTime *time.Time

	// The ARN of the NotificationConfiguration .
	//
	// This member is required.
	NotificationConfigurationArn *string

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

type GetNotificationsAccessForOrganizationInput added in v1.1.0

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

type GetNotificationsAccessForOrganizationOutput added in v1.1.0

type GetNotificationsAccessForOrganizationOutput struct {

	// The AccessStatus of Service Trust Enablement for User Notifications to Amazon
	// Web Services Organizations.
	//
	// This member is required.
	NotificationsAccessForOrganization *types.NotificationsAccessForOrganization

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

type HTTPClient

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

type HTTPSignerV4

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

type ListChannelsAPIClient

type ListChannelsAPIClient interface {
	ListChannels(context.Context, *ListChannelsInput, ...func(*Options)) (*ListChannelsOutput, error)
}

ListChannelsAPIClient is a client that implements the ListChannels operation.

type ListChannelsInput

type ListChannelsInput struct {

	// The Amazon Resource Name (ARN) of the NotificationConfiguration .
	//
	// This member is required.
	NotificationConfigurationArn *string

	// The maximum number of results to be returned in this call. The default value is
	// 20.
	MaxResults *int32

	// The start token for paginated calls. Retrieved from the response of a previous
	// ListNotificationEvents call. NextToken uses Base64 encoding.
	NextToken *string
	// contains filtered or unexported fields
}

type ListChannelsOutput

type ListChannelsOutput struct {

	// A list of Channels.
	//
	// This member is required.
	Channels []string

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListChannelsPaginator

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

ListChannelsPaginator is a paginator for ListChannels

func NewListChannelsPaginator

func NewListChannelsPaginator(client ListChannelsAPIClient, params *ListChannelsInput, optFns ...func(*ListChannelsPaginatorOptions)) *ListChannelsPaginator

NewListChannelsPaginator returns a new ListChannelsPaginator

func (*ListChannelsPaginator) HasMorePages

func (p *ListChannelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelsPaginator) NextPage

func (p *ListChannelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelsOutput, error)

NextPage retrieves the next ListChannels page.

type ListChannelsPaginatorOptions

type ListChannelsPaginatorOptions struct {
	// The maximum number of results to be returned in this call. The default value is
	// 20.
	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
}

ListChannelsPaginatorOptions is the paginator options for ListChannels

type ListEventRulesAPIClient

type ListEventRulesAPIClient interface {
	ListEventRules(context.Context, *ListEventRulesInput, ...func(*Options)) (*ListEventRulesOutput, error)
}

ListEventRulesAPIClient is a client that implements the ListEventRules operation.

type ListEventRulesInput

type ListEventRulesInput struct {

	// The Amazon Resource Name (ARN) of the NotificationConfiguration .
	//
	// This member is required.
	NotificationConfigurationArn *string

	// The maximum number of results to be returned in this call. The default value is
	// 20.
	MaxResults *int32

	// The start token for paginated calls. Retrieved from the response of a previous
	// ListEventRules call. Next token uses Base64 encoding.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEventRulesOutput

type ListEventRulesOutput struct {

	// A list of EventRules .
	//
	// This member is required.
	EventRules []types.EventRuleStructure

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListEventRulesPaginator

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

ListEventRulesPaginator is a paginator for ListEventRules

func NewListEventRulesPaginator

func NewListEventRulesPaginator(client ListEventRulesAPIClient, params *ListEventRulesInput, optFns ...func(*ListEventRulesPaginatorOptions)) *ListEventRulesPaginator

NewListEventRulesPaginator returns a new ListEventRulesPaginator

func (*ListEventRulesPaginator) HasMorePages

func (p *ListEventRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEventRulesPaginator) NextPage

func (p *ListEventRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEventRulesOutput, error)

NextPage retrieves the next ListEventRules page.

type ListEventRulesPaginatorOptions

type ListEventRulesPaginatorOptions struct {
	// The maximum number of results to be returned in this call. The default value is
	// 20.
	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
}

ListEventRulesPaginatorOptions is the paginator options for ListEventRules

type ListManagedNotificationChannelAssociationsAPIClient added in v1.1.0

type ListManagedNotificationChannelAssociationsAPIClient interface {
	ListManagedNotificationChannelAssociations(context.Context, *ListManagedNotificationChannelAssociationsInput, ...func(*Options)) (*ListManagedNotificationChannelAssociationsOutput, error)
}

ListManagedNotificationChannelAssociationsAPIClient is a client that implements the ListManagedNotificationChannelAssociations operation.

type ListManagedNotificationChannelAssociationsInput added in v1.1.0

type ListManagedNotificationChannelAssociationsInput struct {

	// The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration to match.
	//
	// This member is required.
	ManagedNotificationConfigurationArn *string

	// The maximum number of results to be returned in this call. Defaults to 20.
	MaxResults *int32

	// The start token for paginated calls. Retrieved from the response of a previous
	// ListManagedNotificationChannelAssociations call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListManagedNotificationChannelAssociationsOutput added in v1.1.0

type ListManagedNotificationChannelAssociationsOutput struct {

	// A list that contains the following information about a channel association.
	//
	// This member is required.
	ChannelAssociations []types.ManagedNotificationChannelAssociationSummary

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListManagedNotificationChannelAssociationsPaginator added in v1.1.0

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

ListManagedNotificationChannelAssociationsPaginator is a paginator for ListManagedNotificationChannelAssociations

func NewListManagedNotificationChannelAssociationsPaginator added in v1.1.0

NewListManagedNotificationChannelAssociationsPaginator returns a new ListManagedNotificationChannelAssociationsPaginator

func (*ListManagedNotificationChannelAssociationsPaginator) HasMorePages added in v1.1.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedNotificationChannelAssociationsPaginator) NextPage added in v1.1.0

NextPage retrieves the next ListManagedNotificationChannelAssociations page.

type ListManagedNotificationChannelAssociationsPaginatorOptions added in v1.1.0

type ListManagedNotificationChannelAssociationsPaginatorOptions struct {
	// The maximum number of results to be returned in this call. Defaults to 20.
	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
}

ListManagedNotificationChannelAssociationsPaginatorOptions is the paginator options for ListManagedNotificationChannelAssociations

type ListManagedNotificationChildEventsAPIClient added in v1.1.0

type ListManagedNotificationChildEventsAPIClient interface {
	ListManagedNotificationChildEvents(context.Context, *ListManagedNotificationChildEventsInput, ...func(*Options)) (*ListManagedNotificationChildEventsOutput, error)
}

ListManagedNotificationChildEventsAPIClient is a client that implements the ListManagedNotificationChildEvents operation.

type ListManagedNotificationChildEventsInput added in v1.1.0

type ListManagedNotificationChildEventsInput struct {

	// The Amazon Resource Name (ARN) of the ManagedNotificationEvent .
	//
	// This member is required.
	AggregateManagedNotificationEventArn *string

	// Latest time of events to return from this call.
	EndTime *time.Time

	// The locale code of the language used for the retrieved NotificationEvent . The
	// default locale is English. en_US .
	Locale types.LocaleCode

	// The maximum number of results to be returned in this call. Defaults to 20.
	MaxResults *int32

	// The start token for paginated calls. Retrieved from the response of a previous
	// ListManagedNotificationChannelAssociations call. Next token uses Base64
	// encoding.
	NextToken *string

	// The identifier of the Amazon Web Services Organizations organizational unit
	// (OU) associated with the Managed Notification Child Events.
	OrganizationalUnitId *string

	// The Amazon Web Services account ID associated with the Managed Notification
	// Child Events.
	RelatedAccount *string

	// The earliest time of events to return from this call.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type ListManagedNotificationChildEventsOutput added in v1.1.0

type ListManagedNotificationChildEventsOutput struct {

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	//
	// This member is required.
	ManagedNotificationChildEvents []types.ManagedNotificationChildEventOverview

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListManagedNotificationChildEventsPaginator added in v1.1.0

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

ListManagedNotificationChildEventsPaginator is a paginator for ListManagedNotificationChildEvents

func NewListManagedNotificationChildEventsPaginator added in v1.1.0

NewListManagedNotificationChildEventsPaginator returns a new ListManagedNotificationChildEventsPaginator

func (*ListManagedNotificationChildEventsPaginator) HasMorePages added in v1.1.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedNotificationChildEventsPaginator) NextPage added in v1.1.0

NextPage retrieves the next ListManagedNotificationChildEvents page.

type ListManagedNotificationChildEventsPaginatorOptions added in v1.1.0

type ListManagedNotificationChildEventsPaginatorOptions struct {
	// The maximum number of results to be returned in this call. Defaults to 20.
	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
}

ListManagedNotificationChildEventsPaginatorOptions is the paginator options for ListManagedNotificationChildEvents

type ListManagedNotificationConfigurationsAPIClient added in v1.1.0

type ListManagedNotificationConfigurationsAPIClient interface {
	ListManagedNotificationConfigurations(context.Context, *ListManagedNotificationConfigurationsInput, ...func(*Options)) (*ListManagedNotificationConfigurationsOutput, error)
}

ListManagedNotificationConfigurationsAPIClient is a client that implements the ListManagedNotificationConfigurations operation.

type ListManagedNotificationConfigurationsInput added in v1.1.0

type ListManagedNotificationConfigurationsInput struct {

	// The identifier or ARN of the notification channel to filter configurations by.
	ChannelIdentifier *string

	// The maximum number of results to be returned in this call. Defaults to 20.
	MaxResults *int32

	// The start token for paginated calls. Retrieved from the response of a previous
	// ListManagedNotificationChannelAssociations call. Next token uses Base64
	// encoding.
	NextToken *string
	// contains filtered or unexported fields
}

type ListManagedNotificationConfigurationsOutput added in v1.1.0

type ListManagedNotificationConfigurationsOutput struct {

	// A list of Managed Notification Configurations matching the request criteria.
	//
	// This member is required.
	ManagedNotificationConfigurations []types.ManagedNotificationConfigurationStructure

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListManagedNotificationConfigurationsPaginator added in v1.1.0

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

ListManagedNotificationConfigurationsPaginator is a paginator for ListManagedNotificationConfigurations

func NewListManagedNotificationConfigurationsPaginator added in v1.1.0

NewListManagedNotificationConfigurationsPaginator returns a new ListManagedNotificationConfigurationsPaginator

func (*ListManagedNotificationConfigurationsPaginator) HasMorePages added in v1.1.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedNotificationConfigurationsPaginator) NextPage added in v1.1.0

NextPage retrieves the next ListManagedNotificationConfigurations page.

type ListManagedNotificationConfigurationsPaginatorOptions added in v1.1.0

type ListManagedNotificationConfigurationsPaginatorOptions struct {
	// The maximum number of results to be returned in this call. Defaults to 20.
	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
}

ListManagedNotificationConfigurationsPaginatorOptions is the paginator options for ListManagedNotificationConfigurations

type ListManagedNotificationEventsAPIClient added in v1.1.0

type ListManagedNotificationEventsAPIClient interface {
	ListManagedNotificationEvents(context.Context, *ListManagedNotificationEventsInput, ...func(*Options)) (*ListManagedNotificationEventsOutput, error)
}

ListManagedNotificationEventsAPIClient is a client that implements the ListManagedNotificationEvents operation.

type ListManagedNotificationEventsInput added in v1.1.0

type ListManagedNotificationEventsInput struct {

	// Latest time of events to return from this call.
	EndTime *time.Time

	// The locale code of the language used for the retrieved NotificationEvent. The
	// default locale is English (en_US).
	Locale types.LocaleCode

	// The maximum number of results to be returned in this call. Defaults to 20.
	MaxResults *int32

	// The start token for paginated calls. Retrieved from the response of a previous
	// ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.
	NextToken *string

	// The Organizational Unit Id that an Amazon Web Services account belongs to.
	OrganizationalUnitId *string

	// The Amazon Web Services account ID associated with the Managed Notification
	// Events.
	RelatedAccount *string

	// The Amazon Web Services service the event originates from. For example
	// aws.cloudwatch.
	Source *string

	// The earliest time of events to return from this call.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type ListManagedNotificationEventsOutput added in v1.1.0

type ListManagedNotificationEventsOutput struct {

	// A list of Managed Notification Events matching the request criteria.
	//
	// This member is required.
	ManagedNotificationEvents []types.ManagedNotificationEventOverview

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListManagedNotificationEventsPaginator added in v1.1.0

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

ListManagedNotificationEventsPaginator is a paginator for ListManagedNotificationEvents

func NewListManagedNotificationEventsPaginator added in v1.1.0

NewListManagedNotificationEventsPaginator returns a new ListManagedNotificationEventsPaginator

func (*ListManagedNotificationEventsPaginator) HasMorePages added in v1.1.0

func (p *ListManagedNotificationEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedNotificationEventsPaginator) NextPage added in v1.1.0

NextPage retrieves the next ListManagedNotificationEvents page.

type ListManagedNotificationEventsPaginatorOptions added in v1.1.0

type ListManagedNotificationEventsPaginatorOptions struct {
	// The maximum number of results to be returned in this call. Defaults to 20.
	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
}

ListManagedNotificationEventsPaginatorOptions is the paginator options for ListManagedNotificationEvents

type ListNotificationConfigurationsAPIClient

type ListNotificationConfigurationsAPIClient interface {
	ListNotificationConfigurations(context.Context, *ListNotificationConfigurationsInput, ...func(*Options)) (*ListNotificationConfigurationsOutput, error)
}

ListNotificationConfigurationsAPIClient is a client that implements the ListNotificationConfigurations operation.

type ListNotificationConfigurationsInput

type ListNotificationConfigurationsInput struct {

	// The Amazon Resource Name (ARN) of the Channel to match.
	ChannelArn *string

	// The matched event source.
	//
	// Must match one of the valid EventBridge sources. Only Amazon Web Services
	// service sourced events are supported. For example, aws.ec2 and aws.cloudwatch .
	// For more information, see [Event delivery from Amazon Web Services services]in the Amazon EventBridge User Guide.
	//
	// [Event delivery from Amazon Web Services services]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
	EventRuleSource *string

	// The maximum number of results to be returned in this call. Defaults to 20.
	MaxResults *int32

	// The start token for paginated calls. Retrieved from the response of a previous
	// ListEventRules call. Next token uses Base64 encoding.
	NextToken *string

	// The NotificationConfiguration status to match.
	//
	//   - Values:
	//
	//   - ACTIVE
	//
	//   - All EventRules are ACTIVE and any call can be run.
	//
	//   - PARTIALLY_ACTIVE
	//
	//   - Some EventRules are ACTIVE and some are INACTIVE . Any call can be run.
	//
	//   - Any call can be run.
	//
	//   - INACTIVE
	//
	//   - All EventRules are INACTIVE and any call can be run.
	//
	//   - DELETING
	//
	//   - This NotificationConfiguration is being deleted.
	//
	//   - Only GET and LIST calls can be run.
	Status types.NotificationConfigurationStatus
	// contains filtered or unexported fields
}

type ListNotificationConfigurationsOutput

type ListNotificationConfigurationsOutput struct {

	// The NotificationConfigurations in the account.
	//
	// This member is required.
	NotificationConfigurations []types.NotificationConfigurationStructure

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListNotificationConfigurationsPaginator

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

ListNotificationConfigurationsPaginator is a paginator for ListNotificationConfigurations

func NewListNotificationConfigurationsPaginator

NewListNotificationConfigurationsPaginator returns a new ListNotificationConfigurationsPaginator

func (*ListNotificationConfigurationsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotificationConfigurationsPaginator) NextPage

NextPage retrieves the next ListNotificationConfigurations page.

type ListNotificationConfigurationsPaginatorOptions

type ListNotificationConfigurationsPaginatorOptions struct {
	// The maximum number of results to be returned in this call. Defaults to 20.
	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
}

ListNotificationConfigurationsPaginatorOptions is the paginator options for ListNotificationConfigurations

type ListNotificationEventsAPIClient

type ListNotificationEventsAPIClient interface {
	ListNotificationEvents(context.Context, *ListNotificationEventsInput, ...func(*Options)) (*ListNotificationEventsOutput, error)
}

ListNotificationEventsAPIClient is a client that implements the ListNotificationEvents operation.

type ListNotificationEventsInput

type ListNotificationEventsInput struct {

	// The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.
	AggregateNotificationEventArn *string

	// Latest time of events to return from this call.
	EndTime *time.Time

	// Include aggregated child events in the result.
	IncludeChildEvents *bool

	// The locale code of the language used for the retrieved NotificationEvent . The
	// default locale is English (en_US) .
	Locale types.LocaleCode

	// The maximum number of results to be returned in this call. Defaults to 20.
	MaxResults *int32

	// The start token for paginated calls. Retrieved from the response of a previous
	// ListEventRules call. Next token uses Base64 encoding.
	NextToken *string

	// The matched event source.
	//
	// Must match one of the valid EventBridge sources. Only Amazon Web Services
	// service sourced events are supported. For example, aws.ec2 and aws.cloudwatch .
	// For more information, see [Event delivery from Amazon Web Services services]in the Amazon EventBridge User Guide.
	//
	// [Event delivery from Amazon Web Services services]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level
	Source *string

	// The earliest time of events to return from this call.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type ListNotificationEventsOutput

type ListNotificationEventsOutput struct {

	// The list of notification events.
	//
	// This member is required.
	NotificationEvents []types.NotificationEventOverview

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListNotificationEventsPaginator

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

ListNotificationEventsPaginator is a paginator for ListNotificationEvents

func NewListNotificationEventsPaginator

NewListNotificationEventsPaginator returns a new ListNotificationEventsPaginator

func (*ListNotificationEventsPaginator) HasMorePages

func (p *ListNotificationEventsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotificationEventsPaginator) NextPage

NextPage retrieves the next ListNotificationEvents page.

type ListNotificationEventsPaginatorOptions

type ListNotificationEventsPaginatorOptions struct {
	// The maximum number of results to be returned in this call. Defaults to 20.
	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
}

ListNotificationEventsPaginatorOptions is the paginator options for ListNotificationEvents

type ListNotificationHubsAPIClient

type ListNotificationHubsAPIClient interface {
	ListNotificationHubs(context.Context, *ListNotificationHubsInput, ...func(*Options)) (*ListNotificationHubsOutput, error)
}

ListNotificationHubsAPIClient is a client that implements the ListNotificationHubs operation.

type ListNotificationHubsInput

type ListNotificationHubsInput struct {

	// The maximum number of records to list in a single response.
	MaxResults *int32

	// A pagination token. Set to null to start listing notification hubs from the
	// start.
	NextToken *string
	// contains filtered or unexported fields
}

type ListNotificationHubsOutput

type ListNotificationHubsOutput struct {

	// The NotificationHubs in the account.
	//
	// This member is required.
	NotificationHubs []types.NotificationHubOverview

	// A pagination token. If a non-null pagination token is returned in a result,
	// pass its value in another request to retrieve more entries.
	NextToken *string

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

type ListNotificationHubsPaginator

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

ListNotificationHubsPaginator is a paginator for ListNotificationHubs

func NewListNotificationHubsPaginator

NewListNotificationHubsPaginator returns a new ListNotificationHubsPaginator

func (*ListNotificationHubsPaginator) HasMorePages

func (p *ListNotificationHubsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotificationHubsPaginator) NextPage

NextPage retrieves the next ListNotificationHubs page.

type ListNotificationHubsPaginatorOptions

type ListNotificationHubsPaginatorOptions struct {
	// The maximum number of records to list in a single response.
	Limit int32

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

ListNotificationHubsPaginatorOptions is the paginator options for ListNotificationHubs

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) to use to list tags.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// A list of tags for the specified ARN.
	Tags map[string]string

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

type Options

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

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

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

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

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

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

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

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

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

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

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

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

type RegisterNotificationHubInput

type RegisterNotificationHubInput struct {

	// The Region of the NotificationHub .
	//
	// This member is required.
	NotificationHubRegion *string
	// contains filtered or unexported fields
}

type RegisterNotificationHubOutput

type RegisterNotificationHubOutput struct {

	// The date the resource was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Region of the NotificationHub .
	//
	// This member is required.
	NotificationHubRegion *string

	// Provides additional information about the current NotificationConfiguration
	// status information.
	//
	// This member is required.
	StatusSummary *types.NotificationHubStatusSummary

	// The date the resource was last activated.
	LastActivationTime *time.Time

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) to use to tag a resource.
	//
	// This member is required.
	Arn *string

	// A map of tags assigned to a resource. A tag is a string-to-string map of
	// key-value pairs.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput

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

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) to use to untag a resource.
	//
	// This member is required.
	Arn *string

	// The tag keys to use to untag a resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

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

type UpdateEventRuleInput

type UpdateEventRuleInput struct {

	// The Amazon Resource Name (ARN) to use to update the EventRule .
	//
	// This member is required.
	Arn *string

	// An additional event pattern used to further filter the events this EventRule
	// receives.
	//
	// For more information, see [Amazon EventBridge event patterns] in the Amazon EventBridge User Guide.
	//
	// [Amazon EventBridge event patterns]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html
	EventPattern *string

	// A list of Amazon Web Services Regions that sends events to this EventRule .
	Regions []string
	// contains filtered or unexported fields
}

type UpdateEventRuleOutput

type UpdateEventRuleOutput struct {

	// The Amazon Resource Name (ARN) to use to update the EventRule .
	//
	// This member is required.
	Arn *string

	// The ARN of the NotificationConfiguration .
	//
	// This member is required.
	NotificationConfigurationArn *string

	// The status of the action by Region.
	//
	// This member is required.
	StatusSummaryByRegion map[string]types.EventRuleStatusSummary

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

type UpdateNotificationConfigurationInput

type UpdateNotificationConfigurationInput struct {

	// The Amazon Resource Name (ARN) used to update the NotificationConfiguration .
	//
	// This member is required.
	Arn *string

	// The aggregation preference of the NotificationConfiguration .
	//
	//   - Values:
	//
	//   - LONG
	//
	//   - Aggregate notifications for long periods of time (12 hours).
	//
	//   - SHORT
	//
	//   - Aggregate notifications for short periods of time (5 minutes).
	//
	//   - NONE
	//
	//   - Don't aggregate notifications.
	AggregationDuration types.AggregationDuration

	// The description of the NotificationConfiguration .
	Description *string

	// The name of the NotificationConfiguration .
	Name *string
	// contains filtered or unexported fields
}

type UpdateNotificationConfigurationOutput

type UpdateNotificationConfigurationOutput struct {

	// The ARN used to update the NotificationConfiguration .
	//
	// This member is required.
	Arn *string

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

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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