Documentation

Overview

    Package devopsguru provides the API client, operations, and parameter types for Amazon DevOps Guru.

    Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the AWS resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and AWS CloudTrail events related to those resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an insight that includes recommendations, related events, and related metrics that can help you improve your operational applications. For more information, see What is Amazon DevOps Guru (https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html). You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate an OpsItem in AWS Systems Manager for each insight to help you manage and track your work addressing insights. To learn about the DevOps Guru workflow, see How DevOps Guru works (https://docs.aws.amazon.com/devops-guru/latest/userguide/welcome.html#how-it-works). To learn about DevOps Guru concepts, see Concepts in DevOps Guru (https://docs.aws.amazon.com/devops-guru/latest/userguide/concepts.html).

    Index

    Constants

    View Source 
    const ServiceAPIVersion = "2020-12-01"
    View Source 
    const ServiceID = "DevOps Guru"

    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 AddNotificationChannelInput 

          type AddNotificationChannelInput struct {

	// A NotificationChannelConfig object that specifies what type of notification
	// channel to add. The one supported notification channel is Amazon Simple
	// Notification Service (Amazon SNS).
	//
	// This member is required.
	Config *types.NotificationChannelConfig
}

          type AddNotificationChannelOutput 

          type AddNotificationChannelOutput struct {

	// The ID of the added notification channel.
	//
	// This member is required.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

          type Client 

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

            Client provides the API client to make operations call for Amazon DevOps Guru.

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

                func (c *Client) AddNotificationChannel(ctx context.Context, params *AddNotificationChannelInput, optFns ...func(*Options)) (*AddNotificationChannelOutput, error)

                  Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).

                  func (*Client) DescribeAccountHealth 

                  func (c *Client) DescribeAccountHealth(ctx context.Context, params *DescribeAccountHealthInput, optFns ...func(*Options)) (*DescribeAccountHealthOutput, error)

                    Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account. Use these numbers to gauge the health of operations in your AWS account.

                    func (*Client) DescribeAccountOverview 

                    func (c *Client) DescribeAccountOverview(ctx context.Context, params *DescribeAccountOverviewInput, optFns ...func(*Options)) (*DescribeAccountOverviewOutput, error)

                      For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.

                      func (*Client) DescribeAnomaly 

                      func (c *Client) DescribeAnomaly(ctx context.Context, params *DescribeAnomalyInput, optFns ...func(*Options)) (*DescribeAnomalyOutput, error)

                        Returns details about an anomaly that you specify using its ID.

                        func (*Client) DescribeInsight 

                        func (c *Client) DescribeInsight(ctx context.Context, params *DescribeInsightInput, optFns ...func(*Options)) (*DescribeInsightOutput, error)

                          Returns details about an insight that you specify using its ID.

                          func (*Client) DescribeResourceCollectionHealth 

                          func (c *Client) DescribeResourceCollectionHealth(ctx context.Context, params *DescribeResourceCollectionHealthInput, optFns ...func(*Options)) (*DescribeResourceCollectionHealthOutput, error)

                            Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

                            func (*Client) DescribeServiceIntegration 

                            func (c *Client) DescribeServiceIntegration(ctx context.Context, params *DescribeServiceIntegrationInput, optFns ...func(*Options)) (*DescribeServiceIntegrationOutput, error)

                              Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.

                              func (*Client) GetResourceCollection 

                              func (c *Client) GetResourceCollection(ctx context.Context, params *GetResourceCollectionInput, optFns ...func(*Options)) (*GetResourceCollectionOutput, error)

                                Returns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

                                func (*Client) ListAnomaliesForInsight 

                                func (c *Client) ListAnomaliesForInsight(ctx context.Context, params *ListAnomaliesForInsightInput, optFns ...func(*Options)) (*ListAnomaliesForInsightOutput, error)

                                  Returns a list of the anomalies that belong to an insight that you specify using its ID.

                                  func (*Client) ListEvents 

                                  func (c *Client) ListEvents(ctx context.Context, params *ListEventsInput, optFns ...func(*Options)) (*ListEventsOutput, error)

                                    Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

                                    func (*Client) ListInsights 

                                    func (c *Client) ListInsights(ctx context.Context, params *ListInsightsInput, optFns ...func(*Options)) (*ListInsightsOutput, error)

                                      Returns a list of insights in your AWS account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).

                                      func (*Client) ListNotificationChannels 

                                      func (c *Client) ListNotificationChannels(ctx context.Context, params *ListNotificationChannelsInput, optFns ...func(*Options)) (*ListNotificationChannelsOutput, error)

                                        Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

                                        func (*Client) ListRecommendations 

                                        func (c *Client) ListRecommendations(ctx context.Context, params *ListRecommendationsInput, optFns ...func(*Options)) (*ListRecommendationsOutput, error)

                                          Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

                                          func (*Client) PutFeedback 

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

                                            Collects customer feedback about the specified insight.

                                            func (*Client) RemoveNotificationChannel 

                                            func (c *Client) RemoveNotificationChannel(ctx context.Context, params *RemoveNotificationChannelInput, optFns ...func(*Options)) (*RemoveNotificationChannelOutput, error)

                                              Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations.

                                              func (*Client) SearchInsights 

                                              func (c *Client) SearchInsights(ctx context.Context, params *SearchInsightsInput, optFns ...func(*Options)) (*SearchInsightsOutput, error)

                                                Returns a list of insights in your AWS account. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

                                                func (*Client) UpdateResourceCollection 

                                                func (c *Client) UpdateResourceCollection(ctx context.Context, params *UpdateResourceCollectionInput, optFns ...func(*Options)) (*UpdateResourceCollectionOutput, error)

                                                  Updates the collection of resources that DevOps Guru analyzes. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. This method also creates the IAM role required for you to use DevOps Guru.

                                                  func (*Client) UpdateServiceIntegration 

                                                  func (c *Client) UpdateServiceIntegration(ctx context.Context, params *UpdateServiceIntegrationInput, optFns ...func(*Options)) (*UpdateServiceIntegrationOutput, error)

                                                    Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.

                                                    type DescribeAccountHealthInput 

                                                    type DescribeAccountHealthInput struct {
}

                                                    type DescribeAccountHealthOutput 

                                                    type DescribeAccountHealthOutput struct {

	// An integer that specifies the number of metrics that have been analyzed in your
	// AWS account.
	//
	// This member is required.
	MetricsAnalyzed int32

	// An integer that specifies the number of open proactive insights in your AWS
	// account.
	//
	// This member is required.
	OpenProactiveInsights int32

	// An integer that specifies the number of open reactive insights in your AWS
	// account.
	//
	// This member is required.
	OpenReactiveInsights int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                    type DescribeAccountOverviewInput 

                                                    type DescribeAccountOverviewInput struct {

	// The start of the time range passed in. The start time granularity is at the day
	// level. The floor of the start time is used. Returned information occurred after
	// this day.
	//
	// This member is required.
	FromTime *time.Time

	// The end of the time range passed in. The start time granularity is at the day
	// level. The floor of the start time is used. Returned information occurred before
	// this day. If this is not specified, then the current day is used.
	ToTime *time.Time
}

                                                    type DescribeAccountOverviewOutput 

                                                    type DescribeAccountOverviewOutput struct {

	// The Mean Time to Recover (MTTR) for all closed insights that were created during
	// the time range passed in.
	//
	// This member is required.
	MeanTimeToRecoverInMilliseconds *int64

	// An integer that specifies the number of open proactive insights in your AWS
	// account that were created during the time range passed in.
	//
	// This member is required.
	ProactiveInsights int32

	// An integer that specifies the number of open reactive insights in your AWS
	// account that were created during the time range passed in.
	//
	// This member is required.
	ReactiveInsights int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                    type DescribeAnomalyInput 

                                                    type DescribeAnomalyInput struct {

	// The ID of the anomaly.
	//
	// This member is required.
	Id *string
}

                                                    type DescribeAnomalyOutput 

                                                    type DescribeAnomalyOutput struct {

	// An ReactiveAnomaly object that represents the requested anomaly.
	ProactiveAnomaly *types.ProactiveAnomaly

	// An ProactiveAnomaly object that represents the requested anomaly.
	ReactiveAnomaly *types.ReactiveAnomaly

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                    type DescribeInsightInput 

                                                    type DescribeInsightInput struct {

	// The ID of the insight.
	//
	// This member is required.
	Id *string
}

                                                    type DescribeInsightOutput 

                                                    type DescribeInsightOutput struct {

	// An ProactiveInsight object that represents the requested insight.
	ProactiveInsight *types.ProactiveInsight

	// An ReactiveInsight object that represents the requested insight.
	ReactiveInsight *types.ReactiveInsight

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                    type DescribeResourceCollectionHealthAPIClient 

                                                    type DescribeResourceCollectionHealthAPIClient interface {
	DescribeResourceCollectionHealth(context.Context, *DescribeResourceCollectionHealthInput, ...func(*Options)) (*DescribeResourceCollectionHealthOutput, error)
}

                                                      DescribeResourceCollectionHealthAPIClient is a client that implements the DescribeResourceCollectionHealth operation.

                                                      type DescribeResourceCollectionHealthInput 

                                                      type DescribeResourceCollectionHealthInput struct {

	// An AWS resource collection type. This type specifies how analyzed AWS resources
	// are defined. The one type of AWS resource collection supported is AWS
	// CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS
	// resources that are defined in the stacks.
	//
	// This member is required.
	ResourceCollectionType types.ResourceCollectionType

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
}

                                                      type DescribeResourceCollectionHealthOutput 

                                                      type DescribeResourceCollectionHealthOutput struct {

	// The returned CloudFormationHealthOverview object that contains an
	// InsightHealthOverview object with the requested system health information.
	//
	// This member is required.
	CloudFormation []types.CloudFormationHealth

	// The pagination token to use to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                      type DescribeResourceCollectionHealthPaginator 

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

                                                        DescribeResourceCollectionHealthPaginator is a paginator for DescribeResourceCollectionHealth

                                                        func NewDescribeResourceCollectionHealthPaginator 

                                                        func NewDescribeResourceCollectionHealthPaginator(client DescribeResourceCollectionHealthAPIClient, params *DescribeResourceCollectionHealthInput, optFns ...func(*DescribeResourceCollectionHealthPaginatorOptions)) *DescribeResourceCollectionHealthPaginator

                                                          NewDescribeResourceCollectionHealthPaginator returns a new DescribeResourceCollectionHealthPaginator

                                                          func (*DescribeResourceCollectionHealthPaginator) HasMorePages 

                                                          func (p *DescribeResourceCollectionHealthPaginator) HasMorePages() bool

                                                            HasMorePages returns a boolean indicating whether more pages are available

                                                            func (*DescribeResourceCollectionHealthPaginator) NextPage 

                                                            func (p *DescribeResourceCollectionHealthPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeResourceCollectionHealthOutput, error)

                                                              NextPage retrieves the next DescribeResourceCollectionHealth page.

                                                              type DescribeResourceCollectionHealthPaginatorOptions 

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

                                                                DescribeResourceCollectionHealthPaginatorOptions is the paginator options for DescribeResourceCollectionHealth

                                                                type DescribeServiceIntegrationInput 

                                                                type DescribeServiceIntegrationInput struct {
}

                                                                type DescribeServiceIntegrationOutput 

                                                                type DescribeServiceIntegrationOutput struct {

	// Information about the integration of DevOps Guru with another AWS service, such
	// as AWS Systems Manager.
	ServiceIntegration *types.ServiceIntegrationConfig

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                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 GetResourceCollectionAPIClient 

                                                                        type GetResourceCollectionAPIClient interface {
	GetResourceCollection(context.Context, *GetResourceCollectionInput, ...func(*Options)) (*GetResourceCollectionOutput, error)
}

                                                                          GetResourceCollectionAPIClient is a client that implements the GetResourceCollection operation.

                                                                          type GetResourceCollectionInput 

                                                                          type GetResourceCollectionInput struct {

	// The type of AWS resource collections to return. The one valid value is
	// CLOUD_FORMATION for AWS CloudFormation stacks.
	//
	// This member is required.
	ResourceCollectionType types.ResourceCollectionType

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
}

                                                                          type GetResourceCollectionOutput 

                                                                          type GetResourceCollectionOutput struct {

	// The pagination token to use to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// The requested list of AWS resource collections. The one type of AWS resource
	// collection supported is AWS CloudFormation stacks. DevOps Guru can be configured
	// to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *types.ResourceCollectionFilter

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                          type GetResourceCollectionPaginator 

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

                                                                            GetResourceCollectionPaginator is a paginator for GetResourceCollection

                                                                            func NewGetResourceCollectionPaginator 

                                                                            func NewGetResourceCollectionPaginator(client GetResourceCollectionAPIClient, params *GetResourceCollectionInput, optFns ...func(*GetResourceCollectionPaginatorOptions)) *GetResourceCollectionPaginator

                                                                              NewGetResourceCollectionPaginator returns a new GetResourceCollectionPaginator

                                                                              func (*GetResourceCollectionPaginator) HasMorePages 

                                                                              func (p *GetResourceCollectionPaginator) HasMorePages() bool

                                                                                HasMorePages returns a boolean indicating whether more pages are available

                                                                                func (*GetResourceCollectionPaginator) NextPage 

                                                                                func (p *GetResourceCollectionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceCollectionOutput, error)

                                                                                  NextPage retrieves the next GetResourceCollection page.

                                                                                  type GetResourceCollectionPaginatorOptions 

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

                                                                                    GetResourceCollectionPaginatorOptions is the paginator options for GetResourceCollection

                                                                                    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 ListAnomaliesForInsightAPIClient 

                                                                                    type ListAnomaliesForInsightAPIClient interface {
	ListAnomaliesForInsight(context.Context, *ListAnomaliesForInsightInput, ...func(*Options)) (*ListAnomaliesForInsightOutput, error)
}

                                                                                      ListAnomaliesForInsightAPIClient is a client that implements the ListAnomaliesForInsight operation.

                                                                                      type ListAnomaliesForInsightInput 

                                                                                      type ListAnomaliesForInsightInput struct {

	// The ID of the insight. The returned anomalies belong to this insight.
	//
	// This member is required.
	InsightId *string

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string

	// A time range used to specify when the requested anomalies started. All returned
	// anomalies started during this time range.
	StartTimeRange *types.StartTimeRange
}

                                                                                      type ListAnomaliesForInsightOutput 

                                                                                      type ListAnomaliesForInsightOutput struct {

	// The pagination token to use to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// An array of ProactiveAnomalySummary objects that represent the requested
	// anomalies
	ProactiveAnomalies []types.ProactiveAnomalySummary

	// An array of ReactiveAnomalySummary objects that represent the requested
	// anomalies
	ReactiveAnomalies []types.ReactiveAnomalySummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                      type ListAnomaliesForInsightPaginator 

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

                                                                                        ListAnomaliesForInsightPaginator is a paginator for ListAnomaliesForInsight

                                                                                        func NewListAnomaliesForInsightPaginator 

                                                                                        func NewListAnomaliesForInsightPaginator(client ListAnomaliesForInsightAPIClient, params *ListAnomaliesForInsightInput, optFns ...func(*ListAnomaliesForInsightPaginatorOptions)) *ListAnomaliesForInsightPaginator

                                                                                          NewListAnomaliesForInsightPaginator returns a new ListAnomaliesForInsightPaginator

                                                                                          func (*ListAnomaliesForInsightPaginator) HasMorePages 

                                                                                          func (p *ListAnomaliesForInsightPaginator) HasMorePages() bool

                                                                                            HasMorePages returns a boolean indicating whether more pages are available

                                                                                            func (*ListAnomaliesForInsightPaginator) NextPage 

                                                                                            func (p *ListAnomaliesForInsightPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAnomaliesForInsightOutput, error)

                                                                                              NextPage retrieves the next ListAnomaliesForInsight page.

                                                                                              type ListAnomaliesForInsightPaginatorOptions 

                                                                                              type ListAnomaliesForInsightPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

                                                                                                ListAnomaliesForInsightPaginatorOptions is the paginator options for ListAnomaliesForInsight

                                                                                                type ListEventsAPIClient 

                                                                                                type ListEventsAPIClient interface {
	ListEvents(context.Context, *ListEventsInput, ...func(*Options)) (*ListEventsOutput, error)
}

                                                                                                  ListEventsAPIClient is a client that implements the ListEvents operation.

                                                                                                  type ListEventsInput 

                                                                                                  type ListEventsInput struct {

	// A ListEventsFilters object used to specify which events to return.
	//
	// This member is required.
	Filters *types.ListEventsFilters

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
}

                                                                                                  type ListEventsOutput 

                                                                                                  type ListEventsOutput struct {

	// A list of the requested events.
	//
	// This member is required.
	Events []types.Event

	// The pagination token to use to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                  type ListEventsPaginator 

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

                                                                                                    ListEventsPaginator is a paginator for ListEvents

                                                                                                    func NewListEventsPaginator 

                                                                                                    func NewListEventsPaginator(client ListEventsAPIClient, params *ListEventsInput, optFns ...func(*ListEventsPaginatorOptions)) *ListEventsPaginator

                                                                                                      NewListEventsPaginator returns a new ListEventsPaginator

                                                                                                      func (*ListEventsPaginator) HasMorePages 

                                                                                                      func (p *ListEventsPaginator) HasMorePages() bool

                                                                                                        HasMorePages returns a boolean indicating whether more pages are available

                                                                                                        func (*ListEventsPaginator) NextPage 

                                                                                                        func (p *ListEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEventsOutput, error)

                                                                                                          NextPage retrieves the next ListEvents page.

                                                                                                          type ListEventsPaginatorOptions 

                                                                                                          type ListEventsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

                                                                                                            ListEventsPaginatorOptions is the paginator options for ListEvents

                                                                                                            type ListInsightsAPIClient 

                                                                                                            type ListInsightsAPIClient interface {
	ListInsights(context.Context, *ListInsightsInput, ...func(*Options)) (*ListInsightsOutput, error)
}

                                                                                                              ListInsightsAPIClient is a client that implements the ListInsights operation.

                                                                                                              type ListInsightsInput 

                                                                                                              type ListInsightsInput struct {

	// A filter used to filter the returned insights by their status. You can specify
	// one status filter.
	//
	// This member is required.
	StatusFilter *types.ListInsightsStatusFilter

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
}

                                                                                                              type ListInsightsOutput 

                                                                                                              type ListInsightsOutput struct {

	// The pagination token to use to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// The returned list of proactive insights.
	ProactiveInsights []types.ProactiveInsightSummary

	// The returned list of reactive insights.
	ReactiveInsights []types.ReactiveInsightSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                              type ListInsightsPaginator 

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

                                                                                                                ListInsightsPaginator is a paginator for ListInsights

                                                                                                                func NewListInsightsPaginator 

                                                                                                                func NewListInsightsPaginator(client ListInsightsAPIClient, params *ListInsightsInput, optFns ...func(*ListInsightsPaginatorOptions)) *ListInsightsPaginator

                                                                                                                  NewListInsightsPaginator returns a new ListInsightsPaginator

                                                                                                                  func (*ListInsightsPaginator) HasMorePages 

                                                                                                                  func (p *ListInsightsPaginator) HasMorePages() bool

                                                                                                                    HasMorePages returns a boolean indicating whether more pages are available

                                                                                                                    func (*ListInsightsPaginator) NextPage 

                                                                                                                    func (p *ListInsightsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListInsightsOutput, error)

                                                                                                                      NextPage retrieves the next ListInsights page.

                                                                                                                      type ListInsightsPaginatorOptions 

                                                                                                                      type ListInsightsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

                                                                                                                        ListInsightsPaginatorOptions is the paginator options for ListInsights

                                                                                                                        type ListNotificationChannelsAPIClient 

                                                                                                                        type ListNotificationChannelsAPIClient interface {
	ListNotificationChannels(context.Context, *ListNotificationChannelsInput, ...func(*Options)) (*ListNotificationChannelsOutput, error)
}

                                                                                                                          ListNotificationChannelsAPIClient is a client that implements the ListNotificationChannels operation.

                                                                                                                          type ListNotificationChannelsInput 

                                                                                                                          type ListNotificationChannelsInput struct {

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
}

                                                                                                                          type ListNotificationChannelsOutput 

                                                                                                                          type ListNotificationChannelsOutput struct {

	// An array that contains the requested notification channels.
	Channels []types.NotificationChannel

	// The pagination token to use to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                                          type ListNotificationChannelsPaginator 

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

                                                                                                                            ListNotificationChannelsPaginator is a paginator for ListNotificationChannels

                                                                                                                            func NewListNotificationChannelsPaginator 

                                                                                                                            func NewListNotificationChannelsPaginator(client ListNotificationChannelsAPIClient, params *ListNotificationChannelsInput, optFns ...func(*ListNotificationChannelsPaginatorOptions)) *ListNotificationChannelsPaginator

                                                                                                                              NewListNotificationChannelsPaginator returns a new ListNotificationChannelsPaginator

                                                                                                                              func (*ListNotificationChannelsPaginator) HasMorePages 

                                                                                                                              func (p *ListNotificationChannelsPaginator) HasMorePages() bool

                                                                                                                                HasMorePages returns a boolean indicating whether more pages are available

                                                                                                                                func (*ListNotificationChannelsPaginator) NextPage 

                                                                                                                                func (p *ListNotificationChannelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNotificationChannelsOutput, error)

                                                                                                                                  NextPage retrieves the next ListNotificationChannels page.

                                                                                                                                  type ListNotificationChannelsPaginatorOptions 

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

                                                                                                                                    ListNotificationChannelsPaginatorOptions is the paginator options for ListNotificationChannels

                                                                                                                                    type ListRecommendationsAPIClient 

                                                                                                                                    type ListRecommendationsAPIClient interface {
	ListRecommendations(context.Context, *ListRecommendationsInput, ...func(*Options)) (*ListRecommendationsOutput, error)
}

                                                                                                                                      ListRecommendationsAPIClient is a client that implements the ListRecommendations operation.

                                                                                                                                      type ListRecommendationsInput 

                                                                                                                                      type ListRecommendationsInput struct {

	// The ID of the requested insight.
	//
	// This member is required.
	InsightId *string

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
}

                                                                                                                                      type ListRecommendationsOutput 

                                                                                                                                      type ListRecommendationsOutput struct {

	// The pagination token to use to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// An array of the requested recommendations.
	Recommendations []types.Recommendation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                                                      type ListRecommendationsPaginator 

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

                                                                                                                                        ListRecommendationsPaginator is a paginator for ListRecommendations

                                                                                                                                        func NewListRecommendationsPaginator 

                                                                                                                                        func NewListRecommendationsPaginator(client ListRecommendationsAPIClient, params *ListRecommendationsInput, optFns ...func(*ListRecommendationsPaginatorOptions)) *ListRecommendationsPaginator

                                                                                                                                          NewListRecommendationsPaginator returns a new ListRecommendationsPaginator

                                                                                                                                          func (*ListRecommendationsPaginator) HasMorePages 

                                                                                                                                          func (p *ListRecommendationsPaginator) HasMorePages() bool

                                                                                                                                            HasMorePages returns a boolean indicating whether more pages are available

                                                                                                                                            func (*ListRecommendationsPaginator) NextPage 

                                                                                                                                            func (p *ListRecommendationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendationsOutput, error)

                                                                                                                                              NextPage retrieves the next ListRecommendations page.

                                                                                                                                              type ListRecommendationsPaginatorOptions 

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

                                                                                                                                                ListRecommendationsPaginatorOptions is the paginator options for ListRecommendations

                                                                                                                                                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 PutFeedbackInput 

                                                                                                                                                  type PutFeedbackInput struct {

	// The feedback from customers is about the recommendations in this insight.
	InsightFeedback *types.InsightFeedback
}

                                                                                                                                                  type PutFeedbackOutput 

                                                                                                                                                  type PutFeedbackOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                                                                  type RemoveNotificationChannelInput 

                                                                                                                                                  type RemoveNotificationChannelInput struct {

	// The ID of the notification channel to be removed.
	//
	// This member is required.
	Id *string
}

                                                                                                                                                  type RemoveNotificationChannelOutput 

                                                                                                                                                  type RemoveNotificationChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                                                                  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 SearchInsightsAPIClient 

                                                                                                                                                  type SearchInsightsAPIClient interface {
	SearchInsights(context.Context, *SearchInsightsInput, ...func(*Options)) (*SearchInsightsOutput, error)
}

                                                                                                                                                    SearchInsightsAPIClient is a client that implements the SearchInsights operation.

                                                                                                                                                    type SearchInsightsInput 

                                                                                                                                                    type SearchInsightsInput struct {

	// The start of the time range passed in. Returned insights occurred after this
	// time.
	//
	// This member is required.
	StartTimeRange *types.StartTimeRange

	// The type of insights you are searching for (REACTIVE or PROACTIVE).
	//
	// This member is required.
	Type types.InsightType

	// A SearchInsightsFilters object that is used to set the severity and status
	// filters on your insight search.
	Filters *types.SearchInsightsFilters

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The pagination token to use to retrieve the next page of results for this
	// operation. If this value is null, it retrieves the first page.
	NextToken *string
}

                                                                                                                                                    type SearchInsightsOutput 

                                                                                                                                                    type SearchInsightsOutput struct {

	// The pagination token to use to retrieve the next page of results for this
	// operation. If there are no more pages, this value is null.
	NextToken *string

	// The returned proactive insights.
	ProactiveInsights []types.ProactiveInsightSummary

	// The returned reactive insights.
	ReactiveInsights []types.ReactiveInsightSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                                                                    type SearchInsightsPaginator 

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

                                                                                                                                                      SearchInsightsPaginator is a paginator for SearchInsights

                                                                                                                                                      func NewSearchInsightsPaginator 

                                                                                                                                                      func NewSearchInsightsPaginator(client SearchInsightsAPIClient, params *SearchInsightsInput, optFns ...func(*SearchInsightsPaginatorOptions)) *SearchInsightsPaginator

                                                                                                                                                        NewSearchInsightsPaginator returns a new SearchInsightsPaginator

                                                                                                                                                        func (*SearchInsightsPaginator) HasMorePages 

                                                                                                                                                        func (p *SearchInsightsPaginator) HasMorePages() bool

                                                                                                                                                          HasMorePages returns a boolean indicating whether more pages are available

                                                                                                                                                          func (*SearchInsightsPaginator) NextPage 

                                                                                                                                                          func (p *SearchInsightsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchInsightsOutput, error)

                                                                                                                                                            NextPage retrieves the next SearchInsights page.

                                                                                                                                                            type SearchInsightsPaginatorOptions 

                                                                                                                                                            type SearchInsightsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	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
}

                                                                                                                                                              SearchInsightsPaginatorOptions is the paginator options for SearchInsights

                                                                                                                                                              type UpdateResourceCollectionInput 

                                                                                                                                                              type UpdateResourceCollectionInput struct {

	// Specifies if the resource collection in the request is added or deleted to the
	// resource collection.
	//
	// This member is required.
	Action types.UpdateResourceCollectionAction

	// Contains information used to update a collection of AWS resources.
	//
	// This member is required.
	ResourceCollection *types.UpdateResourceCollectionFilter
}

                                                                                                                                                              type UpdateResourceCollectionOutput 

                                                                                                                                                              type UpdateResourceCollectionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                                                                              type UpdateServiceIntegrationInput 

                                                                                                                                                              type UpdateServiceIntegrationInput struct {

	// An IntegratedServiceConfig object used to specify the integrated service you
	// want to update, and whether you want to update it to enabled or disabled.
	//
	// This member is required.
	ServiceIntegration *types.UpdateServiceIntegrationConfig
}

                                                                                                                                                              type UpdateServiceIntegrationOutput 

                                                                                                                                                              type UpdateServiceIntegrationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                                                                                                                                              Source Files

                                                                                                                                                              View all

                                                                                                                                                              Directories

                                                                                                                                                              Path Synopsis
                                                                                                                                                              internal
                                                                                                                                                              endpoints